Struct google_api_proto::google::cloud::aiplatform::v1::HyperparameterTuningJob

pub struct HyperparameterTuningJob {

    pub name: String,
    pub display_name: String,
    pub study_spec: Option<StudySpec>,
    pub max_trial_count: i32,
    pub parallel_trial_count: i32,
    pub max_failed_trial_count: i32,
    pub trial_job_spec: Option<CustomJobSpec>,
    pub trials: Vec<Trial>,
    pub state: i32,
    pub create_time: Option<Timestamp>,
    pub start_time: Option<Timestamp>,
    pub end_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub error: Option<Status>,
    pub labels: BTreeMap<String, String>,
    pub encryption_spec: Option<EncryptionSpec>,
}

Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a Study specification and multiple CustomJobs with identical CustomJob specification.

Fields

name: String

Output only. Resource name of the HyperparameterTuningJob.

display_name: String

Required. The display name of the HyperparameterTuningJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.

study_spec: Option<StudySpec>

Required. Study configuration of the HyperparameterTuningJob.

max_trial_count: i32

Required. The desired total number of Trials.

parallel_trial_count: i32

Required. The desired number of Trials to run in parallel.

max_failed_trial_count: i32

The number of failed Trials that need to be seen before failing the HyperparameterTuningJob.

If set to 0, Vertex AI decides how many Trials must fail before the whole job fails.

trial_job_spec: Option<CustomJobSpec>

Required. The spec of a trial job. The same spec applies to the CustomJobs created in all the trials.

trials: Vec<Trial>

Output only. Trials of the HyperparameterTuningJob.

state: i32

Output only. The detailed state of the job.

create_time: Option<Timestamp>

Output only. Time when the HyperparameterTuningJob was created.

start_time: Option<Timestamp>

Output only. Time when the HyperparameterTuningJob for the first time entered the JOB_STATE_RUNNING state.

end_time: Option<Timestamp>

Output only. Time when the HyperparameterTuningJob entered any of the following states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.

update_time: Option<Timestamp>

Output only. Time when the HyperparameterTuningJob was most recently updated.

error: Option<Status>

Output only. Only populated when job’s state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.

labels: BTreeMap<String, String>

The labels with user-defined metadata to organize HyperparameterTuningJobs.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

encryption_spec: Option<EncryptionSpec>

Customer-managed encryption key options for a HyperparameterTuningJob. If this is set, then all resources created by the HyperparameterTuningJob will be encrypted with the provided encryption key.

Implementations

impl HyperparameterTuningJob

pub fn state(&self) -> JobState

Returns the enum value of state, or the default if the field is set to an invalid enum value.

pub fn set_state(&mut self, value: JobState)

Sets state to the provided enum value.

Trait Implementations

impl Clone for HyperparameterTuningJob

fn clone(&self) -> HyperparameterTuningJob

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HyperparameterTuningJob

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

Formats the value using the given formatter.

impl Default for HyperparameterTuningJob

fn default() -> Self

Returns the “default value” for a type.

impl Message for HyperparameterTuningJob

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, Self: Sized,

Encodes the message to a buffer.

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

where Self: Sized,

Encodes the message to a newly allocated buffer.

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

where B: BufMut, Self: Sized,

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

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

where Self: Sized,

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

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

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

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

where B: Buf, Self: Default,

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

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

where B: Buf, Self: Sized,

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, Self: Sized,

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

impl PartialEq for HyperparameterTuningJob

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for HyperparameterTuningJob