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

Python

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。これらの ID は、Google Cloud コンソールの [ようこそ] ページで確認できます。
• location: 利用可能なロケーションの一覧をご覧ください。

Python

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: 実際のプロジェクト ID。これらは、Google Cloud コンソールの [ようこそ] ページで確認できます。
• location: 利用可能なロケーションの一覧をご覧ください。

Python

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: 実際のプロジェクト ID。これらは、Google Cloud コンソールの [ようこそ] ページで確認できます。
• location: 利用可能なロケーションの一覧をご覧ください。

Python

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: 実際のプロジェクト ID。これらは、Google Cloud コンソールの [ようこそ] ページで確認できます。
• location: 利用可能なロケーションの一覧をご覧ください。
• delete_backing_tensorboard_run: この実行の時系列指標を格納するバッキング Vertex AI TensorBoard の実行を削除するかどうか。

Python

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。これらのプロジェクト 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