class Google::Apis::MlV1::GoogleCloudMlV1HyperparameterOutput

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.

Attributes

all_metrics[RW]

All recorded object metrics for this trial. This field is not currently populated. Corresponds to the JSON property `allMetrics` @return [Array<Google::Apis::MlV1::GoogleCloudMlV1HyperparameterOutputHyperparameterMetric>]

built_in_algorithm_output[RW]

Represents output related to a built-in algorithm Job. Corresponds to the JSON property `builtInAlgorithmOutput` @return [Google::Apis::MlV1::GoogleCloudMlV1BuiltInAlgorithmOutput]

end_time[RW]

Output only. End time for the trial. Corresponds to the JSON property `endTime` @return [String]

final_metric[RW]

An observed value of a metric. Corresponds to the JSON property `finalMetric` @return [Google::Apis::MlV1::GoogleCloudMlV1HyperparameterOutputHyperparameterMetric]

hyperparameters[RW]

The hyperparameters given to this trial. Corresponds to the JSON property `hyperparameters` @return [Hash<String,String>]

is_trial_stopped_early[RW]

True if the trial is stopped early. Corresponds to the JSON property `isTrialStoppedEarly` @return [Boolean]

is_trial_stopped_early?[RW]

True if the trial is stopped early. Corresponds to the JSON property `isTrialStoppedEarly` @return [Boolean]

start_time[RW]

Output only. Start time for the trial. Corresponds to the JSON property `startTime` @return [String]

state[RW]

Output only. The detailed state of the trial. Corresponds to the JSON property `state` @return [String]

trial_id[RW]

The trial id for these results. Corresponds to the JSON property `trialId` @return [String]

web_access_uris[RW]

URIs for accessing [interactive shells](cloud.google.com/ai-platform/ training/docs/monitor-debug-interactive-shell) (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` @return [Hash<String,String>]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/ml_v1/classes.rb, line 1222
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# 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