翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
利用可能なオプション
次の表は、Studio でノートブックジョブを実行するか、ローカルの Jupyter 環境を実行するか、 SageMaker Python を使用するかにかかわらず、ノートブックジョブをカスタマイズするために使用できるすべてのオプションを示していますSDK。この表には、カスタムオプションのタイプ、説明、オプションの使用方法に関する追加のガイドライン、Studio のオプションのフィールド名 (使用可能な場合）、Python のノートブックジョブステップのパラメータ名 SDK (使用可能な場合) SageMaker が含まれています。
オプションによっては、ノートブックジョブを設定する都度指定する必要がないように、カスタムのデフォルト値を事前に設定することもできます。Studio の場合、これらのオプションはロール、入力フォルダ、出力フォルダ、およびKMSキー ID で、次の表で指定します。このようなオプションのカスタムデフォルトを事前に設定すると、ノートブックジョブを作成する際に、これらのフィールドが [ジョブの作成] フォームに事前入力されます。Studio およびローカル Jupyter 環境でカスタムデフォルトを作成する方法の詳細については、「ローカルノートブックのデフォルトオプションをセットアップ」を参照してください。
SageMaker AI では、インテリジェントデフォルトを設定するオプションSDKも用意されているため、 の作成時にこれらのパラメータを指定する必要はありませんNotebookJobStep。これらのパラメータは、role、s3_root_uri、s3_kms_key、volume_kms_key、subnets、security_group_ids であり、次の表で説明されています。インテリジェントなデフォルトの設定方法については、「デフォルトのオプションを設定する」を参照してください。
| カスタムオプション | 説明 | Studio 固有のガイドライン | Jupyter のローカル環境ガイドライン | SageMaker Python SDK ガイドライン |
|---|---|---|---|---|
| ジョブ名 | Notebook Jobs ダッシュボードに表示されるジョブ名 | [ジョブ名] フィールド | Studio と同様です。 | notebook_job_name パラメータ。デフォルトは None です。 |
| イメージ | 選択したコンピューティングタイプでノートブックを非インタラクティブに実行するために使用されるコンテナイメージ。 | [イメージ] フィールド このフィールドのデフォルトはノートブックの現在のイメージになります。必要に応じて、このフィールドをデフォルト値からカスタム値に変更します。Studio がこの値を推測できない場合、フォームに検証エラーが表示され、その値を指定するよう求められます。このイメージは、カスタム、bring-your-own イメージ、または利用可能な Amazon SageMaker AI イメージです。ノートブックスケジューラでサポートされている利用可能な SageMaker AI イメージのリストについては、「」を参照してくださいStudio Classic で使用できる Amazon SageMaker AI イメージ。 | [イメージ] フィールド このフィールドには、選択したコンピューティングタイプで提供されたノートブックを実行できる Docker イメージECRURIの が必要です。デフォルトでは、スケジューラ拡張機能は構築済みの SageMaker AI Docker イメージ、つまりベース Python 2.0 を使用します。これは、boto3 DockerHub と Python 3 カーネルを含む の公式 AWS CLI Python 3.8 イメージです。ノートブックのカスタムイメージ仕様ECRURIを満たす任意の を指定することもできます。詳細については、「カスタム SageMaker AI イメージの仕様」を参照してください。このイメージには、ノートブックの実行に必要なカーネルとライブラリがすべて含まれている必要があります。 | 必須。パラメータ image_uri. 上の Docker イメージURIの場所ECR。これらのイメージに基づいて特定の SageMaker ディストリビューションイメージまたはカスタムイメージを使用することも、追加の要件を満たすノートブックジョブの依存関係がプリインストールされた独自のイメージを使用することもできます。詳細については、「 SageMaker AI Python SDKノートブックジョブのイメージ制約」を参照してください。 |
| インスタンスタイプ | ノートブックジョブの実行に使用するEC2インスタンスタイプ。ノートブックジョブでは SageMaker 、トレーニングジョブをコンピューティングレイヤーとして使用するため、指定されたインスタンスタイプは SageMaker トレーニングがサポートされているインスタンスタイプである必要があります。 | [コンピューティングタイプ] フィールド。デフォルトは ml.m5.large です。 |
Studio と同様です。 | instance_type パラメータ。デフォルトは ml.m5.large です。 |
| カーネル | ノートブックジョブの実行に使用される Jupyter カーネル。 | [カーネル] フィールド。このフィールドのデフォルトはノートブックの現在のカーネルになります。必要に応じて、このフィールドをデフォルト値からカスタム値に変更します。Studio がこの値を推測できない場合、フォームに検証エラーが表示され、その値を指定するよう求められます。 | [カーネル] フィールド。このカーネルはイメージ内に存在し、Jupyter カーネルの仕様に従っている必要があります。このフィールドのデフォルトは、基本 Python3 2.0 SageMaker AI イメージにある Python3 カーネルです。必要に応じて、このフィールドをカスタム値に変更します。 | 必須。kernel_name パラメータ。このカーネルはイメージ内に存在し、Jupyter カーネルの仕様に従っている必要があります。イメージのカーネル識別子を確認するには、 () を参照してくださいLINK。 |
| SageMaker AI セッション | SageMaker AI サービスの呼び出しが委任される基盤となる SageMaker AI セッション。 | 該当なし | 該当なし | sagemaker_session パラメータ。指定しない場合は、デフォルト設定チェーンを使用してセッションが作成されます。 |
| ロール ARN | ノートブックジョブで使用されるロールの Amazon リソースネーム (ARN）。 | フィールドロール ARN。このフィールドのデフォルトは Studio 実行ロールです。必要に応じて、このフィールドをカスタム値に変更します。注記Studio がこの値を推測できない場合、ロールARNフィールドは空白です。この場合、使用する を挿入ARNします。 |
フィールドロール ARN。このフィールドはデフォルトで SagemakerJupyterScheduler のプレフィックスが付いた任意のロールになります。プレフィックスが付いたロールが複数ある場合、拡張子は 1 つを選択します。必要に応じて、このフィールドをカスタム値に変更します。このフィールドには、新しいジョブ定義を作成するたびに事前入力される独自のユーザーデフォルトを設定できます。詳細については、「ローカルノートブックのデフォルトオプションをセットアップ」を参照してください。 |
パラメータ role。が SageMaker Notebooks または SageMaker Studio Notebooks で実行されている場合SDK、デフォルトで SageMaker AI デフォルトIAMロールになります。それ以外の場合は、ValueError をスローします。インテリジェントなデフォルトを許可します。 |
| 入力ノートブック | 実行をスケジュールしているノートブックの名前 | 必須。[入力ファイル] フィールド。 | Studio と同様です。 | Required.Parameter input_notebook |
| 入力フォルダ | 入力が保存されているフォルダ。入力ノートブックや、オプションの起動スクリプトや初期化スクリプトを含むジョブ入力は、このフォルダに格納されます。 | [入力フォルダ] フィールド。フォルダを指定しない場合、スケジューラーは入力用にデフォルトの Amazon S3 バケットを作成します。 | Studio と同様です。このフィールドには、新しいジョブ定義を作成するたびに事前入力される独自のユーザーデフォルトを設定できます。詳細については、「ローカルノートブックのデフォルトオプションをセットアップ」を参照してください。 | 該当なし。入力フォルダは、パラメータ s3_root_uri で指定された場所内に配置されます。 |
| 出力フォルダ | 出力が保存されているフォルダ。出力ノートブックとログを含むジョブの出力は、このフォルダに格納されます。 | [出力フォルダ] フィールド。フォルダを指定しない場合、スケジューラーは出力用にデフォルトの Amazon S3 バケットを作成します。 | Studio と同様です。このフィールドには、新しいジョブ定義を作成するたびに事前入力される独自のユーザーデフォルトを設定できます。詳細については、「ローカルノートブックのデフォルトオプションをセットアップ」を参照してください。 | 該当なし。出力フォルダは、パラメータ s3_root_uri で指定された場所内に配置されます。 |
| パラメータ | ノートブックジョブに渡す変数と値のディクショナリ | [パラメータ] フィールド。パラメータを受け入れるには、ノートブックをパラメータ化する必要があります。 | Studio と同様です。 | parameters パラメータ。パラメータを受け入れるには、ノートブックをパラメータ化する必要があります。 |
| 追加の (ファイルまたはフォルダ) 依存関係 | ノートブックジョブが S3 ステージフォルダにアップロードするファイルまたはフォルダの依存関係のリスト | サポート外。 | サポート外。 | additional_dependencies パラメータ。ノートブックジョブは、これらの依存関係を実行時に利用できるように、S3 ステージフォルダにアップロードします。 |
| S3 ルート URI | 入力が保存されているフォルダ。入力ノートブックや、オプションの起動スクリプトや初期化スクリプトを含むジョブ入力は、このフォルダに格納されます。 | 該当なし。[入力フォルダ] と [出力フォルダ] を使用します。 | Studio と同様です。 | s3_root_uri パラメータ。デフォルト S3 バケットにデフォルト設定されています。インテリジェントなデフォルトを許可します。 |
| 環境変数 | 上書きしたい既存の環境変数、またはノートブックに導入して使用したい新しい環境変数。 | [環境変数] フィールド | Studio と同様です。 | environment_variables パラメータ。デフォルトは None です。 |
| [タグ] | ジョブに追加するタグのリスト | 該当なし | 該当なし | tags パラメータ。デフォルトは None です。タグは、パイプラインが作成したジョブを Studio UI がキャプチャして表示する方法を制御します。詳細については、「Studio UI ダッシュボードでノートブックジョブを表示する」を参照してください。 |
| 起動スクリプト | ノートブックの起動メニューに事前に読み込まれているスクリプトで、ノートブックを実行する前に実行を選択できます。 | [開始スクリプト] フィールド。起動時にイメージで実行されるライフサイクル設定 (LCC) スクリプトを選択します。注記起動スクリプトは Studio 環境外のシェルで実行されます。したがって、このスクリプトは Studio のローカルストレージ、環境変数、またはアプリのメタデータ ( |
サポート外。 | サポート外。 |
| 初期化スクリプト | ノートブックの起動時に実行できるローカルスクリプトへのパス。 | [初期スクリプト] フィールド。ローカルスクリプトまたはライフサイクル設定 (LCC) スクリプトがあるEFSファイルパスを入力します。起動スクリプトと初期化スクリプトを使用すると、起動スクリプトが最初に実行されます。注記初期化スクリプトは、ノートブックジョブと同じシェルから取得されます。これは、前に説明した起動スクリプトには当てはまりません。また、起動スクリプトと初期化スクリプトを使用すると、起動スクリプトが最初に実行されます。 |
[初期スクリプト] フィールド。ローカルスクリプトまたはライフサイクル設定 (LCC) スクリプトがあるローカルファイルパスを入力します。 | パラメータ initialization_script。デフォルトは None です。 |
| 最大再試行回数 | Studio が失敗したジョブ実行の再実行を試行する回数。 | [最大再試行回数] フィールド。デフォルトは 1 です。 | Studio と同様です。 | max_retry_attempts パラメータ。デフォルトは 1 です。 |
| 最大実行時間 (秒単位) | ノートブックジョブを停止するまでに実行できる時間の最大長 (秒単位)。[最大実行時間] と [最大再試行回数] の両方を設定した場合、実行時間は各再試行に適用されます。この時間内にジョブが完了しない場合、そのステータスは Failed に設定されます。 |
[最大実行時間 (秒単位)] フィールド。デフォルトは 172800
seconds (2 days) です。 |
Studio と同様です。 | max_runtime_in_seconds パラメータ。デフォルトは 172800 seconds
(2 days) です。 |
| 再試行ポリシー | 再試行ポリシーのリスト。失敗した場合に実行するアクションを管理します。 | サポート外。 | サポート外。 | retry_policies パラメータ。デフォルトは None です。 |
Step または StepCollection の依存関係の追加 |
ジョブが依存する Step 名のリスト、StepCollection 名のリスト、またはインスタンスのリスト。 |
サポート外。 | サポート外。 | depends_on パラメータ。デフォルトは None です。これを使用して、パイプライングラフ内のステップ間の明示的な依存関係を定義します。 |
| ボリュームサイズ | トレーニング中に入出力データを保存するためのストレージボリュームの GB 単位のサイズ | サポート外。 | サポート外。 | volume_size パラメータ。デフォルトは 30GB です。 |
| コンテナ間のトラフィックの暗号化 | トレーニングジョブのトレーニングコンテナ間のトラフィックが暗号化されるかどうかを指定するフラグ | 該当なし。デフォルトでは有効になっています。 | 該当なし。デフォルトでは有効になっています。 | encrypt_inter_container_traffic パラメータ。デフォルトは True です。 |
| ジョブの暗号化の設定 | ノートブックのジョブ出力、ジョブインスタンスボリューム、またはその両方を暗号化することを示すインジケータ。 | [ジョブの暗号化を設定] フィールド。暗号化を選択するには、このボックスにチェックを入れます。オフのままにすると、ジョブ出力はアカウントのデフォルトKMSキーで暗号化され、ジョブインスタンスボリュームは暗号化されません。 | Studio と同様です。 | サポート外。 |
| 出力暗号化KMSキー | ノートブックジョブの出力に使用される暗号化KMSキーをカスタマイズする場合に使用するキー。このフィールドは、[ジョブの暗号化を設定] をオンにした場合にのみ適用されます。 | フィールド出力暗号化KMSキー。このフィールドを指定しない場合、ノートブックジョブの出力はデフォルトの Amazon S3 KMSキーを使用して SSEでKMS暗号化されます。また、Amazon S3 バケットを独自に作成して暗号化を使用する場合、暗号化方法は保持されます。 | Studio と同様です。このフィールドには、新しいジョブ定義を作成するたびに事前入力される独自のユーザーデフォルトを設定できます。詳細については、「ローカルノートブックのデフォルトオプションをセットアップ」を参照してください。 | s3_kms_key パラメータ。デフォルトは None です。インテリジェントなデフォルトを許可します。 |
| ジョブインスタンスボリューム暗号化KMSキー | ジョブインスタンスボリュームを暗号化する場合に使用するKMSキー。このフィールドは、[ジョブの暗号化を設定] をオンにした場合にのみ適用されます。 | フィールド ジョブインスタンスボリューム暗号化KMSキー。 | フィールド ジョブインスタンスボリューム暗号化KMSキー。このフィールドには、新しいジョブ定義を作成するたびに事前入力される独自のユーザーデフォルトを設定できます。詳細については、「ローカルノートブックのデフォルトオプションをセットアップ」を参照してください。 | volume_kms_key パラメータ。デフォルトは None です。インテリジェントなデフォルトを許可します。 |
| Virtual Private Cloud を使用してこのジョブを実行する (VPCユーザー向け） | このジョブを Virtual Private Cloud () で実行するインジケータVPC。セキュリティを向上させるには、プライベート を使用することをお勧めしますVPC。 | [Virtual Private Cloud を使用してこのジョブを実行する] フィールド を使用する場合は、このチェックボックスをオンにしますVPC。ノートブックジョブがそれらの AWS リソースにプライベートに接続できるようにするには、少なくとも次のVPCエンドポイントを作成します。
|
Studio と同様です。 | 該当なし |
| サブネット (複数可) (VPCユーザー用） | 自分のサブネット。このフィールドには少なくとも 1 つ、最大で 5 つ含める必要があり、指定するサブネットはすべてプライベートにする必要があります。詳細については、「 でサポートされていないパブリックVPCサブネット」を参照してください制約と考慮事項。 | [サブネット] フィールド。このフィールドのデフォルトは Studio ドメインに関連付けられたサブネットですが、必要に応じて変更できます。 | [サブネット] フィールド。スケジューラはサブネットを検出できないため、 用に設定したサブネットを入力する必要がありますVPC。 | パラメータ subnets。デフォルトは None です。インテリジェントなデフォルトを許可します。 |
| セキュリティグループ (複数可) (VPCユーザー用） | 自分のセキュリティグループ。このフィールドには、少なくとも 1 つ、最大で 15 含める必要があります。詳細については、「 でサポートされていないパブリックVPCサブネット」を参照してください制約と考慮事項。 | [セキュリティグループ] フィールド。このフィールドのデフォルトはドメイン に関連付けられたセキュリティグループですがVPC、必要に応じてこのフィールドを変更できます。 | [セキュリティグループ] フィールド。スケジューラはセキュリティグループを検出できないため、 用に設定したセキュリティグループを入力する必要がありますVPC。 | パラメータ security_group_ids。デフォルトは None です。インテリジェントなデフォルトを許可します。 |
| 名前 | ノートブックジョブステップの名前 | 該当なし | 該当なし | name パラメータ。指定しない場合、ノートブックファイル名から派生したものが使用されます。 |
| Display name (表示名) | パイプライン実行のリストに表示されるジョブ名 | 該当なし | 該当なし | display_name パラメータ。デフォルトは None です。 |
| 説明 | ジョブについての説明 | 該当なし | 該当なし | description パラメータ。 |
