Neptune ML モデルトレーニング API - Amazon Neptune
StartMLModelTrainingJobListMLModelTrainingJobsGetMLModelTrainingJobCancelMLModelTrainingJob________________________CustomModelTrainingParameters

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

Neptune ML モデルトレーニング API

モデルトレーニングアクション:

モデルトレーニング構造:

StartMLModelTrainingJob (アクション)

        この API の AWS CLI 名は start-ml-model-training-job です。

新しい Neptune ML モデルトレーニングジョブを作成します。「modeltraining コマンドを使用したモデルトレーニング」を参照してください。

IAM 認証が有効になっている Neptune クラスターでこの操作を呼び出すときには、リクエストを行う IAM ユーザーまたはロールに、そのクラスターで neptune-db:StartMLModelTrainingJob IAM アクションを許可するポリシーがアタッチされている必要があります。

リクエスト

  • baseProcessingInstanceType (CLI では: --base-processing-instance-type) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    ML モデルのトレーニングの準備と管理に使用される ML インスタンスのタイプ。これは、トレーニングデータとモデルの処理に必要なメモリに基づいて選択された CPU インスタンスです。

  • customModelTrainingParameters (CLI では: --custom-model-training-parameters) — CustomModelTrainingParameters オブジェクト。

    カスタムモデルトレーニングの設定。これは JSON オブジェクトです。

  • dataProcessingJobId (CLI では: --data-processing-job-id) — 必須: string タイプの文字列 (UTF-8 でエンコードされた文字列)。

    トレーニングで使用するデータを作成した、完了したデータ処理ジョブのジョブ ID。

  • enableManagedSpotTraining (CLI では: --enable-managed-spot-training) — タイプ boolean のブール値 (ブール値 (真または偽) の値)。

    Amazon Elastic Compute Cloud スポットインスタンスを使用して、機械学習モデルのトレーニングコストを最適化します。デフォルトは False です。

  • id (CLI では: --id) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    新しいジョブの一意識別子。デフォルト値は、自動生成された UUID です。

  • maxHPONumberOfTrainingJobs (CLI では: --max-hpo-number-of-training-jobs) — タイプ integer の整数 (符号付き 32 ビット整数)。

    ハイパーパラメータ調整ジョブで開始するトレーニングジョブの最大総数。デフォルトは 2 です。Neptune ML は、機械学習モデルのハイパーパラメータを自動的に調整します。うまく機能するモデルを得るには、少なくとも 10 個のジョブを使用します (つまり、maxHPONumberOfTrainingJobs を 10 と設定)。一般的に、チューニングの実行が多いほど、結果は良くなります。

  • maxHPOParallelTrainingJobs (CLI では: --max-hpo-parallel-training-jobs) — タイプ integer の整数 (符号付き 32 ビット整数)。

    ハイパーパラメータ調整ジョブで開始する並列トレーニングジョブの最大総数。デフォルトは 2 です。実行できる並列ジョブ数は、トレーニングインスタンスで使用可能なリソースによって制限されます。

  • neptuneIamRoleArn (CLI では: --neptune-iam-role-arn) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    SageMaker および Amazon S3 リソースへの Neptune アクセスを提供する IAM ロールの ARN。これは DB クラスターパラメータグループに一覧表示されている必要があります。そうでない場合はエラーが発生します。

  • previousModelTrainingJobId (CLI では: --previous-model-training-job-id) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    更新されたデータに基づいて増分的に更新する、完了したモデルトレーニングジョブのジョブ ID。

  • s3OutputEncryptionKMSKey (CLI では: --s-3-output-encryption-kms-key) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    SageMaker が処理ジョブの出力を暗号化するために使用する Amazon キー管理サービス (KMS) キー。デフォルトは none です。

  • sagemakerIamRoleArn (CLI では: --sagemaker-iam-role-arn) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    SageMaker を実行する IAM ロールの ARN。これは DB クラスターパラメータグループに一覧表示されている必要があり、そうでない場合はエラーが発生します。

  • securityGroupIds (CLI では: --security-group-ids) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    VPC セキュリティグループ ID。デフォルトは [なし] です。

  • subnets (CLI では: --subnets) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    Neptune VPC 内のサブネットの ID。デフォルトは [なし] です。

  • trainingInstanceType (CLI では: --training-instance-type) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    モデルトレーニングに使用される ML インスタンスのタイプ。すべてのNeptune ML モデルは、CPU、GPU、MultiGPU トレーニングをサポートしています。デフォルトは ml.p3.2xlarge です。トレーニングに適したインスタンスタイプの選択は、タスクタイプ、グラフサイズ、および予算によって異なります。

  • trainingInstanceVolumeSizeInGB (CLI では: --training-instance-volume-size-in-gb) — タイプ integer の整数 (符号付き 32 ビット整数)。

    トレーニングインスタンスのディスクボリュームサイズ。入力データと出力モデルの両方がディスクに保存されるため、ボリュームサイズは両方のデータセットを保持するのに十分な大きさでなければなりません。デフォルトは 0 です。指定しなかった場合、または 0 の場合、Neptune ML はデータ処理ステップで生成された推奨に基づいてディスクボリュームサイズを選択します。

  • trainingTimeOutInSeconds (CLI では: --training-time-out-in-seconds) — タイプ integer の整数 (符号付き 32 ビット整数)。

    トレーニングジョブのタイムアウト (秒単位)。デフォルトは 86,400 (1 日) です。

  • trainModelS3Location (CLI では: --train-model-s3-location) — 必須: string タイプの文字列 (UTF-8 でエンコードされた文字列)。

    モデルアーティファクトが保存される Amazon S3 内の場所。

  • volumeEncryptionKMSKey (CLI では: --volume-encryption-kms-key) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    トレーニングジョブを実行する ML コンピューティングインスタンスにアタッチされたストレージボリュームのデータを暗号化するために SageMaker が使用する Amazon キー管理サービス (KMS) キー。デフォルトは [なし] です。

レスポンス

  • arn — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    新しいモデルトレーニングジョブの ARN。

  • creationTimeInMillis — long 型の長整数(符号付き 64 ビット整数)。

    モデルトレーニングジョブの作成時間 (ミリ秒単位)。

  • id — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    新しいモデルトレーニングジョブの一意 ID。

エラー

ListMLModelTrainingJobs (アクション)

        この API の AWS CLI 名は list-ml-model-training-jobs です。

Neptune ML モデルトレーニングジョブを一覧表示します。「modeltraining コマンドを使用したモデルトレーニング」を参照してください。

IAM 認証が有効になっている Neptune クラスターでこの操作を呼び出すときには、リクエストを行う IAM ユーザーまたはロールに、そのクラスターで neptune-db:neptune-db:ListMLModelTrainingJobs IAM アクションを許可するポリシーがアタッチされている必要があります。

リクエスト

  • maxItems (CLI では: --max-items) — ListMLModelTrainingJobsInputMaxItemsInteger、タイプ integer (符号付き 32 ビット整数)、1 以上か 1024 以上？ st? s。

    返される項目の最大数 (1 ～ 1024、デフォルトは 10)。

  • neptuneIamRoleArn (CLI では: --neptune-iam-role-arn) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    SageMaker および Amazon S3 リソースへの Neptune アクセスを提供する IAM ロールの ARN。これは DB クラスターパラメータグループに一覧表示されている必要があります。そうでない場合はエラーが発生します。

レスポンス

  • ids — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    モデルトレーニングジョブ ID のリストのページ。

エラー

GetMLModelTrainingJob (アクション)

        この API の AWS CLI 名は get-ml-model-training-job です。

Neptune ML モデルトレーニングジョブに関する情報を取得します。「modeltraining コマンドを使用したモデルトレーニング」を参照してください。

IAM 認証が有効になっている Neptune クラスターでこの操作を呼び出すときには、リクエストを行う IAM ユーザーまたはロールに、そのクラスターで neptune-db:GetMLModelTrainingJobStatus IAM アクションを許可するポリシーがアタッチされている必要があります。

リクエスト

  • id (CLI では: --id) — 必須: string タイプの文字列 (UTF-8 でエンコードされた文字列)。

    取得するモデルトレーニングジョブの一意識別子。

  • neptuneIamRoleArn (CLI では: --neptune-iam-role-arn) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    SageMaker および Amazon S3 リソースへの Neptune アクセスを提供する IAM ロールの ARN。これは DB クラスターパラメータグループに一覧表示されている必要があります。そうでない場合はエラーが発生します。

レスポンス

  • hpoJob – MlResourceDefinition オブジェクト。

    HPO ジョブ。

  • id — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    このモデルトレーニングジョブの一意識別子。

  • mlModels – MlConfigDefinition オブジェクトの配列。

    使用されている ML モデルの設定のリスト。

  • modelTransformJob – MlResourceDefinition オブジェクト。

    モデル変換ジョブ。

  • processingJob – MlResourceDefinition オブジェクト。

    データ処理ジョブ。

  • status — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    モデルトレーニングジョブのステータス。

エラー

CancelMLModelTrainingJob (アクション)

        この API の AWS CLI 名は cancel-ml-model-training-job です。

Neptune ML モデルトレーニングジョブをキャンセルします。「modeltraining コマンドを使用したモデルトレーニング」を参照してください。

IAM 認証が有効になっている Neptune クラスターでこの操作を呼び出すときには、リクエストを行う IAM ユーザーまたはロールに、そのクラスターで neptune-db:CancelMLModelTrainingJob IAM アクションを許可するポリシーがアタッチされている必要があります。

リクエスト

  • clean (CLI では: --clean) — タイプ boolean のブール値 (ブール値 (真または偽) の値)。

    TRUE に設定された場合、このフラグは、ジョブが停止したときにすべての Amazon S3 アーティファクトが削除される必要があることを指定します。デフォルトは FALSE です。

  • id (CLI では: --id) — 必須: string タイプの文字列 (UTF-8 でエンコードされた文字列)。

    キャンセルされるモデルトレーニングジョブの一意識別子。

  • neptuneIamRoleArn (CLI では: --neptune-iam-role-arn) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    SageMaker および Amazon S3 リソースへの Neptune アクセスを提供する IAM ロールの ARN。これは DB クラスターパラメータグループに一覧表示されている必要があります。そうでない場合はエラーが発生します。

レスポンス

  • status — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    キャンセルのステータス。

エラー

モデルトレーニング構造:

CustomModelTrainingParameters (構造)

カスタムモデルトレーニングパラメータを含みます。「Neptune ML のカスタムモデル」を参照してください。

フィールド

  • sourceS3DirectoryPath - これは 必須です。タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    モデルを実装する Python モジュールがある Amazon S3 の場所へのパス。これは、少なくともトレーニングスクリプト、変換スクリプト、および model-hpo-configuration.json ファイルを含む有効な既存の Amazon S3 の場所を指定しなければなりません。

  • trainingEntryPointScript — これはタイプ string の文字列です (UTF-8 でエンコードされた文字列)。

    モデルトレーニングを実行し、固定ハイパーパラメータを含め、コマンドライン引数としてハイパーパラメータを取るスクリプトのモジュール内のエントリポイントの名前。デフォルトは training.py です。

  • transformEntryPointScript — これはタイプ string の文字列です (UTF-8 でエンコードされた文字列)。

    モデルのデプロイに必要なモデルアーティファクトを計算するために、ハイパーパラメータ検索で最適なモデルが特定された後に実行されるスクリプトのモジュール内のエントリポイントの名前。コマンドライン引数なしで実行できるはずです。デフォルトは transform.py です。