- 3.10.0 (latest)
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.0
- 3.3.0
- 3.2.0
- 3.1.0
- 3.0.0
- 2.28.0
- 2.27.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.0
- 2.2.0
- 2.1.0
- 2.0.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
public sealed class CustomJobSpec : IMessage<CustomJobSpec>, IEquatable<CustomJobSpec>, IDeepCloneable<CustomJobSpec>, IBufferMessage, IMessage
Represents the spec of a CustomJob. Next Id: 14
Implements
IMessage<CustomJobSpec>, IEquatable<CustomJobSpec>, IDeepCloneable<CustomJobSpec>, IBufferMessage, IMessageNamespace
Google.Cloud.AIPlatform.V1Assembly
Google.Cloud.AIPlatform.V1.dll
Constructors
CustomJobSpec()
public CustomJobSpec()
CustomJobSpec(CustomJobSpec)
public CustomJobSpec(CustomJobSpec other)
Parameter | |
---|---|
Name | Description |
other | CustomJobSpec |
Properties
BaseOutputDirectory
public GcsDestination BaseOutputDirectory { get; set; }
The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob. For HyperparameterTuningJob, the baseOutputDirectory of each child CustomJob backing a Trial is set to a subdirectory of name [id][google.cloud.aiplatform.v1.Trial.id] under its parent HyperparameterTuningJob's baseOutputDirectory.
The following Vertex AI environment variables will be passed to containers or python modules when this field is set:
For CustomJob:
- AIP_MODEL_DIR =
<base_output_directory>/model/
- AIP_CHECKPOINT_DIR =
<base_output_directory>/checkpoints/
- AIP_TENSORBOARD_LOG_DIR =
<base_output_directory>/logs/
For CustomJob backing a Trial of HyperparameterTuningJob:
- AIP_MODEL_DIR =
<base_output_directory>/<trial_id>/model/
- AIP_CHECKPOINT_DIR =
<base_output_directory>/<trial_id>/checkpoints/
- AIP_TENSORBOARD_LOG_DIR =
<base_output_directory>/<trial_id>/logs/
Property Value | |
---|---|
Type | Description |
GcsDestination |
EnableWebAccess
public bool EnableWebAccess { get; set; }
Optional. Whether you want Vertex AI to enable interactive shell access to training containers.
If set to true
, you can access interactive shells at the URIs given
by [CustomJob.web_access_uris][google.cloud.aiplatform.v1.CustomJob.web_access_uris] or [Trial.web_access_uris][google.cloud.aiplatform.v1.Trial.web_access_uris] (within
[HyperparameterTuningJob.trials][google.cloud.aiplatform.v1.HyperparameterTuningJob.trials]).
Property Value | |
---|---|
Type | Description |
Boolean |
Network
public string Network { get; set; }
The full name of the Compute Engine
network to which the Job
should be peered. For example, projects/12345/global/networks/myVPC
.
Format
is of the form projects/{project}/global/networks/{network}
.
Where {project} is a project number, as in 12345
, and {network} is a
network name.
To specify this field, you must have already configured VPC Network Peering for Vertex AI.
If this field is left unspecified, the job is not peered with any network.
Property Value | |
---|---|
Type | Description |
String |
NetworkAsNetworkName
public NetworkName NetworkAsNetworkName { get; set; }
NetworkName-typed view over the Network resource name property.
Property Value | |
---|---|
Type | Description |
NetworkName |
ReservedIpRanges
public RepeatedField<string> ReservedIpRanges { get; }
Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job.
If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network.
Example: ['vertex-ai-ip-range'].
Property Value | |
---|---|
Type | Description |
RepeatedField<String> |
Scheduling
public Scheduling Scheduling { get; set; }
Scheduling options for a CustomJob.
Property Value | |
---|---|
Type | Description |
Scheduling |
ServiceAccount
public string ServiceAccount { get; set; }
Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the Vertex AI Custom Code Service Agent for the CustomJob's project is used.
Property Value | |
---|---|
Type | Description |
String |
Tensorboard
public string Tensorboard { get; set; }
Optional. The name of a Vertex AI [Tensorboard][google.cloud.aiplatform.v1.Tensorboard] resource to which this CustomJob
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 |
WorkerPoolSpecs
public RepeatedField<WorkerPoolSpec> WorkerPoolSpecs { get; }
Required. The spec of the worker pools including machine type and Docker image. All worker pools except the first one are optional and can be skipped by providing an empty value.
Property Value | |
---|---|
Type | Description |
RepeatedField<WorkerPoolSpec> |