Struct googapis::google::cloud::aiplatform::v1beta1::CustomJobSpec

pub struct CustomJobSpec {
    pub worker_pool_specs: Vec<WorkerPoolSpec>,
    pub scheduling: Option<Scheduling>,
    pub service_account: String,
    pub network: String,
    pub base_output_directory: Option<GcsDestination>,
    pub tensorboard: String,
    pub enable_web_access: bool,
}

Represents the spec of a CustomJob.

Fields

worker_pool_specs: Vec<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: Option<Scheduling>

Scheduling options for a CustomJob.

service_account: String

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.

network: String

The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, projects/12345/global/networks/myVPC. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is a network name.

Private services access must already be configured for the network. If left unspecified, the job is not peered with any network.

base_output_directory: Option<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][google.cloud.aiplatform.v1beta1.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/

tensorboard: String

Optional. The name of a Vertex AI [Tensorboard][google.cloud.aiplatform.v1beta1.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 to training containers.

If set to true, you can access interactive shells at the URIs given by [CustomJob.web_access_uris][google.cloud.aiplatform.v1beta1.CustomJob.web_access_uris] or [Trial.web_access_uris][google.cloud.aiplatform.v1beta1.Trial.web_access_uris] (within [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.trials]).

Trait Implementations

impl Clone for CustomJobSpec

fn clone(&self) -> CustomJobSpec

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CustomJobSpec

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CustomJobSpec

fn default() -> Self

Returns the “default value” for a type.

impl Message for CustomJobSpec

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8, Global>

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8, Global>

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<CustomJobSpec> for CustomJobSpec

fn eq(&self, other: &CustomJobSpec) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CustomJobSpec) -> bool

This method tests for !=.

impl StructuralPartialEq for CustomJobSpec