Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::Trial (v0.28.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::Trial.

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.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#client_id

def client_id() -> ::String

Returns

(::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.

#custom_job

def custom_job() -> ::String

Returns

(::String) — Output only. The CustomJob name linked to the Trial. It's set for a HyperparameterTuningJob's Trial.

#end_time

def end_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Time when the Trial's status changed to SUCCEEDED or INFEASIBLE.

#final_measurement

def final_measurement() -> ::Google::Cloud::AIPlatform::V1::Measurement

Returns

(::Google::Cloud::AIPlatform::V1::Measurement) — Output only. The final measurement containing the objective value.

#id

def id() -> ::String

Returns

(::String) — Output only. The identifier of the Trial assigned by the service.

#infeasible_reason

def infeasible_reason() -> ::String

Returns

(::String) — Output only. A human readable string describing why the Trial is infeasible. This is set only if Trial state is INFEASIBLE.

#measurements

def measurements() -> ::Array<::Google::Cloud::AIPlatform::V1::Measurement>

Returns

(::Array<::Google::Cloud::AIPlatform::V1::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.

#name

def name() -> ::String

Returns

(::String) — Output only. Resource name of the Trial assigned by the service.

#parameters

def parameters() -> ::Array<::Google::Cloud::AIPlatform::V1::Trial::Parameter>

Returns

(::Array<::Google::Cloud::AIPlatform::V1::Trial::Parameter>) — Output only. The parameters of the Trial.

#start_time

def start_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Time when the Trial was started.

#state

def state() -> ::Google::Cloud::AIPlatform::V1::Trial::State

Returns

(::Google::Cloud::AIPlatform::V1::Trial::State) — Output only. The detailed state of the Trial.

#web_access_uris

def web_access_uris() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::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 and the job's trial_job_spec.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.