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.



1028
1029
1030
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1028

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:



985
986
987
 
# File 'generated/google/apis/ml_v1/classes.rb', line 985

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:



990
991
992
 
# File 'generated/google/apis/ml_v1/classes.rb', line 990

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) 


995
996
997
 
# File 'generated/google/apis/ml_v1/classes.rb', line 995

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:



1000
1001
1002
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1000

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


1005
1006
1007
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1005

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) 


1010
1011
1012
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1010

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) 


1016
1017
1018
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1016

def start_time
  @start_time
end

#state ⇒ String

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

Returns:

  • (String) 


1021
1022
1023
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1021

def state
  @state
end

#trial_id ⇒ String

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

Returns:

  • (String) 


1026
1027
1028
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1026

def trial_id
  @trial_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1033

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