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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/ml_v1/classes.rb,
generated/google/apis/ml_v1/representations.rb,
generated/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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleCloudMlV1HyperparameterOutput

Returns a new instance of GoogleCloudMlV1HyperparameterOutput.



462
463
464
 
# File 'generated/google/apis/ml_v1/classes.rb', line 462

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

Instance Attribute Details

#all_metrics ⇒ Array<Google::Apis::MlV1::GoogleCloudMlV1HyperparameterOutputHyperparameterMetric>

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

Returns:



419
420
421
 
# File 'generated/google/apis/ml_v1/classes.rb', line 419

def all_metrics
  @all_metrics
end

#built_in_algorithm_output ⇒ Google::Apis::MlV1::GoogleCloudMlV1BuiltInAlgorithmOutput

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

Returns:



424
425
426
 
# File 'generated/google/apis/ml_v1/classes.rb', line 424

def built_in_algorithm_output
  @built_in_algorithm_output
end

#end_time ⇒ String

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

Returns:

  • (String) 


429
430
431
 
# File 'generated/google/apis/ml_v1/classes.rb', line 429

def end_time
  @end_time
end

#final_metric ⇒ Google::Apis::MlV1::GoogleCloudMlV1HyperparameterOutputHyperparameterMetric

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

Returns:



434
435
436
 
# File 'generated/google/apis/ml_v1/classes.rb', line 434

def final_metric
  @final_metric
end

#hyperparameters ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


439
440
441
 
# File 'generated/google/apis/ml_v1/classes.rb', line 439

def hyperparameters
  @hyperparameters
end

#is_trial_stopped_early ⇒ Boolean Also known as: is_trial_stopped_early?

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

Returns:

  • (Boolean) 


444
445
446
 
# File 'generated/google/apis/ml_v1/classes.rb', line 444

def is_trial_stopped_early
  @is_trial_stopped_early
end

#start_time ⇒ String

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

Returns:

  • (String) 


450
451
452
 
# File 'generated/google/apis/ml_v1/classes.rb', line 450

def start_time
  @start_time
end

#state ⇒ String

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

Returns:

  • (String) 


455
456
457
 
# File 'generated/google/apis/ml_v1/classes.rb', line 455

def state
  @state
end

#trial_id ⇒ String

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

Returns:

  • (String) 


460
461
462
 
# File 'generated/google/apis/ml_v1/classes.rb', line 460

def trial_id
  @trial_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



467
468
469
470
471
472
473
474
475
476
477
 
# File 'generated/google/apis/ml_v1/classes.rb', line 467

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)
end