Struct google_api_proto::google::cloud::aiplatform::v1::Trial

pub struct Trial {
    pub name: String,
    pub id: String,
    pub state: i32,
    pub parameters: Vec<Parameter>,
    pub final_measurement: Option<Measurement>,
    pub measurements: Vec<Measurement>,
    pub start_time: Option<Timestamp>,
    pub end_time: Option<Timestamp>,
    pub client_id: String,
    pub infeasible_reason: String,
    pub custom_job: String,
    pub web_access_uris: BTreeMap<String, String>,
}

A message representing a Trial. A Trial contains a unique set of Parameters that has been or will be evaluated, along with the objective metrics got by running the Trial.

Fields

name: String

Output only. Resource name of the Trial assigned by the service.

id: String

Output only. The identifier of the Trial assigned by the service.

state: i32

Output only. The detailed state of the Trial.

parameters: Vec<Parameter>

Output only. The parameters of the Trial.

final_measurement: Option<Measurement>

Output only. The final measurement containing the objective value.

measurements: Vec<Measurement>

Output only. A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_duration). These are used for early stopping computations.

start_time: Option<Timestamp>

Output only. Time when the Trial was started.

end_time: Option<Timestamp>

Output only. Time when the Trial’s status changed to SUCCEEDED or INFEASIBLE.

client_id: String

Output only. The identifier of the client that originally requested this Trial. Each client is identified by a unique client_id. When a client asks for a suggestion, Vertex AI Vizier will assign it a Trial. The client should evaluate the Trial, complete it, and report back to Vertex AI Vizier. If suggestion is asked again by same client_id before the Trial is completed, the same Trial will be returned. Multiple clients with different client_ids can ask for suggestions simultaneously, each of them will get their own Trial.

infeasible_reason: String

Output only. A human readable string describing why the Trial is infeasible. This is set only if Trial state is INFEASIBLE.

custom_job: String

Output only. The CustomJob name linked to the Trial. It’s set for a HyperparameterTuningJob’s Trial.

web_access_uris: BTreeMap<String, String>

Output only. URIs for accessing interactive shells (one URI for each training node). Only available if this trial is part of a [HyperparameterTuningJob][google.cloud.aiplatform.v1.HyperparameterTuningJob] and the job’s [trial_job_spec.enable_web_access][google.cloud.aiplatform.v1.CustomJobSpec.enable_web_access] field is true.

The keys are names of each node used for the trial; for example, workerpool0-0 for the primary node, workerpool1-0 for the first node in the second worker pool, and workerpool1-1 for the second node in the second worker pool.

The values are the URIs for each node’s interactive shell.

Implementations

impl Trial

pub fn state(&self) -> State

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: State)

Sets state to the provided enum value.

Trait Implementations

impl Clone for Trial

fn clone(&self) -> Trial

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Trial

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

Formats the value using the given formatter.

impl Default for Trial

fn default() -> Self

Returns the “default value” for a type.

impl Message for Trial

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 Trial

fn eq(&self, other: &Trial) -> 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 Trial