Class: Google::Apis::MlV1::GoogleCloudMlV1HyperparameterOutput

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

Overview

Represents the result of a single hyperparameter tuning trial from a training job. The TrainingOutput object that is returned on successful completion of a training job with hyperparameter tuning includes a list of HyperparameterOutput objects, one for each successful trial.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudMlV1HyperparameterOutput

Returns a new instance of GoogleCloudMlV1HyperparameterOutput.



1222
1223
1224
# File 'lib/google/apis/ml_v1/classes.rb', line 1222

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

Instance Attribute Details

#all_metricsArray<Google::Apis::MlV1::GoogleCloudMlV1HyperparameterOutputHyperparameterMetric>

All recorded object metrics for this trial. This field is not currently populated. Corresponds to the JSON property allMetrics



1168
1169
1170
# File 'lib/google/apis/ml_v1/classes.rb', line 1168

def all_metrics
  @all_metrics
end

#built_in_algorithm_outputGoogle::Apis::MlV1::GoogleCloudMlV1BuiltInAlgorithmOutput

Represents output related to a built-in algorithm Job. Corresponds to the JSON property builtInAlgorithmOutput



1173
1174
1175
# File 'lib/google/apis/ml_v1/classes.rb', line 1173

def built_in_algorithm_output
  @built_in_algorithm_output
end

#end_timeString

Output only. End time for the trial. Corresponds to the JSON property endTime

Returns:

  • (String)


1178
1179
1180
# File 'lib/google/apis/ml_v1/classes.rb', line 1178

def end_time
  @end_time
end

#final_metricGoogle::Apis::MlV1::GoogleCloudMlV1HyperparameterOutputHyperparameterMetric

An observed value of a metric. Corresponds to the JSON property finalMetric



1183
1184
1185
# File 'lib/google/apis/ml_v1/classes.rb', line 1183

def final_metric
  @final_metric
end

#hyperparametersHash<String,String>

The hyperparameters given to this trial. Corresponds to the JSON property hyperparameters

Returns:

  • (Hash<String,String>)


1188
1189
1190
# File 'lib/google/apis/ml_v1/classes.rb', line 1188

def hyperparameters
  @hyperparameters
end

#is_trial_stopped_earlyBoolean Also known as: is_trial_stopped_early?

True if the trial is stopped early. Corresponds to the JSON property isTrialStoppedEarly

Returns:

  • (Boolean)


1193
1194
1195
# File 'lib/google/apis/ml_v1/classes.rb', line 1193

def is_trial_stopped_early
  @is_trial_stopped_early
end

#start_timeString

Output only. Start time for the trial. Corresponds to the JSON property startTime

Returns:

  • (String)


1199
1200
1201
# File 'lib/google/apis/ml_v1/classes.rb', line 1199

def start_time
  @start_time
end

#stateString

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

Returns:

  • (String)


1204
1205
1206
# File 'lib/google/apis/ml_v1/classes.rb', line 1204

def state
  @state
end

#trial_idString

The trial id for these results. Corresponds to the JSON property trialId

Returns:

  • (String)


1209
1210
1211
# File 'lib/google/apis/ml_v1/classes.rb', line 1209

def trial_id
  @trial_id
end

#web_access_urisHash<String,String>

URIs for accessing interactive shells (one URI for each training node) . Only available if this trial is part of a hyperparameter tuning job and the job's training_input.enable_web_access is true. The keys are names of each node in the training job; for example, master-replica-0 for the master node, worker-replica-0 for the first worker, and ps-replica-0 for the first parameter server. The values are the URIs for each node's interactive shell. Corresponds to the JSON property webAccessUris

Returns:

  • (Hash<String,String>)


1220
1221
1222
# File 'lib/google/apis/ml_v1/classes.rb', line 1220

def web_access_uris
  @web_access_uris
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
# File 'lib/google/apis/ml_v1/classes.rb', line 1227

def update!(**args)
  @all_metrics = args[:all_metrics] if args.key?(:all_metrics)
  @built_in_algorithm_output = args[:built_in_algorithm_output] if args.key?(:built_in_algorithm_output)
  @end_time = args[:end_time] if args.key?(:end_time)
  @final_metric = args[:final_metric] if args.key?(:final_metric)
  @hyperparameters = args[:hyperparameters] if args.key?(:hyperparameters)
  @is_trial_stopped_early = args[:is_trial_stopped_early] if args.key?(:is_trial_stopped_early)
  @start_time = args[:start_time] if args.key?(:start_time)
  @state = args[:state] if args.key?(:state)
  @trial_id = args[:trial_id] if args.key?(:trial_id)
  @web_access_uris = args[:web_access_uris] if args.key?(:web_access_uris)
end