

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# 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 计算实例。
+ **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 编码的字符串）。

  向 Neptune 提供对 SageMaker 和 Amazon S3 资源的访问权限的 IAM 角色的 ARN。必须将其列在您的数据库集群参数组中，否则将发生错误。
+ **s3OutputEncryptionKMSKey**（在 CLI 中：`--s-3-output-encryption-kms-key`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  SageMaker 用于加密处理任务的输出的 Amazon Key Management Service (KMS) 密钥。默认值为“无”。
+ **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 编码的字符串）。

  Amazon Key Management Service (KMS) 密钥，SageMaker 使用它来加密连接到运行训练任务的 ML 计算实例的存储卷上的数据。默认值为 None (无)。

**响应**
+ **arn** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  模型转换任务的 ARN。
+ **creationTimeInMillis** – 长整型，类型为：`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。

  要返回的最大项目数（从 1 到 1024；默认值为 10）。
+ **neptuneIamRoleArn**（在 CLI 中：`--neptune-iam-role-arn`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  向 Neptune 提供对 SageMaker 和 Amazon S3 资源的访问权限的 IAM 角色的 ARN。必须将其列在您的数据库集群参数组中，否则将发生错误。

**响应**
+ **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 编码的字符串）。

  向 Neptune 提供对 SageMaker 和 Amazon S3 资源的访问权限的 IAM 角色的 ARN。必须将其列在您的数据库集群参数组中，否则将发生错误。

**响应**
+ **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 编码的字符串）。

  向 Neptune 提供对 SageMaker 和 Amazon S3 资源的访问权限的 IAM 角色的 ARN。必须将其列在您的数据库集群参数组中，否则将发生错误。

**响应**
+ **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)。

**Fields**
+ **sourceS3DirectoryPath** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  实现您的模型的 Python 模块所在的 Amazon S3 位置的路径。这必须指向有效的现有 Amazon S3 位置，其中至少包含训练脚本、转换脚本和 `model-hpo-configuration.json` 文件。
+ **transformEntryPointScript** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  脚本模块中入口点的名称，该脚本应在确定超参数搜索中的最佳模型之后运行，以计算模型部署所需的模型构件。它应该能够在没有命令行参数的情况下运行。默认值为 `transform.py`。