ノートブックの実行スケジュールを設定する

このページでは、Vertex AI Workbench エグゼキュータを使用して、Python ノートブック ファイルを 1 時間ごとに実行する方法について説明します。

始める前に

  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. Google Cloud Console の [プロジェクト セレクタ] ページで、Google Cloud プロジェクトを選択または作成します。

    プロジェクト セレクタに移動

  3. Google Cloud プロジェクトで課金が有効になっていることを確認します。

  4. Notebooks and Vertex AI API を有効にします。

    API を有効にする

    5.

  5. Google Cloud Console の [プロジェクト セレクタ] ページで、Google Cloud プロジェクトを選択または作成します。

    プロジェクト セレクタに移動

  6. Google Cloud プロジェクトで課金が有効になっていることを確認します。

  7. Notebooks and Vertex AI API を有効にします。

    API を有効にする

    8.

必要なロール

インスタンスのサービス アカウントに Vertex AI Workbench エグゼキュータの操作に必要な権限を付与するには、プロジェクトに対する Notebooks 閲覧者（roles/notebooks.viewer）IAM ロールをインスタンスのサービス アカウントに付与するよう管理者に依頼してください。ロールの付与の詳細については、アクセス権の管理をご覧ください。

この事前定義ロールには、Vertex AI Workbench エグゼキュータの操作に必要な権限が含まれています。必要な権限を正確に確認するには、「必要な権限」セクションを開いてください。

必要な権限

Vertex AI Workbench エグゼキュータを操作するには、次の権限が必要です。

  • 実行を一覧表示する: notebooks.executions.list

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

インスタンスとサンプル ノートブック ファイルを作成する

  1. インスタンスを作成します。

  2. JupyterLab を開きます。

  3. 新しいノートブック ファイルを開きます。

  4. ノートブック ファイルの最初のセルに、次のように入力します。

    # Import datetime
import datetime

# Get the time and print it
datetime.datetime.now()
print(datetime.datetime.now())

  5. ノートブック ファイルを保存するには、[File] > [Save Notebook] の順に選択します。

実行のスケジュールを設定する

  1. Google Cloud コンソールで、[インスタンス] ページに移動します。

    [インスタンス] に移動

  2. インスタンス名の横にある [JupyterLab を開く] をクリックします。

    Vertex AI Workbench インスタンスで JupyterLab が表示されます。

  3. [File Browser] で、サンプル ノートブック ファイルをダブルクリックして開きます。

  4. [ Execute] ボタンをクリックします。

  5. [Submit notebooks to Executor] ダイアログの [Type] フィールドで、[Schedule-based recurring executions] を選択します。

    デフォルトでは、エグゼキュータはノートブック ファイルを 1 時間ごとに 00 分実行します。

  6. [Advanced options] で、[Cloud Storage bucket] フィールドにバケットの名前を入力し、[Create and select] をクリックします。エグゼキュータは、この Cloud Storage バケットにノートブックの出力を保存します。

  7. [Submit] をクリックします。

    ノートブック ファイルは、設定したスケジュールで自動的に実行されます。

このドキュメントに記載されているタスクの完了後、作成したリソースを削除すると、それ以上の請求は発生しません。詳細については、クリーンアップをご覧ください。

実行されたノートブック ファイルの表示、共有、インポート

インスタンスの JupyterLab インターフェースを使用すると、実行結果の表示、他のユーザーとの共有、実行されたノートブック ファイルの JupyterLab へのインポートを行うことができます。

実行結果を確認する

  1. JupyterLab のナビゲーション メニューで [Notebook Executor] ボタンをクリックします。

  2. [Executions] タブをクリックします。

  3. 表示する実行条件の下にある [View result] をクリックします。

    エグゼキュータが新しいブラウザタブに結果を表示します。

実行結果を共有する

  1. インスタンスの JupyterLab ユーザー インターフェースで、ナビゲーション メニューの [ Notebook Executor] ボタンをクリックします。

  2. [Executions] タブをクリックします。

  3. 共有する実行の横にあるオプション メニューをクリックして、[Share execution result] を選択します。

  4. ダイアログの指示に沿って、実行結果へのアクセス権をユーザーに付与します。

実行したノートブックを JupyterLab にインポートする

  1. インスタンスの JupyterLab ユーザー インターフェースで、ナビゲーション メニューの [ Notebook Executor] ボタンをクリックします。

  2. [Executions] タブをクリックします。

  3. インポートする実行の横にあるオプション メニューをクリックし、[Import executed notebook] を選択します。

  4. [Select Kernel] ダイアログが表示されたら、ノートブックを開くカーネルを選択します。

    エグゼキュータは、実行されたノートブック ファイルを JupyterLab で開きます。JupyterLab ファイル ブラウザで、このノートブック ファイルは imported_notebook_jobs フォルダに保存されています。

スケジュールを表示または削除する

スケジュールを表示および削除するには、Google Cloud コンソールまたはインスタンスの JupyterLab ユーザー インターフェースを使用します。

スケジュールを表示する

スケジュールを表示してスケジュールの頻度設定を確認します。また、ノートブック ファイル実行の直近の 5 つの結果を確認することもできます。

コンソール

  1. Google Cloud コンソールで、[スケジュール] ページに移動します。

    [スケジュール] に移動

  2. 表示するスケジュールのスケジュール名をクリックします。

    [スケジュールの詳細] ページに、スケジュールの直近の 5 回の実行が表示されます。

  3. 実行名の横の [結果を表示] をクリックして、実行されたノートブック ファイルを開きます。

    エグゼキュータが新しいブラウザタブに結果を表示します。

JupyterLab

  1. インスタンスの JupyterLab ユーザー インターフェースで、ナビゲーション メニューの [ Notebook Executor] ボタンをクリックします。

  2. [Schedules] タブをクリックします。

  3. 表示する実行の下にある [View latest execution result] をクリックします。

    エグゼキュータが新しいブラウザタブに結果を表示します。

スケジュールを削除する

スケジュールを削除しても、そのスケジュールから生成された実行は削除されません。

コンソール

  1. Google Cloud コンソールで、[スケジュール] ページに移動します。

    [スケジュール] に移動

  2. 削除するスケジュールを選択します。

  3. [削除] をクリックします。

JupyterLab

  1. インスタンスの JupyterLab ユーザー インターフェースで、ナビゲーション メニューの [ Notebook Executor] ボタンをクリックします。

  2. [Schedules] タブをクリックします。

  3. スケジュール名をクリックします。Google Cloud コンソールで、そのスケジュールの [スケジュールの詳細] ページが開きます。

  4. [削除] をクリックします。

クリーンアップ

このページで使用したリソースについて、Google Cloud アカウントに課金されないようにするには、次の操作を行います。

インスタンスを削除する

  1. Google Cloud コンソールで、[インスタンス] ページに移動します。

    [インスタンス] に移動

  2. 削除するインスタンスを選択します。

  3. [削除] をクリックします。

プロジェクトを削除する

スケジュールの作成に必要な Cloud Storage バケットなど、Vertex AI Workbench インスタンス以外のリソースを使用した場合は、それ以上の課金が発生しないように、プロジェクトを削除することをおすすめします。

  1. In the Google Cloud console, go to the Manage resources page.

    Go to Manage resources

  2. In the project list, select the project that you want to delete, and then click Delete.
  3. In the dialog, type the project ID, and then click Shut down to delete the project.

次のステップ