- 1.63.0 (latest)
- 1.62.0
- 1.60.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.1
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.39.0
- 1.38.1
- 1.37.0
- 1.36.4
- 1.35.0
- 1.34.0
- 1.33.1
- 1.32.0
- 1.31.1
- 1.30.1
- 1.29.0
- 1.28.1
- 1.27.1
- 1.26.1
- 1.25.0
- 1.24.1
- 1.23.0
- 1.22.1
- 1.21.0
- 1.20.0
- 1.19.1
- 1.18.3
- 1.17.1
- 1.16.1
- 1.15.1
- 1.14.0
- 1.13.1
- 1.12.1
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.1
- 1.7.1
- 1.6.2
- 1.5.0
- 1.4.3
- 1.3.0
- 1.2.0
- 1.1.1
- 1.0.1
- 0.9.0
- 0.8.0
- 0.7.1
- 0.6.0
- 0.5.1
- 0.4.0
- 0.3.1
CustomJobSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents the spec of a CustomJob.
Attributes
Name | Description |
worker_pool_specs |
MutableSequence[google.cloud.aiplatform_v1.types.WorkerPoolSpec]
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. |
scheduling |
google.cloud.aiplatform_v1.types.Scheduling
Scheduling options for a CustomJob. |
service_account |
str
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 |
network |
str
Optional. 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 |
reserved_ip_ranges |
MutableSequence[str]
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']. |
base_output_directory |
google.cloud.aiplatform_v1.types.GcsDestination
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 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 =
- AIP_CHECKPOINT_DIR =
- AIP_TENSORBOARD_LOG_DIR =
For CustomJob backing a Trial of HyperparameterTuningJob:
- AIP_MODEL_DIR =
- AIP_CHECKPOINT_DIR =
- AIP_TENSORBOARD_LOG_DIR =
|
tensorboard |
str
Optional. The name of a Vertex AI Tensorboard resource to which this CustomJob will upload Tensorboard logs. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}
|
enable_web_access |
bool
Optional. Whether you want Vertex AI to enable `interactive shell access |
enable_dashboard_access |
bool
Optional. Whether you want Vertex AI to enable access to the customized dashboard in training chief container. If set to true , you can access the dashboard at the URIs
given by
CustomJob.web_access_uris
or
Trial.web_access_uris
(within
HyperparameterTuningJob.trials).
|