Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Trial

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1beta1/classes.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1Trial

Returns a new instance of GoogleCloudAiplatformV1beta1Trial.



56014
56015
56016
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56014

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#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. Corresponds to the JSON property clientId

Returns:

  • (String) 


55944
55945
55946
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 55944

def client_id
  @client_id
end

#custom_job ⇒ String

Output only. The CustomJob name linked to the Trial. It's set for a HyperparameterTuningJob's Trial. Corresponds to the JSON property customJob

Returns:

  • (String) 


55950
55951
55952
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 55950

def custom_job
  @custom_job
end

#end_time ⇒ String

Output only. Time when the Trial's status changed to SUCCEEDED or INFEASIBLE. Corresponds to the JSON property endTime

Returns:

  • (String) 


55956
55957
55958
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 55956

def end_time
  @end_time
end

#final_measurement ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Measurement

A message representing a Measurement of a Trial. A Measurement contains the Metrics got by executing a Trial using suggested hyperparameter values. Corresponds to the JSON property finalMeasurement

Returns:



55962
55963
55964
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 55962

def final_measurement
  @final_measurement
end

#id ⇒ String

Output only. The identifier of the Trial assigned by the service. Corresponds to the JSON property id

Returns:

  • (String) 


55967
55968
55969
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 55967

def id
  @id
end

#infeasible_reason ⇒ String

Output only. A human readable string describing why the Trial is infeasible. This is set only if Trial state is INFEASIBLE. Corresponds to the JSON property infeasibleReason

Returns:

  • (String) 


55973
55974
55975
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 55973

def infeasible_reason
  @infeasible_reason
end

#measurements ⇒ Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Measurement>

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. Corresponds to the JSON property measurements

Returns:



55980
55981
55982
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 55980

def measurements
  @measurements
end

#name ⇒ String

Output only. Resource name of the Trial assigned by the service. Corresponds to the JSON property name

Returns:

  • (String) 


55985
55986
55987
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 55985

def name
  @name
end

#parameters ⇒ Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TrialParameter>

Output only. The parameters of the Trial. Corresponds to the JSON property parameters

Returns:



55990
55991
55992
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 55990

def parameters
  @parameters
end

#start_time ⇒ String

Output only. Time when the Trial was started. Corresponds to the JSON property startTime

Returns:

  • (String) 


55995
55996
55997
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 55995

def start_time
  @start_time
end

#state ⇒ String

Output only. The detailed state of the Trial. Corresponds to the JSON property state

Returns:

  • (String) 


56000
56001
56002
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56000

def state
  @state
end

#web_access_uris ⇒ Hash<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. Corresponds to the JSON property webAccessUris

Returns:

  • (Hash<String,String>) 


56012
56013
56014
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56012

def web_access_uris
  @web_access_uris
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



56019
56020
56021
56022
56023
56024
56025
56026
56027
56028
56029
56030
56031
56032
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 56019

def update!(**args)
  @client_id = args[:client_id] if args.key?(:client_id)
  @custom_job = args[:custom_job] if args.key?(:custom_job)
  @end_time = args[:end_time] if args.key?(:end_time)
  @final_measurement = args[:final_measurement] if args.key?(:final_measurement)
  @id = args[:id] if args.key?(:id)
  @infeasible_reason = args[:infeasible_reason] if args.key?(:infeasible_reason)
  @measurements = args[:measurements] if args.key?(:measurements)
  @name = args[:name] if args.key?(:name)
  @parameters = args[:parameters] if args.key?(:parameters)
  @start_time = args[:start_time] if args.key?(:start_time)
  @state = args[:state] if args.key?(:state)
  @web_access_uris = args[:web_access_uris] if args.key?(:web_access_uris)
end