public static final class ExecutionTemplate.Builder extends GeneratedMessageV3.Builder<ExecutionTemplate.Builder> implements ExecutionTemplateOrBuilderThe description a notebook execution workload.
Protobuf type google.cloud.notebooks.v1.ExecutionTemplate
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ExecutionTemplate.BuilderImplements
ExecutionTemplateOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ExecutionTemplate.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | |
build()
public ExecutionTemplate build()| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate | |
buildPartial()
public ExecutionTemplate buildPartial()| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate | |
clear()
public ExecutionTemplate.Builder clear()| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | |
clearAcceleratorConfig()
public ExecutionTemplate.Builder clearAcceleratorConfig()Configuration (count and accelerator type) for hardware running notebook execution.
.google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig accelerator_config = 3;
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | |
clearContainerImageUri()
public ExecutionTemplate.Builder clearContainerImageUri()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
string container_image_uri = 6;
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | This builder for chaining. |
clearDataprocParameters()
public ExecutionTemplate.Builder clearDataprocParameters()Parameters used in Dataproc JobType executions.
.google.cloud.notebooks.v1.ExecutionTemplate.DataprocParameters dataproc_parameters = 12;
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | |
clearField(Descriptors.FieldDescriptor field)
public ExecutionTemplate.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | |
clearInputNotebookFile()
public ExecutionTemplate.Builder clearInputNotebookFile() 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
string input_notebook_file = 5;
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | This builder for chaining. |
clearJobParameters()
public ExecutionTemplate.Builder clearJobParameters()| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | |
clearJobType()
public ExecutionTemplate.Builder clearJobType()The type of Job to be used on this execution.
.google.cloud.notebooks.v1.ExecutionTemplate.JobType job_type = 11;
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | This builder for chaining. |
clearKernelSpec()
public ExecutionTemplate.Builder clearKernelSpec()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.
string kernel_spec = 14;
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | This builder for chaining. |
clearLabels()
public ExecutionTemplate.Builder clearLabels()| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | |
clearMasterType()
public ExecutionTemplate.Builder clearMasterType() 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-4n1-standard-8n1-standard-16n1-standard-32n1-standard-64n1-standard-96n1-highmem-2n1-highmem-4n1-highmem-8n1-highmem-16n1-highmem-32n1-highmem-64n1-highmem-96n1-highcpu-16n1-highcpu-32n1-highcpu-64n1-highcpu-96
Alternatively, you can use the following legacy machine types:
standardlarge_modelcomplex_model_scomplex_model_mcomplex_model_lstandard_gpucomplex_model_m_gpucomplex_model_l_gpustandard_p100complex_model_m_p100standard_v100large_model_v100complex_model_m_v100complex_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.
string master_type = 2;
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ExecutionTemplate.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | |
clearOutputNotebookFolder()
public ExecutionTemplate.Builder clearOutputNotebookFolder() 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
string output_notebook_folder = 7;
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | This builder for chaining. |
clearParameters()
public ExecutionTemplate.Builder clearParameters()Parameters used within the 'input_notebook_file' notebook.
string parameters = 9;
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | This builder for chaining. |
clearParamsYamlFile()
public ExecutionTemplate.Builder clearParamsYamlFile() 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
string params_yaml_file = 8;
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | This builder for chaining. |
clearScaleTier() (deprecated)
public ExecutionTemplate.Builder clearScaleTier()Deprecated. google.cloud.notebooks.v1.ExecutionTemplate.scale_tier is deprecated. See google/cloud/notebooks/v1/execution.proto;l=151
Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
.google.cloud.notebooks.v1.ExecutionTemplate.ScaleTier scale_tier = 1 [deprecated = true, (.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | This builder for chaining. |
clearServiceAccount()
public ExecutionTemplate.Builder clearServiceAccount() 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.
string service_account = 10;
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | This builder for chaining. |
clearTensorboard()
public ExecutionTemplate.Builder clearTensorboard() The name of a Vertex AI [Tensorboard] resource to which this execution
will upload Tensorboard logs.
Format:
projects/{project}/locations/{location}/tensorboards/{tensorboard}
string tensorboard = 15 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | This builder for chaining. |
clearVertexAiParameters()
public ExecutionTemplate.Builder clearVertexAiParameters()Parameters used in Vertex AI JobType executions.
.google.cloud.notebooks.v1.ExecutionTemplate.VertexAIParameters vertex_ai_parameters = 13;
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | |
clone()
public ExecutionTemplate.Builder clone()| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | |
containsLabels(String key)
public boolean containsLabels(String key)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.
map<string, string> labels = 4;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
boolean | |
getAcceleratorConfig()
public ExecutionTemplate.SchedulerAcceleratorConfig getAcceleratorConfig()Configuration (count and accelerator type) for hardware running notebook execution.
.google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig accelerator_config = 3;
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.SchedulerAcceleratorConfig | The acceleratorConfig. |
getAcceleratorConfigBuilder()
public ExecutionTemplate.SchedulerAcceleratorConfig.Builder getAcceleratorConfigBuilder()Configuration (count and accelerator type) for hardware running notebook execution.
.google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig accelerator_config = 3;
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.SchedulerAcceleratorConfig.Builder | |
getAcceleratorConfigOrBuilder()
public ExecutionTemplate.SchedulerAcceleratorConfigOrBuilder getAcceleratorConfigOrBuilder()Configuration (count and accelerator type) for hardware running notebook execution.
.google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig accelerator_config = 3;
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.SchedulerAcceleratorConfigOrBuilder | |
getContainerImageUri()
public String getContainerImageUri()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
string container_image_uri = 6;
| Returns | |
|---|---|
| Type | Description |
String | The containerImageUri. |
getContainerImageUriBytes()
public ByteString getContainerImageUriBytes()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
string container_image_uri = 6;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for containerImageUri. |
getDataprocParameters()
public ExecutionTemplate.DataprocParameters getDataprocParameters()Parameters used in Dataproc JobType executions.
.google.cloud.notebooks.v1.ExecutionTemplate.DataprocParameters dataproc_parameters = 12;
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.DataprocParameters | The dataprocParameters. |
getDataprocParametersBuilder()
public ExecutionTemplate.DataprocParameters.Builder getDataprocParametersBuilder()Parameters used in Dataproc JobType executions.
.google.cloud.notebooks.v1.ExecutionTemplate.DataprocParameters dataproc_parameters = 12;
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.DataprocParameters.Builder | |
getDataprocParametersOrBuilder()
public ExecutionTemplate.DataprocParametersOrBuilder getDataprocParametersOrBuilder()Parameters used in Dataproc JobType executions.
.google.cloud.notebooks.v1.ExecutionTemplate.DataprocParameters dataproc_parameters = 12;
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.DataprocParametersOrBuilder | |
getDefaultInstanceForType()
public ExecutionTemplate getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getInputNotebookFile()
public String getInputNotebookFile() 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
string input_notebook_file = 5;
| Returns | |
|---|---|
| Type | Description |
String | The inputNotebookFile. |
getInputNotebookFileBytes()
public ByteString getInputNotebookFileBytes() 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
string input_notebook_file = 5;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for inputNotebookFile. |
getJobParametersCase()
public ExecutionTemplate.JobParametersCase getJobParametersCase()| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.JobParametersCase | |
getJobType()
public ExecutionTemplate.JobType getJobType()The type of Job to be used on this execution.
.google.cloud.notebooks.v1.ExecutionTemplate.JobType job_type = 11;
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.JobType | The jobType. |
getJobTypeValue()
public int getJobTypeValue()The type of Job to be used on this execution.
.google.cloud.notebooks.v1.ExecutionTemplate.JobType job_type = 11;
| Returns | |
|---|---|
| Type | Description |
int | The enum numeric value on the wire for jobType. |
getKernelSpec()
public String getKernelSpec()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.
string kernel_spec = 14;
| Returns | |
|---|---|
| Type | Description |
String | The kernelSpec. |
getKernelSpecBytes()
public ByteString getKernelSpecBytes()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.
string kernel_spec = 14;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for kernelSpec. |
getLabels() (deprecated)
public Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getLabelsCount()
public int getLabelsCount()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.
map<string, string> labels = 4;
| Returns | |
|---|---|
| Type | Description |
int | |
getLabelsMap()
public Map<String,String> getLabelsMap()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.
map<string, string> labels = 4;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)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.
map<string, string> labels = 4;
| Parameters | |
|---|---|
| Name | Description |
key | String |
defaultValue | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)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.
map<string, string> labels = 4;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getMasterType()
public String getMasterType() 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-4n1-standard-8n1-standard-16n1-standard-32n1-standard-64n1-standard-96n1-highmem-2n1-highmem-4n1-highmem-8n1-highmem-16n1-highmem-32n1-highmem-64n1-highmem-96n1-highcpu-16n1-highcpu-32n1-highcpu-64n1-highcpu-96
Alternatively, you can use the following legacy machine types:
standardlarge_modelcomplex_model_scomplex_model_mcomplex_model_lstandard_gpucomplex_model_m_gpucomplex_model_l_gpustandard_p100complex_model_m_p100standard_v100large_model_v100complex_model_m_v100complex_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.
string master_type = 2;
| Returns | |
|---|---|
| Type | Description |
String | The masterType. |
getMasterTypeBytes()
public ByteString getMasterTypeBytes() 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-4n1-standard-8n1-standard-16n1-standard-32n1-standard-64n1-standard-96n1-highmem-2n1-highmem-4n1-highmem-8n1-highmem-16n1-highmem-32n1-highmem-64n1-highmem-96n1-highcpu-16n1-highcpu-32n1-highcpu-64n1-highcpu-96
Alternatively, you can use the following legacy machine types:
standardlarge_modelcomplex_model_scomplex_model_mcomplex_model_lstandard_gpucomplex_model_m_gpucomplex_model_l_gpustandard_p100complex_model_m_p100standard_v100large_model_v100complex_model_m_v100complex_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.
string master_type = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for masterType. |
getMutableLabels() (deprecated)
public Map<String,String> getMutableLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getOutputNotebookFolder()
public String getOutputNotebookFolder() 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
string output_notebook_folder = 7;
| Returns | |
|---|---|
| Type | Description |
String | The outputNotebookFolder. |
getOutputNotebookFolderBytes()
public ByteString getOutputNotebookFolderBytes() 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
string output_notebook_folder = 7;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for outputNotebookFolder. |
getParameters()
public String getParameters()Parameters used within the 'input_notebook_file' notebook.
string parameters = 9;
| Returns | |
|---|---|
| Type | Description |
String | The parameters. |
getParametersBytes()
public ByteString getParametersBytes()Parameters used within the 'input_notebook_file' notebook.
string parameters = 9;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for parameters. |
getParamsYamlFile()
public String getParamsYamlFile() 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
string params_yaml_file = 8;
| Returns | |
|---|---|
| Type | Description |
String | The paramsYamlFile. |
getParamsYamlFileBytes()
public ByteString getParamsYamlFileBytes() 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
string params_yaml_file = 8;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for paramsYamlFile. |
getScaleTier() (deprecated)
public ExecutionTemplate.ScaleTier getScaleTier()Deprecated. google.cloud.notebooks.v1.ExecutionTemplate.scale_tier is deprecated. See google/cloud/notebooks/v1/execution.proto;l=151
Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
.google.cloud.notebooks.v1.ExecutionTemplate.ScaleTier scale_tier = 1 [deprecated = true, (.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.ScaleTier | The scaleTier. |
getScaleTierValue() (deprecated)
public int getScaleTierValue()Deprecated. google.cloud.notebooks.v1.ExecutionTemplate.scale_tier is deprecated. See google/cloud/notebooks/v1/execution.proto;l=151
Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
.google.cloud.notebooks.v1.ExecutionTemplate.ScaleTier scale_tier = 1 [deprecated = true, (.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int | The enum numeric value on the wire for scaleTier. |
getServiceAccount()
public String getServiceAccount() 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.
string service_account = 10;
| Returns | |
|---|---|
| Type | Description |
String | The serviceAccount. |
getServiceAccountBytes()
public ByteString getServiceAccountBytes() 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.
string service_account = 10;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for serviceAccount. |
getTensorboard()
public String getTensorboard() The name of a Vertex AI [Tensorboard] resource to which this execution
will upload Tensorboard logs.
Format:
projects/{project}/locations/{location}/tensorboards/{tensorboard}
string tensorboard = 15 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String | The tensorboard. |
getTensorboardBytes()
public ByteString getTensorboardBytes() The name of a Vertex AI [Tensorboard] resource to which this execution
will upload Tensorboard logs.
Format:
projects/{project}/locations/{location}/tensorboards/{tensorboard}
string tensorboard = 15 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for tensorboard. |
getVertexAiParameters()
public ExecutionTemplate.VertexAIParameters getVertexAiParameters()Parameters used in Vertex AI JobType executions.
.google.cloud.notebooks.v1.ExecutionTemplate.VertexAIParameters vertex_ai_parameters = 13;
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.VertexAIParameters | The vertexAiParameters. |
getVertexAiParametersBuilder()
public ExecutionTemplate.VertexAIParameters.Builder getVertexAiParametersBuilder()Parameters used in Vertex AI JobType executions.
.google.cloud.notebooks.v1.ExecutionTemplate.VertexAIParameters vertex_ai_parameters = 13;
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.VertexAIParameters.Builder | |
getVertexAiParametersOrBuilder()
public ExecutionTemplate.VertexAIParametersOrBuilder getVertexAiParametersOrBuilder()Parameters used in Vertex AI JobType executions.
.google.cloud.notebooks.v1.ExecutionTemplate.VertexAIParameters vertex_ai_parameters = 13;
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.VertexAIParametersOrBuilder | |
hasAcceleratorConfig()
public boolean hasAcceleratorConfig()Configuration (count and accelerator type) for hardware running notebook execution.
.google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig accelerator_config = 3;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the acceleratorConfig field is set. |
hasDataprocParameters()
public boolean hasDataprocParameters()Parameters used in Dataproc JobType executions.
.google.cloud.notebooks.v1.ExecutionTemplate.DataprocParameters dataproc_parameters = 12;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the dataprocParameters field is set. |
hasVertexAiParameters()
public boolean hasVertexAiParameters()Parameters used in Vertex AI JobType executions.
.google.cloud.notebooks.v1.ExecutionTemplate.VertexAIParameters vertex_ai_parameters = 13;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the vertexAiParameters field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor | |
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeAcceleratorConfig(ExecutionTemplate.SchedulerAcceleratorConfig value)
public ExecutionTemplate.Builder mergeAcceleratorConfig(ExecutionTemplate.SchedulerAcceleratorConfig value)Configuration (count and accelerator type) for hardware running notebook execution.
.google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig accelerator_config = 3;
| Parameter | |
|---|---|
| Name | Description |
value | ExecutionTemplate.SchedulerAcceleratorConfig |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | |
mergeDataprocParameters(ExecutionTemplate.DataprocParameters value)
public ExecutionTemplate.Builder mergeDataprocParameters(ExecutionTemplate.DataprocParameters value)Parameters used in Dataproc JobType executions.
.google.cloud.notebooks.v1.ExecutionTemplate.DataprocParameters dataproc_parameters = 12;
| Parameter | |
|---|---|
| Name | Description |
value | ExecutionTemplate.DataprocParameters |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | |
mergeFrom(ExecutionTemplate other)
public ExecutionTemplate.Builder mergeFrom(ExecutionTemplate other)| Parameter | |
|---|---|
| Name | Description |
other | ExecutionTemplate |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ExecutionTemplate.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public ExecutionTemplate.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ExecutionTemplate.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | |
mergeVertexAiParameters(ExecutionTemplate.VertexAIParameters value)
public ExecutionTemplate.Builder mergeVertexAiParameters(ExecutionTemplate.VertexAIParameters value)Parameters used in Vertex AI JobType executions.
.google.cloud.notebooks.v1.ExecutionTemplate.VertexAIParameters vertex_ai_parameters = 13;
| Parameter | |
|---|---|
| Name | Description |
value | ExecutionTemplate.VertexAIParameters |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | |
putAllLabels(Map<String,String> values)
public ExecutionTemplate.Builder putAllLabels(Map<String,String> values)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.
map<string, string> labels = 4;
| Parameter | |
|---|---|
| Name | Description |
values | Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | |
putLabels(String key, String value)
public ExecutionTemplate.Builder putLabels(String key, String value)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.
map<string, string> labels = 4;
| Parameters | |
|---|---|
| Name | Description |
key | String |
value | String |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | |
removeLabels(String key)
public ExecutionTemplate.Builder removeLabels(String key)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.
map<string, string> labels = 4;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | |
setAcceleratorConfig(ExecutionTemplate.SchedulerAcceleratorConfig value)
public ExecutionTemplate.Builder setAcceleratorConfig(ExecutionTemplate.SchedulerAcceleratorConfig value)Configuration (count and accelerator type) for hardware running notebook execution.
.google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig accelerator_config = 3;
| Parameter | |
|---|---|
| Name | Description |
value | ExecutionTemplate.SchedulerAcceleratorConfig |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | |
setAcceleratorConfig(ExecutionTemplate.SchedulerAcceleratorConfig.Builder builderForValue)
public ExecutionTemplate.Builder setAcceleratorConfig(ExecutionTemplate.SchedulerAcceleratorConfig.Builder builderForValue)Configuration (count and accelerator type) for hardware running notebook execution.
.google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig accelerator_config = 3;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | ExecutionTemplate.SchedulerAcceleratorConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | |
setContainerImageUri(String value)
public ExecutionTemplate.Builder setContainerImageUri(String value)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
string container_image_uri = 6;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe containerImageUri to set. |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | This builder for chaining. |
setContainerImageUriBytes(ByteString value)
public ExecutionTemplate.Builder setContainerImageUriBytes(ByteString value)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
string container_image_uri = 6;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for containerImageUri to set. |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | This builder for chaining. |
setDataprocParameters(ExecutionTemplate.DataprocParameters value)
public ExecutionTemplate.Builder setDataprocParameters(ExecutionTemplate.DataprocParameters value)Parameters used in Dataproc JobType executions.
.google.cloud.notebooks.v1.ExecutionTemplate.DataprocParameters dataproc_parameters = 12;
| Parameter | |
|---|---|
| Name | Description |
value | ExecutionTemplate.DataprocParameters |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | |
setDataprocParameters(ExecutionTemplate.DataprocParameters.Builder builderForValue)
public ExecutionTemplate.Builder setDataprocParameters(ExecutionTemplate.DataprocParameters.Builder builderForValue)Parameters used in Dataproc JobType executions.
.google.cloud.notebooks.v1.ExecutionTemplate.DataprocParameters dataproc_parameters = 12;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | ExecutionTemplate.DataprocParameters.Builder |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public ExecutionTemplate.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | |
setInputNotebookFile(String value)
public ExecutionTemplate.Builder setInputNotebookFile(String value) 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
string input_notebook_file = 5;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe inputNotebookFile to set. |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | This builder for chaining. |
setInputNotebookFileBytes(ByteString value)
public ExecutionTemplate.Builder setInputNotebookFileBytes(ByteString value) 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
string input_notebook_file = 5;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for inputNotebookFile to set. |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | This builder for chaining. |
setJobType(ExecutionTemplate.JobType value)
public ExecutionTemplate.Builder setJobType(ExecutionTemplate.JobType value)The type of Job to be used on this execution.
.google.cloud.notebooks.v1.ExecutionTemplate.JobType job_type = 11;
| Parameter | |
|---|---|
| Name | Description |
value | ExecutionTemplate.JobTypeThe jobType to set. |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | This builder for chaining. |
setJobTypeValue(int value)
public ExecutionTemplate.Builder setJobTypeValue(int value)The type of Job to be used on this execution.
.google.cloud.notebooks.v1.ExecutionTemplate.JobType job_type = 11;
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for jobType to set. |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | This builder for chaining. |
setKernelSpec(String value)
public ExecutionTemplate.Builder setKernelSpec(String value)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.
string kernel_spec = 14;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe kernelSpec to set. |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | This builder for chaining. |
setKernelSpecBytes(ByteString value)
public ExecutionTemplate.Builder setKernelSpecBytes(ByteString value)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.
string kernel_spec = 14;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for kernelSpec to set. |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | This builder for chaining. |
setMasterType(String value)
public ExecutionTemplate.Builder setMasterType(String value) 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-4n1-standard-8n1-standard-16n1-standard-32n1-standard-64n1-standard-96n1-highmem-2n1-highmem-4n1-highmem-8n1-highmem-16n1-highmem-32n1-highmem-64n1-highmem-96n1-highcpu-16n1-highcpu-32n1-highcpu-64n1-highcpu-96
Alternatively, you can use the following legacy machine types:
standardlarge_modelcomplex_model_scomplex_model_mcomplex_model_lstandard_gpucomplex_model_m_gpucomplex_model_l_gpustandard_p100complex_model_m_p100standard_v100large_model_v100complex_model_m_v100complex_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.
string master_type = 2;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe masterType to set. |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | This builder for chaining. |
setMasterTypeBytes(ByteString value)
public ExecutionTemplate.Builder setMasterTypeBytes(ByteString value) 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-4n1-standard-8n1-standard-16n1-standard-32n1-standard-64n1-standard-96n1-highmem-2n1-highmem-4n1-highmem-8n1-highmem-16n1-highmem-32n1-highmem-64n1-highmem-96n1-highcpu-16n1-highcpu-32n1-highcpu-64n1-highcpu-96
Alternatively, you can use the following legacy machine types:
standardlarge_modelcomplex_model_scomplex_model_mcomplex_model_lstandard_gpucomplex_model_m_gpucomplex_model_l_gpustandard_p100complex_model_m_p100standard_v100large_model_v100complex_model_m_v100complex_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.
string master_type = 2;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for masterType to set. |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | This builder for chaining. |
setOutputNotebookFolder(String value)
public ExecutionTemplate.Builder setOutputNotebookFolder(String value) 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
string output_notebook_folder = 7;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe outputNotebookFolder to set. |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | This builder for chaining. |
setOutputNotebookFolderBytes(ByteString value)
public ExecutionTemplate.Builder setOutputNotebookFolderBytes(ByteString value) 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
string output_notebook_folder = 7;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for outputNotebookFolder to set. |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | This builder for chaining. |
setParameters(String value)
public ExecutionTemplate.Builder setParameters(String value)Parameters used within the 'input_notebook_file' notebook.
string parameters = 9;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe parameters to set. |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | This builder for chaining. |
setParametersBytes(ByteString value)
public ExecutionTemplate.Builder setParametersBytes(ByteString value)Parameters used within the 'input_notebook_file' notebook.
string parameters = 9;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for parameters to set. |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | This builder for chaining. |
setParamsYamlFile(String value)
public ExecutionTemplate.Builder setParamsYamlFile(String value) 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
string params_yaml_file = 8;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe paramsYamlFile to set. |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | This builder for chaining. |
setParamsYamlFileBytes(ByteString value)
public ExecutionTemplate.Builder setParamsYamlFileBytes(ByteString value) 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
string params_yaml_file = 8;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for paramsYamlFile to set. |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ExecutionTemplate.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | |
setScaleTier(ExecutionTemplate.ScaleTier value) (deprecated)
public ExecutionTemplate.Builder setScaleTier(ExecutionTemplate.ScaleTier value)Deprecated. google.cloud.notebooks.v1.ExecutionTemplate.scale_tier is deprecated. See google/cloud/notebooks/v1/execution.proto;l=151
Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
.google.cloud.notebooks.v1.ExecutionTemplate.ScaleTier scale_tier = 1 [deprecated = true, (.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value | ExecutionTemplate.ScaleTierThe scaleTier to set. |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | This builder for chaining. |
setScaleTierValue(int value) (deprecated)
public ExecutionTemplate.Builder setScaleTierValue(int value)Deprecated. google.cloud.notebooks.v1.ExecutionTemplate.scale_tier is deprecated. See google/cloud/notebooks/v1/execution.proto;l=151
Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
.google.cloud.notebooks.v1.ExecutionTemplate.ScaleTier scale_tier = 1 [deprecated = true, (.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for scaleTier to set. |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | This builder for chaining. |
setServiceAccount(String value)
public ExecutionTemplate.Builder setServiceAccount(String value) 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.
string service_account = 10;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe serviceAccount to set. |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | This builder for chaining. |
setServiceAccountBytes(ByteString value)
public ExecutionTemplate.Builder setServiceAccountBytes(ByteString value) 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.
string service_account = 10;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for serviceAccount to set. |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | This builder for chaining. |
setTensorboard(String value)
public ExecutionTemplate.Builder setTensorboard(String value) The name of a Vertex AI [Tensorboard] resource to which this execution
will upload Tensorboard logs.
Format:
projects/{project}/locations/{location}/tensorboards/{tensorboard}
string tensorboard = 15 [(.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value | StringThe tensorboard to set. |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | This builder for chaining. |
setTensorboardBytes(ByteString value)
public ExecutionTemplate.Builder setTensorboardBytes(ByteString value) The name of a Vertex AI [Tensorboard] resource to which this execution
will upload Tensorboard logs.
Format:
projects/{project}/locations/{location}/tensorboards/{tensorboard}
string tensorboard = 15 [(.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for tensorboard to set. |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final ExecutionTemplate.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | |
setVertexAiParameters(ExecutionTemplate.VertexAIParameters value)
public ExecutionTemplate.Builder setVertexAiParameters(ExecutionTemplate.VertexAIParameters value)Parameters used in Vertex AI JobType executions.
.google.cloud.notebooks.v1.ExecutionTemplate.VertexAIParameters vertex_ai_parameters = 13;
| Parameter | |
|---|---|
| Name | Description |
value | ExecutionTemplate.VertexAIParameters |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | |
setVertexAiParameters(ExecutionTemplate.VertexAIParameters.Builder builderForValue)
public ExecutionTemplate.Builder setVertexAiParameters(ExecutionTemplate.VertexAIParameters.Builder builderForValue)Parameters used in Vertex AI JobType executions.
.google.cloud.notebooks.v1.ExecutionTemplate.VertexAIParameters vertex_ai_parameters = 13;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | ExecutionTemplate.VertexAIParameters.Builder |
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | |