パラメータを使用してノートブックを実行する

パラメータを使用してノートブックを実行する

Vertex AI Workbench マネージド ノートブックは非推奨になりました。2025 年 1 月 30 日にマネージド ノートブックのサポートが終了し、マネージド ノートブック インスタンスを作成する機能が削除されます。既存のインスタンスは引き続き機能しますが、パッチ、更新、アップグレードは利用できなくなります。Vertex AI Workbench を引き続き使用するには、マネージド ノートブック インスタンスを Vertex AI Workbench インスタンスに移行することをおすすめします。

Vertex AI Workbench マネージド ノートブック インスタンスを使用すると、ノートブックでパラメータ値を使用して、ノートブック ファイルでコードの動作を変更できます。このページでは、パラメータを使用するようにノートブック ファイルを設定する方法と、ノートブック パラメータに異なる値を指定して実行する方法について説明します。

パラメータを使用してノートブック ファイルにさまざまなイテレーションを実行する

次のように、ノートブックのパラメータ値を使用して同じノートブック コードを実行できます。

• 使用する別のデータセット、またはデータセットの別のサンプルサイズを指定します。

• 学習率やオプティマイザーのタイプなど、さまざまなモデル構成を指定します。

• 異なるモデルを実行するか、同じモデルの異なるバージョンを実行します。

ノートブック実行でのパラメータの使用方法

パラメータを使用してノートブックを実行するプロセスは、主に次の 2 つの手順から構成されます。

1. ノートブック ファイルのいずれかのセルに parameters タグを追加します。これは技術要件ではありませんが、通常、このセルにはパラメータ変数に値を割り当てるコードが含まれています。ただし、これは技術要件ではありません。実行時に別のパラメータ値を割り当てない場合、実行ではノートブック ファイル内のパラメータ値がデフォルト値として使用されます。

2. パラメータに新しい値を指定したノートブック ファイルの実行を作成します。パラメータとその値の形式を指定するには、次のパターンを使用します。 parameter1=value1,parameter2=value2。このパラメータで、パラメータと値のペアの間にカンマ、スペース、引用符は必要ありません。実行時に、エグゼキュータは parameters というタグの付いたセルの直後に、パラメータ値を更新するセルをノートブックに追加します。

始める前に

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Notebooks and Vertex AI APIs.

   Enable the APIs

5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

6. Make sure that billing is enabled for your Google Cloud project.

7. Enable the Notebooks and Vertex AI APIs.

   Enable the APIs

8. まだ作成していない場合は、マネージド ノートブック インスタンスを作成します。

必要なロール

インスタンスのサービス アカウントに Vertex AI Workbench エグゼキュータの操作に必要な権限を付与するには、プロジェクトに対する次の IAM ロールをインスタンスのサービス アカウントに付与するよう管理者に依頼してください。

• Notebooks 閲覧者（roles/notebooks.viewer）
• Vertex AI ユーザー（roles/aiplatform.user）
• ストレージ管理者（roles/storage.admin）

ロールの付与の詳細については、アクセスの管理をご覧ください。

管理者は、インスタンスのサービス アカウントに、カスタムロールや他の事前定義ロールを使用して必要な権限を付与することもできます。

JupyterLab を開く

JupyterLab を開き、実行するノートブック ファイルを準備するには、次の手順を行います。

1. JupyterLab を開きます。

2. ノートブック（ipynb）ファイルをアップロードするか、既存のファイルを開きます。あるいは、新しいノートブック ファイルを開いて、実行するコードを新しいノートブックに追加します。

3. ノートブック ファイルのコードがエグゼキュータの使用要件を満たしていることを確認してください。

ノートブック セルに parameters タグを追加する

1. マネージド ノートブック インスタンスの JupyterLab ユーザー インターフェースで、実行するノートブック ファイルを開きます。

2. パラメータ変数に値を割り当てるコードを 1 つのセルに記述します。これらは、実行中に異なるパラメータ値を割り当てない限り、ノートブック ファイルで使用される値です。

3. パラメータのセルが選択されていることを確認し、右側のサイドバーで プロパティ インスペクタをクリックします。

4. プロパティ インスペクタの [Cell Tags] で、[Add Tag] をクリックし、「parameters」と入力して Enter キーを押します。

   注: 複数のセルに parameters に設定すると、エグゼキュータはパラメータセルを 1 つだけ追加し、最初のセルの直後に parameters タグを挿入します。

実行用のパラメータ値を指定する

1. マネージド ノートブック インスタンスの JupyterLab ユーザー インターフェースで、[Executor] ボタンをクリックします。

2. [Submit notebooks to Executor] ダイアログで、[Execution name] フィールドに実行の名前を入力します。

3. マシンタイプとアクセラレータ タイプを選択します。

4. 環境を選択します。

5. [Type] フィールドで [One-time execution] を選択します。あるいは、[Schedule-based recurring executions] を選択して、ダイアログで実行スケジュールを設定します。

6. [Advanced options] で、ノートブックを実行するリージョンを選択します。

7. [Cloud Storage bucket] フィールドで、使用可能な Cloud Storage バケットを選択するか、新しいバケットの名前を入力して [Create and select] をクリックします。エグゼキュータは、この Cloud Storage バケットにノートブックの出力を保存します。

8. [Notebook parameterization] セクションの [Input parameters] テキスト ボックスに、ノートブック パラメータをカンマ区切りで追加します（例: optimizer=SGD,learning_rate=0.01）。スペースや引用符は使用できません。

9. 残りの実行項目を構成し、[Submit] をクリックします。

Notebook

より包括的なワークフローの一部としてノートブックの実行でパラメータを使用する方法の例については、次のいずれかの環境で Jupyter ノートブック「広告のターゲット設定用のマルチクラス分類モデルをトレーニングする」を実行します。

Colab で開く | Colab Enterprise で開く | Vertex AI Workbench ユーザー管理ノートブックで開く | GitHub で表示する

次のステップ

• エグゼキュータでノートブック コードを実行する方法を学習する。