翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# SageMaker AI Python SDK を使用したノートブックジョブの作成例
SageMaker Python SDK を使用してスタンドアロンのノートブックを実行するには、ノートブックジョブステップを作成し、そのステップをパイプラインにアタッチして、Pipelines が提供するユーティリティを使ってオンデマンドでジョブを実行するか、必要に応じて単一または複数の将来のジョブをスケジュールする必要があります。以降のセクションでは、オンデマンドまたはスケジュールされたノートブックジョブを作成し、実行を追跡するための基本的な手順について説明します。さらに、ノートブックジョブにパラメータを渡す必要がある場合や、ノートブックで Amazon EMR に接続する必要がある場合は、以下の説明を参照してください。このような場合は、追加の Jupyter Notebook の準備が必要です。`NotebookJobStep` の引数のサブセットにデフォルトを適用して、ノートブックジョブステップを作成する都度指定する必要を回避することもできます。
SageMaker AI Python SDK を使用してノートブックジョブをスケジュールする方法を説明するサンプルノートブックを表示するには、「[ノートブックジョブのサンプルノートブック](https://github.com/aws/amazon-sagemaker-examples/tree/main/sagemaker-pipelines/notebook-job-step)」を参照してください。
**Topics**
+ [ノートブックジョブを作成するステップ](#create-notebook-auto-run-overall)
+ [Studio UI ダッシュボードでノートブックジョブを表示する](#create-notebook-auto-run-dash)
+ [Studio でパイプライングラフを表示する](#create-notebook-auto-run-graph)
+ [パラメータのノートブックへの受け渡し](#create-notebook-auto-run-passparam)
+ [入力ノートブックから Amazon EMR クラスターに接続する](#create-notebook-auto-run-emr)
+ [デフォルトのオプションを設定する](#create-notebook-auto-run-intdefaults)
## ノートブックジョブを作成するステップ
直ちに実行するノートブックジョブか、スケジュールに従って実行するノートブックジョブを作成できます。以下の手順では、両方の方法を説明します。
**ノートブックジョブをスケジュールするには、次の基本的な手順を実行します。**
1. `NotebookJobStep` インスタンスを作成します。`NotebookJobStep` パラメータの詳細については、「[sagemaker.workflow.steps.NotebookJobStep](https://sagemaker.readthedocs.io/en/stable/workflows/pipelines/sagemaker.workflow.pipelines.html#sagemaker.workflow.notebook_job_step.NotebookJobStep)」を参照してください。次のコードスニペットに示されるとおり、少なくとも、次の引数を指定できます。
**重要**
SageMaker Python SDK を使用してノートブックジョブをスケジュールする場合、ノートブックジョブを実行するために指定できるのは特定のイメージのみです。詳細については、「[SageMaker AI Python SDK ノートブックジョブのイメージに関する制約](notebook-auto-run-constraints.md#notebook-auto-run-constraints-image-sdk)」を参照してください。
```
notebook_job_step = NotebookJobStep(
input_notebook={{input-notebook}},
image_uri={{image-uri}},
kernel_name={{kernel-name}}
)
```
1. 次のスニペットに示されるとおり、`NotebookJobStep` を単一のステップとしてパイプラインを作成します。
```
pipeline = Pipeline(
name={{pipeline-name}},
steps=[notebook_job_step],
sagemaker_session={{sagemaker-session}},
)
```
1. パイプラインをオンデマンドで実行するか、必要に応じて将来のパイプライン実行をスケジュールします。即時実行を開始するには、次のコマンドを使用します。
```
execution = pipeline.start(
parameters={...}
)
```
必要に応じて、将来のパイプライン実行を 1 回スケジュールすることも、事前指定の間隔で複数の実行をスケジュールすることもできます。スケジュールの指定は `PipelineSchedule` で行い、`put_triggers` を使用してスケジュール オブジェクトをパイプラインに渡します。パイプラインのスケジュールの詳細については、「[SageMaker Python SDK でパイプラインをスケジュールする](pipeline-eventbridge.md#build-and-manage-scheduling)」を参照してください。
次の例では、パイプラインが 2023 年 12 月 12 日 午前 10:31:32 UTC に 1 回実行されるようにスケジュールします。
```
my_schedule = PipelineSchedule(
name="my-schedule“,
at=datetime(year=2023, month=12, date=25, hour=10, minute=31, second=32)
)
pipeline.put_triggers(triggers=[my_schedule])
```
次の例では、パイプラインが 2022 年から 2023 年までの各月の最終金曜日の午前 10:15 UTC に実行されるようにスケジュールします。cron ベースのスケジュールの詳細については、「[Cron-based schedules](https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html#cron-based)」を参照してください。
```
my_schedule = PipelineSchedule(
name="my-schedule“,
cron="15 10 ? * 6L 2022-2023"
)
pipeline.put_triggers(triggers=[my_schedule])
```
1. (オプション) SageMaker ノートブックジョブダッシュボードでノートブックジョブを表示します。Studio UI がジョブをキャプチャして表示する方法は、ノートブックジョブステップの `tags` 引数で指定する値によって制御できます。詳細については、「[Studio UI ダッシュボードでノートブックジョブを表示する](#create-notebook-auto-run-dash)」を参照してください。
## Studio UI ダッシュボードでノートブックジョブを表示する
パイプラインステップとして作成するノートブックジョブは、特定のタグを指定すると Studio ノートブックジョブダッシュボードに表示されます。
**注記**
Studio またはローカル JupyterLab 環境で作成されたノートブックジョブのみがジョブ定義を作成します。このため、SageMaker Python SDK を使用してノートブックジョブを作成した場合、ノートブックジョブダッシュボードにジョブ定義は表示されません。ただし、「[ノートブックジョブを表示](view-notebook-jobs.md)」の説明に従ってノートブックジョブを表示することができます。
次のタグを使用すると、ノートブックジョブを表示できるチームメンバーを制御できます。
+ ドメイン内のすべてのユーザープロファイルまたは[スペース](https://docs.aws.amazon.com/sagemaker/latest/dg/studio-updated-jl-user-guide.html)にノートブックを表示するには、ドメイン名でドメインタグを追加します。例を以下に示します。
+ キー: `sagemaker:domain-name`、値: `d-abcdefghij5k`
+ ノートブックジョブをドメイン内の特定のユーザープロファイルに表示するには、ユーザープロファイルとドメインタグの両方を追加します。ユーザープロファイルタグの例は以下の通りです。
+ キー: `sagemaker:user-profile-name`、値: `studio-user`
+ ノートブックジョブを[スペース](https://docs.aws.amazon.com/sagemaker/latest/dg/studio-updated-jl-user-guide.html)に表示するには、スペースタグとドメインタグの両方を追加します。スペースタグの例は以下の通りです。
+ キー: `sagemaker:shared-space-name`、値: `my-space-name`
+ ドメインタグ、ユーザープロファイルタグ、またはスペースタグをアタッチしない場合、パイプラインステップで作成されたノートブックジョブは Studio UI に表示されません。この場合、トレーニングジョブコンソールで基盤となるトレーニングジョブを表示するか、[パイプライン実行のリスト](https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines-studio-view-execution.html)でステータスを表示できます。
ダッシュボードでジョブを表示するために必要なタグを設定した後の、ジョブを表示して出力をダウンロードする方法の詳細については、「[ノートブックジョブを表示](view-notebook-jobs.md)」を参照してください。
## Studio でパイプライングラフを表示する
ノートブックジョブステップはパイプラインの一部であるため、Studio でパイプライングラフ (DAG) を表示できます。パイプライングラフでは、パイプライン実行のステータスを表示し、リネージを追跡できます。詳細については、「[パイプライン実行の詳細を表示する](pipelines-studio-view-execution.md)」を参照してください。
## パラメータのノートブックへの受け渡し
ノートブックジョブにパラメータを渡す場合 (`NotebookJobStep` の `parameters` 引数を使用)、パラメータを受け取るように入力ノートブックを準備する必要があります。
Papermill ベースのノートブックジョブエグゼキュータは、`parameters` タグでタグ付けされた Jupyter セルを検索し、このセルの直後に新しいパラメータまたはパラメータの上書きを適用します。詳細については、「[ノートブックをパラメータ化する](notebook-auto-run-troubleshoot-override.md)」を参照してください。
このステップを実行したら、次の例に示されるとおり、パラメータを `NotebookJobStep` に渡します。
```
notebook_job_parameters = {
"company": "Amazon"
}
notebook_job_step = NotebookJobStep(
image_uri={{image-uri}},
kernel_name={{kernel-name}},
role={{role-name}},
input_notebook={{input-notebook}},
parameters=notebook_job_parameters,
...
)
```
## 入力ノートブックから Amazon EMR クラスターに接続する
Studio で Jupyter Notebook から Amazon EMR クラスターに接続する場合は、Jupyter Notebook をさらに変更する必要がある場合があります。ノートブックで次のいずれかのタスクを実行する必要がある場合は、「[ノートブックから Amazon EMR クラスターに接続する](scheduled-notebook-connect-emr.md)」を参照してください。
+ **Amazon EMR 接続コマンドにパラメータを渡します**。Studio では Papermill を使用してノートブックを実行します。SparkMagic カーネルでは、Papermill が SparkMagic に情報を渡す方法が原因で、Amazon EMR 接続コマンドに渡すパラメータが期待どおりに機能しない場合があります。
+ **Kerberos、LDAP、または HTTP ベーシック認証を受けた Amazon EMR クラスターにユーザー認証情報を渡します**。ユーザー認証情報は、 AWS Secrets Managerを介してを渡す必要があります。
## デフォルトのオプションを設定する
SageMaker SDK は、パラメータのサブセットのデフォルトを設定するオプションが提供されているため、`NotebookJobStep` インスタンスを作成する都度、次のとおりのパラメータを指定する必要はありません。このようなパラメータは、`role`、`s3_root_uri`、`s3_kms_key`、`volume_kms_key`、`subnets`、`security_group_ids` です。ステップのデフォルトを指定するには、SageMaker AI の設定ファイルを使用します。SageMaker AI 設定ファイルの詳細については、「[SageMaker Python SDK を使用してデフォルトを設定して使用する](https://sagemaker.readthedocs.io/en/stable/overview.html#configuring-and-using-defaults-with-the-sagemaker-python-sdk)」を参照してください。
ノートブックジョブのデフォルトを指定するには、次のスニペットに示されるとおり、設定ファイルのノートブックジョブセクションに新しいデフォルトを適用します。
```
SageMaker:
PythonSDK:
Modules:
NotebookJob:
RoleArn: 'arn:aws:iam::555555555555:role/IMRole'
S3RootUri: 's3://amzn-s3-demo-bucket/my-project'
S3KmsKeyId: 's3kmskeyid'
VolumeKmsKeyId: 'volumekmskeyid1'
VpcConfig:
SecurityGroupIds:
- 'sg123'
Subnets:
- 'subnet-1234'
```