Class ExecutionTemplate (1.0.0-beta04)

public sealed class ExecutionTemplate : IMessage<ExecutionTemplate>, IEquatable<ExecutionTemplate>, IDeepCloneable<ExecutionTemplate>, IBufferMessage, IMessage

The description a notebook execution workload.

Inheritance

Object > ExecutionTemplate

Implements

IMessage<ExecutionTemplate>, IEquatable<ExecutionTemplate>, IDeepCloneable<ExecutionTemplate>, IBufferMessage, IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Notebooks.V1

Assembly

Google.Cloud.Notebooks.V1.dll

Constructors

ExecutionTemplate()

public ExecutionTemplate()

ExecutionTemplate(ExecutionTemplate)

public ExecutionTemplate(ExecutionTemplate other)

Parameter
Name	Description
`other`	`ExecutionTemplate`

Properties

AcceleratorConfig

public ExecutionTemplate.Types.SchedulerAcceleratorConfig AcceleratorConfig { get; set; }

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

Property Value
Type	Description
`ExecutionTemplate.Types.SchedulerAcceleratorConfig`

ContainerImageUri

public string ContainerImageUri { get; set; }

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

Property Value
Type	Description
`String`

DataprocParameters

public ExecutionTemplate.Types.DataprocParameters DataprocParameters { get; set; }

Parameters used in Dataproc JobType executions.

Property Value
Type	Description
`ExecutionTemplate.Types.DataprocParameters`

InputNotebookFile

public string InputNotebookFile { get; set; }

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

Property Value
Type	Description
`String`

JobParametersCase

public ExecutionTemplate.JobParametersOneofCase JobParametersCase { get; }

Property Value
Type	Description
`ExecutionTemplate.JobParametersOneofCase`

JobType

public ExecutionTemplate.Types.JobType JobType { get; set; }

The type of Job to be used on this execution.

Property Value
Type	Description
`ExecutionTemplate.Types.JobType`

KernelSpec

public string KernelSpec { get; set; }

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.

Property Value
Type	Description
`String`

Labels

public MapField<string, string> Labels { get; }

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.

Property Value
Type	Description
`MapField<String, String>`

MasterType

public string MasterType { get; set; }

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.

Property Value
Type	Description
`String`

OutputNotebookFolder

public string OutputNotebookFolder { get; set; }

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

Property Value
Type	Description
`String`

Parameters

public string Parameters { get; set; }

Parameters used within the 'input_notebook_file' notebook.

Property Value
Type	Description
`String`

ParamsYamlFile

public string ParamsYamlFile { get; set; }

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

Property Value
Type	Description
`String`

ScaleTier

[Obsolete]
public ExecutionTemplate.Types.ScaleTier ScaleTier { get; set; }

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

Property Value
Type	Description
`ExecutionTemplate.Types.ScaleTier`

ServiceAccount

public string ServiceAccount { get; set; }

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.

Property Value
Type	Description
`String`

Tensorboard

public string Tensorboard { get; set; }

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

Property Value
Type	Description
`String`

TensorboardAsTensorboardName

public TensorboardName TensorboardAsTensorboardName { get; set; }

TensorboardName-typed view over the Tensorboard resource name property.

Property Value
Type	Description
`TensorboardName`

VertexAiParameters

public ExecutionTemplate.Types.VertexAIParameters VertexAiParameters { get; set; }

Parameters used in Vertex AI JobType executions.

Property Value
Type	Description
`ExecutionTemplate.Types.VertexAIParameters`