

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

# Neptune ML 模型轉換 API
<a name="data-api-dp-ml-transform"></a>

**模型轉換動作：**
+ [StartMLModelTransformJob (動作)](#StartMLModelTransformJob)
+ [ListMLModelTransformJobs (動作)](#ListMLModelTransformJobs)
+ [GetMLModelTransformJob (動作)](#GetMLModelTransformJob)
+ [CancelMLModelTransformJob (動作)](#CancelMLModelTransformJob)

**模型轉換結構：**
+ [CustomModelTransformParameters (結構)](#CustomModelTransformParameters)

## StartMLModelTransformJob (動作)
<a name="StartMLModelTransformJob"></a>

         此 API 的 AWS CLI 名稱為：`start-ml-model-transform-job`。

建立新模型轉換工作。請參閱[使用訓練後的模型來產生新的模型成品](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html)。

在已啟用 IAM 身分驗證的 Neptune 叢集中調用此操作時，發出請求的 IAM 使用者或角色必須附加一個政策，在該叢集中允許 [neptune-db:StartMLModelTransformJob](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#startmlmodeltransformjob) IAM 動作。

**請求**
+ **baseProcessingInstanceType** (在 CLI 中：`--base-processing-instance-type`) – 字串，類型為：`string` (UTF-8 編碼的字串)。

  用於準備和管理 ML 模型訓練的 ML 執行個體類型。這是根據記憶體需求選擇的 ML 運算執行個體，用於處理訓練資料和模型。
+ **baseProcessingInstanceVolumeSizeInGB** (在 CLI 中：`--base-processing-instance-volume-size-in-gb`) – 整數，類型為：`integer` (帶正負號的 32 位元整數)。

  訓練執行個體的磁碟區大小 (以 GB 為單位)。預設值為 0。輸入資料和輸出模型都會儲存在磁碟上，因此磁碟區大小必須大到足以保留這兩個資料集。如果未指定或指定 0，Neptune ML 會根據資料處理步驟中產生的建議選取磁碟區大小。
+ **customModelTransformParameters** (在 CLI 中：`--custom-model-transform-parameters`) – [CustomModelTransformParameters](#CustomModelTransformParameters) 物件。

  使用自訂模型進行模型轉換的組態資訊。`customModelTransformParameters` 物件包含下列欄位，其具有的值必須與訓練工作中儲存的模型參數相容：
+ **dataProcessingJobId** (在 CLI 中：`--data-processing-job-id`) – 字串，類型為：`string` (UTF-8 編碼的字串)。

  已完成資料處理工作的工作 ID。您必須包含 `dataProcessingJobId` 和 `mlModelTrainingJobId` 或 `trainingJobName`。
+ **id** (在 CLI 中：`--id`) – 字串，類型為：`string` (UTF-8 編碼的字串)。

  新工作的唯一識別符。預設值為自動產生的 UUID。
+ **mlModelTrainingJobId** (在 CLI 中：`--ml-model-training-job-id`) – 字串，類型為：`string` (UTF-8 編碼的字串)。

  已完成模型訓練工作的工作 ID。您必須包含 `dataProcessingJobId` 和 `mlModelTrainingJobId` 或 `trainingJobName`。
+ **modelTransformOutputS3Location** (在 CLI 中：`--model-transform-output-s3-location`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。

  Amazon S3 中要儲存模型成品的位置。
+ **neptuneIamRoleArn** (在 CLI 中：`--neptune-iam-role-arn`) – 字串，類型為：`string` (UTF-8 編碼的字串)。

  IAM 角色的 ARN，此角色可讓 Neptune 存取 SageMaker 和 Amazon S3 資源。這必須列示在您的資料庫叢集參數群組中，否則會發生錯誤。
+ **s3OutputEncryptionKMSKey** (在 CLI 中：`--s-3-output-encryption-kms-key`) – 字串，類型為：`string` (UTF-8 編碼的字串)。

  SageMaker 用來加密處理工作輸出的 Amazon Key Management Service (KMS) 金鑰。預設為 none。
+ **sagemakerIamRoleArn** (在 CLI 中：`--sagemaker-iam-role-arn`) – 字串，類型為：`string` (UTF-8 編碼的字串)。

  用於 SageMaker 執行之 IAM 角色的 ARN。這必須列示在您的資料庫叢集參數群組中，否則會發生錯誤。
+ **securityGroupIds** (在 CLI 中：`--security-group-ids`) – 字串，類型為：`string` (UTF-8 編碼的字串)。

  VPC 安全群組 ID。預設值為 None (無)。
+ **subnets** (在 CLI 中：`--subnets`) – 字串，類型為：`string` (UTF-8 編碼的字串)。

  Neptune VPC 中子網路的 ID。預設值為 None (無)。
+ **trainingJobName** (在 CLI 中：`--training-job-name`) – 字串，類型為：`string` (UTF-8 編碼的字串)。

  已完成 SageMaker 訓練工作的名稱。您必須包含 `dataProcessingJobId` 和 `mlModelTrainingJobId` 或 `trainingJobName`。
+ **volumeEncryptionKMSKey** (在 CLI 中：`--volume-encryption-kms-key`) – 字串，類型為：`string` (UTF-8 編碼的字串)。

  SageMaker 用來加密儲存磁碟區上資料的 Amazon Key Management Service (KMS) 金鑰，而該儲存磁碟區附加到執行訓練工作的 ML 運算執行個體。預設值為 None (無)。

**回應**
+ **arn** – 字串，類型為：`string` (UTF-8 編碼的字串)。

  模型轉換工作的 ARN。
+ **creationTimeInMillis** - Long 整數，類型為：`long` (帶有正負號的 64 位元整數)。

  模型轉換工作的建立時間，以毫秒為單位。
+ **id** – 字串，類型為：`string` (UTF-8 編碼的字串)。

  新模型轉換工作的唯一 ID。

**錯誤**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)

## ListMLModelTransformJobs (動作)
<a name="ListMLModelTransformJobs"></a>

         此 API 的 AWS CLI 名稱為：`list-ml-model-transform-jobs`。

傳回模型轉換工作 ID 的清單。請參閱[使用訓練後的模型來產生新的模型成品](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html)。

在已啟用 IAM 身分驗證的 Neptune 叢集中調用此操作時，發出請求的 IAM 使用者或角色必須附加一個政策，在該叢集中允許 [neptune-db:ListMLModelTransformJobs](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listmlmodeltransformjobs) IAM 動作。

**請求**
+ **maxItems** (在 CLI 中：`--max-items`) – ListMLModelTransformJobsInputMaxItemsInteger，類型為：`integer` (帶有正負號的 32 位元整數)，不小於 1 或大於 1024 ?st?s。

  要傳回的項目數目上限 (從 1 到 1024；預設值為 10)。
+ **neptuneIamRoleArn** (在 CLI 中：`--neptune-iam-role-arn`) – 字串，類型為：`string` (UTF-8 編碼的字串)。

  IAM 角色的 ARN，此角色可讓 Neptune 存取 SageMaker 和 Amazon S3 資源。這必須列示在您的資料庫叢集參數群組中，否則會發生錯誤。

**回應**
+ **ids** – 字串，類型為：`string` (UTF-8 編碼的字串)。

  來自模型轉換 ID 清單中的頁面。

**錯誤**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)

## GetMLModelTransformJob (動作)
<a name="GetMLModelTransformJob"></a>

         此 API 的 AWS CLI 名稱為：`get-ml-model-transform-job`。

取得所指定模型轉換工作的相關資訊。請參閱[使用訓練後的模型來產生新的模型成品](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html)。

在已啟用 IAM 身分驗證的 Neptune 叢集中調用此操作時，發出請求的 IAM 使用者或角色必須附加一個政策，在該叢集中允許 [neptune-db:GetMLModelTransformJobStatus](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getmlmodeltransformjobstatus) IAM 動作。

**請求**
+ **id** (在 CLI 中：`--id`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。

  要擷取之模型轉換工作的唯一識別符。
+ **neptuneIamRoleArn** (在 CLI 中：`--neptune-iam-role-arn`) – 字串，類型為：`string` (UTF-8 編碼的字串)。

  IAM 角色的 ARN，此角色可讓 Neptune 存取 SageMaker 和 Amazon S3 資源。這必須列示在您的資料庫叢集參數群組中，否則會發生錯誤。

**回應**
+ **baseProcessingJob** – [MlResourceDefinition](data-api-dp-ml-data-processing.md#MlResourceDefinition) 物件。

  基礎資料處理工作。
+ **id** – 字串，類型為：`string` (UTF-8 編碼的字串)。

  要擷取之模型轉換工作的唯一識別符。
+ **models** – 一個 [MlConfigDefinition](data-api-dp-ml-data-processing.md#MlConfigDefinition) 物件陣列。

  所使用之模型的組態資訊清單。
+ **remoteModelTransformJob** – [MlResourceDefinition](data-api-dp-ml-data-processing.md#MlResourceDefinition) 物件。

  遠端模型轉換工作。
+ **status** – 字串，類型為：`string` (UTF-8 編碼的字串)。

  模型轉換工作的狀態。

**錯誤**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)

## CancelMLModelTransformJob (動作)
<a name="CancelMLModelTransformJob"></a>

         此 API 的 AWS CLI 名稱為：`cancel-ml-model-transform-job`。

取消指定的模型轉換工作。請參閱[使用訓練後的模型來產生新的模型成品](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html)。

在已啟用 IAM 身分驗證的 Neptune 叢集中調用此操作時，發出請求的 IAM 使用者或角色必須附加一個政策，在該叢集中允許 [neptune-db:CancelMLModelTransformJob](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelmlmodeltransformjob) IAM 動作。

**請求**
+ **clean** (在 CLI 中:`--clean`) – 布林值，類型為：`boolean` (布林值 (true 或 false))。

  如果此旗標設定為 `TRUE`，則應在工作停止時刪除所有 Neptune ML S3 成品。預設值為 `FALSE`。
+ **id** (在 CLI 中：`--id`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。

  要取消之模型轉換工作的唯一 ID。
+ **neptuneIamRoleArn** (在 CLI 中：`--neptune-iam-role-arn`) – 字串，類型為：`string` (UTF-8 編碼的字串)。

  IAM 角色的 ARN，此角色可讓 Neptune 存取 SageMaker 和 Amazon S3 資源。這必須列示在您的資料庫叢集參數群組中，否則會發生錯誤。

**回應**
+ **status** – 字串，類型為：`string` (UTF-8 編碼的字串)。

  取消的狀態。

**錯誤**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)

## *模型轉換結構：*
<a name="data-api-dp-ml-transform-model-transform-structures-spacer"></a>

## CustomModelTransformParameters (結構)
<a name="CustomModelTransformParameters"></a>

包含自訂模型轉換參數。請參閱[使用訓練後的模型來產生新的模型成品](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html)。

**欄位**
+ **sourceS3DirectoryPath** - 這是*必要：*字串，類型為：`string` (UTF-8 編碼的字串)。

  此路徑通往實作您模型之 Python 模組所在的 Amazon S3 位置。這必須指向有效的現有 Amazon S3 位置，其中至少包含訓練指令碼、轉換指令碼和 `model-hpo-configuration.json` 檔案。
+ **transformEntryPointScript** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。

  指令碼模組中的進入點名稱，該指令碼應在識別了超參數搜尋中的最佳模型之後執行，以計算模型部署所需的模型成品。它應該能夠在沒有命令列參數的情況下執行。預設值為 `transform.py`。