Class ExecutionTemplate

The description a notebook execution workload.

Inheritance
object
ExecutionTemplate
Implements
Inherited Members
Namespace: Google.Apis.AIPlatformNotebooks.v1.Data
Assembly: Google.Apis.AIPlatformNotebooks.v1.dll
Syntax
public class ExecutionTemplate : IDirectResponseSchema

Properties

AcceleratorConfig

Configuration (count and accelerator type) for hardware running notebook execution.

Declaration
[JsonProperty("acceleratorConfig")]
public virtual SchedulerAcceleratorConfig AcceleratorConfig { get; set; }
Property Value
Type Description
SchedulerAcceleratorConfig

ContainerImageUri

Container Image URI to a DLVM Example: 'gcr.io/deeplearning-platform-release/base-cu100' More examples can be found at: https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container

Declaration
[JsonProperty("containerImageUri")]
public virtual string ContainerImageUri { get; set; }
Property Value
Type Description
string

DataprocParameters

Parameters used in Dataproc JobType executions.

Declaration
[JsonProperty("dataprocParameters")]
public virtual DataprocParameters DataprocParameters { get; set; }
Property Value
Type Description
DataprocParameters

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

InputNotebookFile

Path to the notebook file to execute. Must be in a Google Cloud Storage bucket. Format: gs://{bucket_name}/{folder}/{notebook_file_name} Ex: gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb

Declaration
[JsonProperty("inputNotebookFile")]
public virtual string InputNotebookFile { get; set; }
Property Value
Type Description
string

JobType

The type of Job to be used on this execution.

Declaration
[JsonProperty("jobType")]
public virtual string JobType { get; set; }
Property Value
Type Description
string

KernelSpec

Name of the kernel spec to use. This must be specified if the kernel spec name on the execution target does not match the name in the input notebook file.

Declaration
[JsonProperty("kernelSpec")]
public virtual string KernelSpec { get; set; }
Property Value
Type Description
string

Labels

Labels for execution. If execution is scheduled, a field included will be 'nbs-scheduled'. Otherwise, it is an immediate execution, and an included field will be 'nbs-immediate'. Use fields to efficiently index between various types of executions.

Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type Description
IDictionary<string, string>

MasterType

Specifies the type of virtual machine to use for your training job's master worker. You must specify this field when scaleTier is set to CUSTOM. You can use certain Compute Engine machine types directly in this field. The following types are supported: - 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 Alternatively, you can use the following legacy machine types: - 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 Finally, if you want to use a TPU for training, specify cloud_tpu in this field. Learn more about the special configuration options for training with TPU.

Declaration
[JsonProperty("masterType")]
public virtual string MasterType { get; set; }
Property Value
Type Description
string

OutputNotebookFolder

Path to the notebook folder to write to. Must be in a Google Cloud Storage bucket path. Format: gs://{bucket_name}/{folder} Ex: gs://notebook_user/scheduled_notebooks

Declaration
[JsonProperty("outputNotebookFolder")]
public virtual string OutputNotebookFolder { get; set; }
Property Value
Type Description
string

Parameters

Parameters used within the 'input_notebook_file' notebook.

Declaration
[JsonProperty("parameters")]
public virtual string Parameters { get; set; }
Property Value
Type Description
string

ParamsYamlFile

Parameters to be overridden in the notebook during execution. Ref https://papermill.readthedocs.io/en/latest/usage-parameterize.html on how to specifying parameters in the input notebook and pass them here in an YAML file. Ex: gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml

Declaration
[JsonProperty("paramsYamlFile")]
public virtual string ParamsYamlFile { get; set; }
Property Value
Type Description
string

ScaleTier

Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.

Declaration
[JsonProperty("scaleTier")]
public virtual string ScaleTier { get; set; }
Property Value
Type Description
string

ServiceAccount

The email address of a service account to use when running the execution. You must have the iam.serviceAccounts.actAs permission for the specified service account.

Declaration
[JsonProperty("serviceAccount")]
public virtual string ServiceAccount { get; set; }
Property Value
Type Description
string

Tensorboard

The name of a Vertex AI [Tensorboard] resource to which this execution will upload Tensorboard logs. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

Declaration
[JsonProperty("tensorboard")]
public virtual string Tensorboard { get; set; }
Property Value
Type Description
string

VertexAiParameters

Parameters used in Vertex AI JobType executions.

Declaration
[JsonProperty("vertexAiParameters")]
public virtual VertexAIParameters VertexAiParameters { get; set; }
Property Value
Type Description
VertexAIParameters

Implements