

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# 使用 kubectl 從 Amazon S3、Amazon FSx 或 Hugging Face Hub 部署模型
<a name="sagemaker-hyperpod-model-deployment-deploy-ftm"></a>

下列步驟說明如何使用 kubectl，將存放在 Amazon S3、Amazon FSx 或 Hugging Face Hub 上的模型部署至 Amazon SageMaker HyperPod 叢集。

下列指示包含設計在終端機中執行的程式碼儲存格和命令。在執行這些命令之前，請確定您已使用 AWS 登入資料設定環境。

## 先決條件
<a name="sagemaker-hyperpod-model-deployment-deploy-ftm-prereqs"></a>

開始之前，請確認您已：
+ 在 Amazon SageMaker HyperPod 叢集上設定推論功能。如需詳細資訊，請參閱[設定 HyperPod 叢集以進行模型部署](sagemaker-hyperpod-model-deployment-setup.md)。
+ 已在終端機中安裝 [kubectl](https://kubernetes.io/docs/reference/kubectl/) 公用程式。

## 設定與組態
<a name="sagemaker-hyperpod-model-deployment-deploy-ftm-setup"></a>

將所有預留位置值取代為您的實際資源識別碼。

1. 在您的環境中選取您的區域。

   ```
   export REGION=<region>
   ```

1. 初始化您的叢集名稱。這可識別將在其中部署您模型的 HyperPod 叢集。
**注意**  
請洽詢您的叢集管理員，確保已為此角色或使用者授與許可。您可以執行 `!aws sts get-caller-identity --query "Arn"` 來檢查您在終端機中使用的角色或使用者。

   ```
   # Specify your hyperpod cluster name here
   HYPERPOD_CLUSTER_NAME="<Hyperpod_cluster_name>"
   
   # NOTE: For sample deployment, we use g5.24xlarge for Llama 3.1 8B model which has sufficient memory and GPU
   instance_type="ml.g5.24xlarge"
   ```

1. 初始化您的叢集命名空間。您的叢集管理員應該已在命名空間中建立 Hyperpod-inference 服務帳戶。

   ```
   cluster_namespace="<namespace>"
   ```

1. 請使用下列其中一個選項建立 CRD：

------
#### [ Using Amazon FSx as the model source ]

   1. 設定 SageMaker 端點名稱。

      ```
      export SAGEMAKER_ENDPOINT_NAME="llama-fsx"
      ```

   1. 設定要使用的 Amazon FSx 檔案系統 ID。

      ```
      export FSX_FILE_SYSTEM_ID="fs-1234abcd"
      ```

   1. 以下是使用 Amazon FSx 和 Llama 模型建立端點的範例 yaml 檔案。
**注意**  
對於已啟用 GPU 分割的叢集，請將 取代`nvidia.com/gpu`為適當的 MIG 資源名稱，例如 `nvidia.com/mig-1g.10gb`。如需詳細資訊，請參閱[使用 MIG 提交任務](sagemaker-hyperpod-eks-gpu-partitioning-task-submission.md)。

      ```
      cat <<EOF> deploy_fsx_cluster_inference.yaml
      ---
      apiVersion: inference.sagemaker.aws.amazon.com/v1
      kind: InferenceEndpointConfig
      metadata:
        name: $SAGEMAKER_ENDPOINT_NAME
        namespace: $CLUSTER_NAMESPACE
      spec:
        modelName: Llama-3.1-8B-Instruct
        instanceType: ml.g5.24xlarge
        invocationEndpoint: v1/chat/completions
        replicas: 2
        modelSourceConfig:
          fsxStorage:
            fileSystemId: $FSX_FILE_SYSTEM_ID
          modelLocation: Llama-3.1-8B-Instruct
          modelSourceType: fsx
        worker:
          image: vllm/vllm-openai:v0.19.1
          modelInvocationPort:
            containerPort: 8000
            name: http
          modelVolumeMount:
            mountPath: /opt/ml/model
            name: model-weights
          resources:
            limits:
              nvidia.com/gpu: 4
            requests:
              cpu: 30000m
              memory: 100Gi
              nvidia.com/gpu: 4
          args:
            - "--model"
            - "/opt/ml/model"
            - "--port"
            - "8000"
            - "--tensor-parallel-size"
            - "4"
            - "--served-model-name"
            - "Llama-3.1-8B-Instruct"
          environmentVariables:
            - name: VLLM_REQUEST_TIMEOUT
              value: "600"
      EOF
      ```

------
#### [ Using Amazon S3 as the model source ]

   1. 設定 SageMaker 端點名稱。

      ```
      export SAGEMAKER_ENDPOINT_NAME="llama-s3"
      ```

   1. 設定模型所在的 Amazon S3 儲存貯體位置。

      ```
      export S3_MODEL_LOCATION="<your-s3-bucket-name>"
      ```

   1. 以下是使用 vLLM 做為推論執行時間，以 Amazon S3 和 Llama 模型建立端點的範例 yaml 檔案。
**注意**  
對於已啟用 GPU 分割的叢集，請將 取代`nvidia.com/gpu`為適當的 MIG 資源名稱，例如 `nvidia.com/mig-1g.10gb`。如需詳細資訊，請參閱[使用 MIG 提交任務](sagemaker-hyperpod-eks-gpu-partitioning-task-submission.md)。

      ```
      cat <<EOF> deploy_s3_inference.yaml
      ---
      apiVersion: inference.sagemaker.aws.amazon.com/v1
      kind: InferenceEndpointConfig
      metadata:
        name: $SAGEMAKER_ENDPOINT_NAME
        namespace: $CLUSTER_NAMESPACE
      spec:
        modelName: Llama-3.1-8B-Instruct
        instanceType: ml.g5.24xlarge
        invocationEndpoint: v1/chat/completions
        replicas: 2
        modelSourceConfig:
          modelSourceType: s3
          s3Storage:
            bucketName: $S3_MODEL_LOCATION
            region: $REGION
          modelLocation: Llama-3.1-8B-Instruct
          prefetchEnabled: true
        worker:
          image: vllm/vllm-openai:v0.19.1
          modelInvocationPort:
            containerPort: 8000
            name: http
          modelVolumeMount:
            name: model-weights
            mountPath: /opt/ml/model
          resources:
            limits:
              nvidia.com/gpu: 4
            requests:
              cpu: 30000m
              memory: 100Gi
              nvidia.com/gpu: 4
          args:
            - "--model"
            - "/opt/ml/model"
            - "--port"
            - "8000"
            - "--tensor-parallel-size"
            - "4"
            - "--served-model-name"
            - "Llama-3.1-8B-Instruct"
          environmentVariables:
            - name: VLLM_REQUEST_TIMEOUT
              value: "600"
      EOF
      ```

------
#### [ Using Hugging Face Hub as the model source ]

   1. 建立包含 Hugging Face API 權杖的 Kubernetes 秘密。門控模型需要此字符，並建議所有下載使用。您可以在 https：//[huggingface.co/settings/tokens](https://huggingface.co/settings/tokens) 產生權杖。
**重要**  
從 Hugging Face Hub 部署模型需要從叢集節點到 Hugging Face 網域的傳出網際網路存取，包括 `*.huggingface.co`和 `*.hf.co`。確保您的 VPC 網路組態 (NAT 閘道、安全群組和網路 ACLs) 允許 HTTPS 輸出到這些網域。如果沒有網際網路存取，模型下載將會失敗。
**注意**  
對於生產環境，建議使用 Amazon S3 或 Amazon FSx 作為模型來源，而不是 Hugging Face Hub。使用 Amazon S3 和 Amazon FSx，模型成品會存放在 AWS 您的帳戶中，消除對外部網際網路連線的依賴性，並提供更可預測的部署時間。Hugging Face Hub 最適合直接存取 Hugging Face 模型儲存庫相當方便的開發、實驗和快速原型設計。

      ```
      kubectl create secret generic hf-token-secret \
        --from-literal=token=hf_YOUR_TOKEN_HERE \
        -n $CLUSTER_NAMESPACE
      ```

   1. 設定 SageMaker 端點名稱。

      ```
      export SAGEMAKER_ENDPOINT_NAME="mistral7b-hf"
      ```

   1. 以下是使用 vLLM 作為推論執行時間，從 Hugging Face Hub 部署 Mistral 7B 模型的範例 YAML 檔案。使用 時`prefetchEnabled: true`，運算子會使用初始化容器在推論容器啟動之前下載模型。
**注意**  
對於已啟用 GPU 分割的叢集，請將 取代`nvidia.com/gpu`為適當的 MIG 資源名稱，例如 `nvidia.com/mig-1g.10gb`。如需詳細資訊，請參閱[使用 MIG 提交任務](sagemaker-hyperpod-eks-gpu-partitioning-task-submission.md)。

      ```
      cat <<EOF> deploy_hf_inference.yaml
      ---
      apiVersion: inference.sagemaker.aws.amazon.com/v1
      kind: InferenceEndpointConfig
      metadata:
        name: $SAGEMAKER_ENDPOINT_NAME
        namespace: $CLUSTER_NAMESPACE
      spec:
        modelName: mistral-7b
        modelSourceConfig:
          modelSourceType: huggingface
          prefetchEnabled: true
          huggingFaceModel:
            modelId: "mistralai/Mistral-7B-Instruct-v0.3"
            tokenSecretRef:
              name: hf-token-secret
              key: token
        instanceType: "ml.g5.24xlarge"
        invocationEndpoint: v1/chat/completions
        worker:
          image: "vllm/vllm-openai:v0.19.1"
          modelInvocationPort:
            containerPort: 8000
            name: http
          modelVolumeMount:
            name: model-weights
            mountPath: /opt/ml/model
          resources:
            requests:
              nvidia.com/gpu: "4"
              memory: "96Gi"
              cpu: "16"
            limits:
              nvidia.com/gpu: "4"
              memory: "96Gi"
              cpu: "16"
          args:
            - "--model"
            - "/opt/ml/model"
            - "--port"
            - "8000"
            - "--tensor-parallel-size"
            - "4"
            - "--served-model-name"
            - "mistralai/Mistral-7B-Instruct-v0.3"
          environmentVariables:
            - name: VLLM_REQUEST_TIMEOUT
              value: "600"
      EOF
      ```

   1. 金鑰 Hugging Face 組態欄位為：
      + `modelSourceType` （必要） — 設定為 `huggingface`。
      + `huggingFaceModel.modelId` （必要） — Hugging Face Hub 模型識別符的`org/model`格式 （例如 `mistralai/Mistral-7B-Instruct-v0.3`)。
      + `huggingFaceModel.commitSHA` （選用） — 40 個字元的 Git 遞交 SHA 以鎖定特定模型版本。如果省略， 會預設為`main`分支。
      + `huggingFaceModel.tokenSecretRef` （選用） — 參考包含 Hugging Face API 字符的 Kubernetes 秘密。門控模型需要。字符僅在模型下載期間使用，不會公開到推論容器。
      + `prefetchEnabled` （選用） — 當 時`true`，初始化容器會在推論容器啟動之前下載模型。當 時`false`，推論執行時間 (vLLM、TGI、SGLang) 會在啟動時原生下載模型。預設為 `false`。

------

**注意**  
若要設定 KV 快取和智慧型路由以提高效能，請參閱 [設定 KV 快取和智慧型路由](sagemaker-hyperpod-model-deployment-caching-routing.md#sagemaker-hyperpod-model-deployment-deploy-ftm-cache-route)。

## 從 Amazon S3、Amazon FSx 或 Hugging Face Hub 部署您的模型
<a name="sagemaker-hyperpod-model-deployment-deploy-ftm-deploy"></a>

1. 從 HyperPod 叢集 ARN 取得 Amazon EKS 叢集名稱，以進行 kubectl 驗證。

   ```
   export EKS_CLUSTER_NAME=$(aws --region $REGION sagemaker describe-cluster --cluster-name $HYPERPOD_CLUSTER_NAME \
     --query 'Orchestrator.Eks.ClusterArn' --output text | \
     cut -d'/' -f2)
   aws eks update-kubeconfig --name $EKS_CLUSTER_NAME --region $REGION
   ```

1. 使用下列其中一個選項部署您的 InferenceEndpointConfig 模型：

------
#### [ Deploy with Amazon FSx as a source ]

   ```
   kubectl apply -f deploy_fsx_luster_inference.yaml
   ```

------
#### [ Deploy with Amazon S3 as a source ]

   ```
   kubectl apply -f deploy_s3_inference.yaml
   ```

------
#### [ Deploy with Hugging Face Hub as a source ]

   ```
   kubectl apply -f deploy_hf_inference.yaml
   ```

   如果部署失敗，請檢查 InferenceEndpointConfig 事件以取得診斷資訊。如需常見問題，例如字符錯誤、網路連線和找不到模型，請參閱 [Hugging Face Hub 模型部署失敗](sagemaker-hyperpod-model-deployment-ts-huggingface.md)。

------

## 驗證部署的狀態
<a name="sagemaker-hyperpod-model-deployment-deploy-ftm-verify"></a>

1. 檢查是否已成功部署模型。

   ```
   kubectl describe InferenceEndpointConfig $SAGEMAKER_ENDPOINT_NAME -n $CLUSTER_NAMESPACE
   ```

1. 檢查是否已成功建立端點。

   ```
   kubectl describe SageMakerEndpointRegistration $SAGEMAKER_ENDPOINT_NAME -n $CLUSTER_NAMESPACE
   ```

1. 測試部署的端點，以驗證其是否正常運作。此步驟確認您的模型已成功部署，並且可以處理推論請求。

   ```
   aws sagemaker-runtime invoke-endpoint \
     --endpoint-name $SAGEMAKER_ENDPOINT_NAME \
     --content-type "application/json" \
     --body '{"inputs": "What is AWS SageMaker?"}' \
     --region $REGION \
     --cli-binary-format raw-in-base64-out \
     /dev/stdout
   ```

## 管理您的部署
<a name="sagemaker-hyperpod-model-deployment-deploy-ftm-manage"></a>

完成了測試您的部署時，請使用下列命令來清除資源。

**注意**  
在繼續之前，請驗證您不再需要部署的模型或存放的資料。

**清除您的資源**

1. 刪除推論部署和相關聯的 Kubernetes 資源。這會停止執行中的模型容器，並移除 SageMaker 端點。

   ```
   kubectl delete inferenceendpointconfig $SAGEMAKER_ENDPOINT_NAME -n $CLUSTER_NAMESPACE
   ```

1. 驗證是否已成功完成清除。

   ```
   # # Check that Kubernetes resources are removed
   kubectl get pods,svc,deployment,InferenceEndpointConfig,sagemakerendpointregistration -n $CLUSTER_NAMESPACE
   ```

   ```
   # Verify SageMaker endpoint is deleted (should return error or empty)
   aws sagemaker describe-endpoint --endpoint-name $SAGEMAKER_ENDPOINT_NAME --region $REGION
   ```

**疑難排解**

如果您的部署未如預期般運作，請使用這些偵錯命令。

1. 檢查 Kubernetes 部署狀態。

   ```
   kubectl describe deployment $SAGEMAKER_ENDPOINT_NAME -n $CLUSTER_NAMESPACE
   ```

1. 檢查 InferenceEndpointConfig 狀態，以查看高階部署狀態和任何組態問題。

   ```
   kubectl describe InferenceEndpointConfig $SAGEMAKER_ENDPOINT_NAME -n $CLUSTER_NAMESPACE
   ```

1. 檢查所有 Kubernetes 物件的狀態。全面檢視命名空間中所有相關的 Kubernetes 資源。這可讓您快速了解正在執行的內容和可能缺少的內容。

   ```
   kubectl get pods,svc,deployment,InferenceEndpointConfig,sagemakerendpointregistration -n $CLUSTER_NAMESPACE
   ```