テスト実行を作成して管理する

Vertex AI SDK for Python を使用して、テスト実行の作成と管理を行います。 Google Cloud コンソールを使用して、テスト実行を削除できます。

Vertex AI SDK for Python

以下のサンプルでは、aiplatform Package 関数のメソッド init、start_run、end_run、および ExperimentClass の delete を使用します。

実行を作成して開始する

Python

from typing import Optional, Union

from google.cloud import aiplatform


def create_experiment_run_sample(
    experiment_name: str,
    run_name: str,
    experiment_run_tensorboard: Optional[Union[str, aiplatform.Tensorboard]],
    project: str,
    location: str,
):
    aiplatform.init(experiment=experiment_name, project=project, location=location)

    aiplatform.start_run(run=run_name, tensorboard=experiment_run_tensorboard)
  • experiment_name: テストの名前を指定します。 Google Cloud コンソールで、セクション ナビゲーションの [テスト] を選択すると、テストのリストを見つけることができます。
  • run_name: 現在のセッションに関連付ける実行名を指定します。Vertex AI SDK リファレンス ドキュメントの start_run をご覧ください。
  • experiment_run_tensorboard: 省略可。log_time_series_metrics を使用して、このテスト実行に記録された時系列指標を有効にして保存するためのバッキング TensorBoard リソース。
  • project: これらの ID は、 Google Cloud コンソールの [ようこそ] ページで確認できます。
  • location: 利用可能なロケーションの一覧をご覧ください。

実行を終了する

Python

from google.cloud import aiplatform


def end_experiment_run_sample(
    experiment_name: str,
    run_name: str,
    project: str,
    location: str,
):
    aiplatform.init(experiment=experiment_name, project=project, location=location)

    aiplatform.start_run(run=run_name, resume=True)

    aiplatform.end_run()
  • experiment_name: テストの名前を指定します。 Google Cloud コンソールで、セクション ナビゲーションの [テスト] を選択すると、テストのリストを見つけることができます。
  • run_name: 実行名を指定します。
  • project: これらは Google Cloud コンソールの [ようこそ] ページで確認できます。
  • location: 利用可能なロケーションの一覧をご覧ください。

実行を再開する

Python

from google.cloud import aiplatform


def resume_experiment_run_sample(
    experiment_name: str,
    run_name: str,
    project: str,
    location: str,
):
    aiplatform.init(experiment=experiment_name, project=project, location=location)

    aiplatform.start_run(run=run_name, resume=True)
  • experiment_name: テストの名前を指定します。 Google Cloud コンソールで、セクション ナビゲーションの [テスト] を選択すると、テストのリストを見つけることができます。
  • run_name: 再開する実行の名前を指定します。
  • project: これらは Google Cloud コンソールの [ようこそ] ページで確認できます。
  • location: 利用可能なロケーションの一覧をご覧ください。

実行の削除

Python

from typing import Union

from google.cloud import aiplatform


def delete_experiment_run_sample(
    run_name: str,
    experiment: Union[str, aiplatform.Experiment],
    project: str,
    location: str,
    delete_backing_tensorboard_run: bool = False,
):
    experiment_run = aiplatform.ExperimentRun(
        run_name=run_name, experiment=experiment, project=project, location=location
    )

    experiment_run.delete(delete_backing_tensorboard_run=delete_backing_tensorboard_run)
  • experiment: このテストの名前またはインスタンス。 Google Cloud コンソールで、セクション ナビゲーションの [テスト] を選択すると、テストのリストを見つけることができます。
  • run_name: 削除する実行の名前を指定します。
  • project: これらは Google Cloud コンソールの [ようこそ] ページで確認できます。
  • location: 利用可能なロケーションの一覧をご覧ください。
  • delete_backing_tensorboard_run: この実行の時系列指標を格納するバッキング Vertex AI TensorBoard の実行を削除するかどうか。

ステータスを管理する

Python

from typing import Union

from google.cloud import aiplatform


def update_experiment_run_state_sample(
    run_name: str,
    experiment: Union[str, aiplatform.Experiment],
    project: str,
    location: str,
    state: aiplatform.gapic.Execution.State,
) -> None:
    experiment_run = aiplatform.ExperimentRun(
        run_name=run_name,
        experiment=experiment,
        project=project,
        location=location,
    )

    experiment_run.update_state(state)
  • run_name: テストに関連付けられた実行名
  • experiment_name: テストの名前。 Google Cloud コンソールでテストのリストを表示するには、セクション ナビゲーションで [テスト] を選択します。
  • project: これらのプロジェクト ID は、 Google Cloud コンソールの [ようこそ] ページで確認できます。
  • location: 利用可能なロケーションの一覧をご覧ください。
  • state: Google Cloud コンソールで「ステータス」として表示される state の有効な値は次のとおりです。
    • aiplatform.gapic.Execution.State.CACHED
    • aiplatform.gapic.Execution.State.CANCELLED
    • aiplatform.gapic.Execution.State.COMPLETE
    • aiplatform.gapic.Execution.State.FAILED
    • aiplatform.gapic.Execution.State.NEW
    • aiplatform.gapic.Execution.State.RUNNING

Google Cloud コンソール

テスト実行を削除する手順は次のとおりです。
  1. Google Cloud コンソールで [テスト] ページに移動します。
    [テスト] に移動
  2. テストの詳細ページで、削除するテスト実行に関連付けられているテストの名前をクリックします。[テスト実行] ページに、そのテストのすべてのテスト実行のリストが表示されます。
  3. 削除する実行に関連付けられているチェックボックスをオンにします。 [削除] ボタンが表示されます。
  4. [削除] をクリックします。
    • または、テスト実行と同じ行にある オプション メニューに移動して、[削除] を選択します。

テスト実行のリストと実行の詳細を表示する

Google Cloud コンソールには、これらの実行に関連するデータを可視化するための機能が用意されています。

次のステップ