Class: Google::Apis::MlV1beta1::GoogleCloudMlV1beta1HyperparameterSpec

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

Overview

Represents a set of hyperparameters to optimize.

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

Returns a new instance of GoogleCloudMlV1beta1HyperparameterSpec



488
489
490
 
# File 'generated/google/apis/ml_v1beta1/classes.rb', line 488

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

Instance Attribute Details

#goal ⇒ String

Required. The type of goal to use for tuning. Available types are MAXIMIZE and MINIMIZE. Defaults to MAXIMIZE. Corresponds to the JSON property goal

Returns:

  • (String) 


453
454
455
 
# File 'generated/google/apis/ml_v1beta1/classes.rb', line 453

def goal
  @goal
end

#hyperparameter_metric_tag ⇒ String

Optional. The Tensorflow summary tag name to use for optimizing trials. For current versions of Tensorflow, this tag name should exactly match what is shown in Tensorboard, including all scopes. For versions of Tensorflow prior to 0.12, this should be only the tag passed to tf.Summary. By default, "training/hptuning/metric" will be used. Corresponds to the JSON property hyperparameterMetricTag

Returns:

  • (String) 


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

def hyperparameter_metric_tag
  @hyperparameter_metric_tag
end

#max_parallel_trials ⇒ Fixnum

Optional. The number of training trials to run concurrently. You can reduce the time it takes to perform hyperparameter tuning by adding trials in parallel. However, each trail only benefits from the information gained in completed trials. That means that a trial does not get access to the results of trials running at the same time, which could reduce the quality of the overall optimization. Each trial will use the same scale tier and machine types. Defaults to one. Corresponds to the JSON property maxParallelTrials

Returns:

  • (Fixnum) 


474
475
476
 
# File 'generated/google/apis/ml_v1beta1/classes.rb', line 474

def max_parallel_trials
  @max_parallel_trials
end

#max_trials ⇒ Fixnum

Optional. How many training trials should be attempted to optimize the specified hyperparameters. Defaults to one. Corresponds to the JSON property maxTrials

Returns:

  • (Fixnum) 


481
482
483
 
# File 'generated/google/apis/ml_v1beta1/classes.rb', line 481

def max_trials
  @max_trials
end

#params ⇒ Array<Google::Apis::MlV1beta1::GoogleCloudMlV1beta1ParameterSpec>

Required. The set of parameters to tune. Corresponds to the JSON property params

Returns:



486
487
488
 
# File 'generated/google/apis/ml_v1beta1/classes.rb', line 486

def params
  @params
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



493
494
495
496
497
498
499
 
# File 'generated/google/apis/ml_v1beta1/classes.rb', line 493

def update!(**args)
  @goal = args[:goal] if args.key?(:goal)
  @hyperparameter_metric_tag = args[:hyperparameter_metric_tag] if args.key?(:hyperparameter_metric_tag)
  @max_parallel_trials = args[:max_parallel_trials] if args.key?(:max_parallel_trials)
  @max_trials = args[:max_trials] if args.key?(:max_trials)
  @params = args[:params] if args.key?(:params)
end