ExecutionTemplate

ノートブック実行ワークロードの説明。

JSON 表現 
{
  "scaleTier": enum (ScaleTier),
  "masterType": string,
  "acceleratorConfig": {
    object (SchedulerAcceleratorConfig)
  },
  "labels": {
    string: string,
    ...
  },
  "inputNotebookFile": string,
  "containerImageUri": string,
  "outputNotebookFolder": string,
  "paramsYamlFile": string,
  "parameters": string,
  "serviceAccount": string,
  "jobType": enum (JobType),
  "kernelSpec": string,
  "tensorboard": string,

  // Union field job_parameters can be only one of the following:
  "dataprocParameters": {
    object (DataprocParameters)
  },
  "vertexAiParameters": {
    object (VertexAIParameters)
  }
  // End of list of possible types for union field job_parameters.
}
フィールド
scaleTier
(deprecated)

enum (ScaleTier)

必須。ノートブックの実行に使用されるハードウェアのスケールティア。非推奨。削除されます。現時点では CUSTOM のみがサポートされています。
masterType

string

トレーニング ジョブのマスター ワーカーに使用する仮想マシンのタイプを指定します。scaleTier が CUSTOM に設定されている場合は、このフィールドを指定する必要があります。

このフィールドには、特定の Compute Engine マシンタイプを直接使用できます。次の型がサポートされています。

  • n1-standard-4
  • n1-standard-8
  • n1-standard-16
  • n1-standard-32
  • n1-standard-64
  • n1-standard-96
  • n1-highmem-2
  • n1-highmem-4
  • n1-highmem-8
  • n1-highmem-16
  • n1-highmem-32
  • n1-highmem-64
  • n1-highmem-96
  • n1-highcpu-16
  • n1-highcpu-32
  • n1-highcpu-64
  • n1-highcpu-96

または、次の従来のマシンタイプを使用できます。

  • standard
  • large_model
  • complex_model_s
  • complex_model_m
  • complex_model_l
  • standard_gpu
  • complex_model_m_gpu
  • complex_model_l_gpu
  • standard_p100
  • complex_model_m_p100
  • standard_v100
  • large_model_v100
  • complex_model_m_v100
  • complex_model_l_v100

最後に、トレーニングに TPU を使用する場合は、このフィールドに cloud_tpu を指定します。詳しくは、TPU を使用したトレーニングの特別な構成オプションをご覧ください。
acceleratorConfig

object (SchedulerAcceleratorConfig)

ノートブックの実行に使用されるハードウェアの構成（数とアクセラレータ タイプ）。
labels

map (key: string, value: string)

実行のラベル。実行がスケジュールされている場合、含まれるフィールドは 'nbs-scheduled' になります。それ以外の場合は、即時実行となり、含まれるフィールドは 'nbs-immediate' になります。フィールドを使用して、さまざまなタイプの実行を効率的にインデックス化します。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
inputNotebookFile

string

実行するノートブック ファイルのパス。Google Cloud Storage バケットに保存する必要があります。形式: gs://{bucket_name}/{folder}/{notebook_file_name} 例: gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb
containerImageUri

string

DLVM へのコンテナ イメージ URI 例: 'gcr.io/deeplearning-platform-release/base-cu100' その他の例については、https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container をご覧ください。
outputNotebookFolder

string

書き込むノートブック フォルダのパス。Google Cloud Storage バケット パスにする必要があります。形式: gs://{bucket_name}/{folder} 例: gs://notebook_user/scheduled_notebooks
paramsYamlFile

string

実行中にノートブックでオーバーライドされるパラメータ。入力ノートブックでパラメータを指定し、YAML ファイルで渡す方法については、https://papermill.readthedocs.io/en/latest/usage-parameterize.html をご覧ください。例: gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml
parameters

string

'inputNotebookFile' ノートブック内で使用されるパラメータ。
serviceAccount

string

実行時に使用するサービス アカウントのメールアドレス。指定したサービス アカウントに対する iam.serviceAccounts.actAs 権限が必要です。
jobType

enum (JobType)

この実行で使用するジョブのタイプ。
kernelSpec

string

使用するカーネル仕様の名前。実行ターゲットのカーネル仕様名が入力ノートブック ファイルの名前と一致しない場合は、これを指定する必要があります。
tensorboard

string

この実行で TensorBoard ログがアップロードされる Agent Platform [TensorBoard] リソースの名前。形式: projects/{project}/locations/{location}/tensorboards/{tensorboard}
共用体フィールド job_parameters。実行タイプのパラメータ。注: 現在、Vertex AI ジョブに追加のパラメータはありません。job_parameters は次のいずれかになります。
dataprocParameters

object (DataprocParameters)

Dataproc JobType の実行で使用されるパラメータ。
vertexAiParameters

object (VertexAIParameters)

Agent Platform JobType の実行で使用されるパラメータ。

ScaleTier

必須。マシンタイプ、ワーカーとパラメータ サーバーのレプリカの数を指定します。

列挙型
SCALE_TIER_UNSPECIFIED スケールティアが指定されていません。
BASIC 単一ワーカー インスタンス。この階層は、Cloud ML の使用方法を学習するため、および小さいデータセットを使用して新しいモデルを実験するために適しています。
STANDARD_1 多数のワーカーと少数のパラメータ サーバー。
PREMIUM_1 非常に多くのワーカーと多数のパラメータ サーバー。
BASIC_GPU K80 GPU を備えた 1 つのワーカー インスタンス。
BASIC_TPU Cloud TPU を備えた単一のワーカー インスタンス。
CUSTOM

CUSTOM 階層はあらかじめ設定された階層ではなく、独自のクラスタ仕様を使用するための階層です。この階層を使用するときは、処理クラスタを構成するための値を、以下のガイドラインに沿って設定します。

  • マスターノードに使用するマシンのタイプを指定するために ExecutionTemplate.masterType を設定する必要があります。これが唯一の必須の設定です。

SchedulerAcceleratorConfig

ハードウェア アクセラレータの定義。type と coreCount の組み合わせがすべて有効なわけではありません。有効な組み合わせについては、Compute Engine の GPU をご覧ください。TPU はサポートされていません。

JSON 表現 
{
  "type": enum (SchedulerAcceleratorType),
  "coreCount": string
}
フィールド
type

enum (SchedulerAcceleratorType)

このアクセラレータのタイプ。
coreCount

string (int64 format)

このアクセラレータのコア数。

SchedulerAcceleratorType

AI Platform Training ジョブのハードウェア アクセラレータ タイプ。

列挙型
SCHEDULER_ACCELERATOR_TYPE_UNSPECIFIED 未指定のアクセラレータ タイプ。デフォルトは GPU なしです。
NVIDIA_TESLA_K80 Nvidia Tesla K80 GPU.
NVIDIA_TESLA_P100 Nvidia Tesla P100 GPU.
NVIDIA_TESLA_V100 Nvidia Tesla V100 GPU.
NVIDIA_TESLA_P4 Nvidia Tesla P4 GPU.
NVIDIA_TESLA_T4 Nvidia Tesla T4 GPU.
NVIDIA_TESLA_A100 Nvidia Tesla A100 GPU.
TPU_V2 TPU v2.
TPU_V3 TPU v3.

JobType

この実行に使用されるバックエンド。

列挙型
JOB_TYPE_UNSPECIFIED タイプが指定されていません。
VERTEX_AI aiplatform.googleapis.com のカスタムジョブ。実行のデフォルト値。
DATAPROC Dataproc をジョブとして使用してクラスタで実行します。https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs

DataprocParameters

Dataproc JobType の実行で使用されるパラメータ。

JSON 表現 
{
  "cluster": string
}
フィールド
cluster

string

Dataproc の実行に使用されるクラスタの URI。形式: projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}

VertexAIParameters

Agent Platform JobType の実行で使用されるパラメータ。

JSON 表現 
{
  "network": string,
  "env": {
    string: string,
    ...
  }
}
フィールド
network

string

ジョブをピアリングする Compute Engine ネットワークのフルネームを指定します。たとえば、projects/12345/global/networks/myVPC のようにします。形式は projects/{project}/global/networks/{network} です。{project} はプロジェクト番号（12345 など）を表し、{network} はネットワーク名を表します。

このネットワークに対して、プライベート サービス アクセスがすでに構成されている必要があります。指定しない場合、ジョブはどのネットワークともピアリングされません。
env

map (key: string, value: string)

環境変数。最大 100 個の環境変数を指定できます。環境変数は一意である必要があります。例: GCP_BUCKET=gs://my-bucket/samples/

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }