Class: Google::Apis::MlV1::GoogleCloudMlV1ParameterSpec

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 a single hyperparameter 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) ⇒ GoogleCloudMlV1ParameterSpec

Returns a new instance of GoogleCloudMlV1ParameterSpec



742
743
744
 
# File 'generated/google/apis/ml_v1/classes.rb', line 742

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

Instance Attribute Details

#categorical_values ⇒ Array<String>

Required if type is CATEGORICAL. The list of possible categories. Corresponds to the JSON property categoricalValues

Returns:

  • (Array<String>) 


698
699
700
 
# File 'generated/google/apis/ml_v1/classes.rb', line 698

def categorical_values
  @categorical_values
end

#discrete_values ⇒ Array<Float>

Required if type is DISCRETE. A list of feasible points. The list should be in strictly increasing order. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values. Corresponds to the JSON property discreteValues

Returns:

  • (Array<Float>) 


707
708
709
 
# File 'generated/google/apis/ml_v1/classes.rb', line 707

def discrete_values
  @discrete_values
end

#max_value ⇒ Float

Required if typeis DOUBLE or INTEGER. This field should be unset if type is CATEGORICAL. This value should be integers if type is INTEGER. Corresponds to the JSON property maxValue

Returns:

  • (Float) 


714
715
716
 
# File 'generated/google/apis/ml_v1/classes.rb', line 714

def max_value
  @max_value
end

#min_value ⇒ Float

Required if type is DOUBLE or INTEGER. This field should be unset if type is CATEGORICAL. This value should be integers if type is INTEGER. Corresponds to the JSON property minValue

Returns:

  • (Float) 


721
722
723
 
# File 'generated/google/apis/ml_v1/classes.rb', line 721

def min_value
  @min_value
end

#parameter_name ⇒ String

Required. The parameter name must be unique amongst all ParameterConfigs in a HyperparameterSpec message. E.g., "learning_rate". Corresponds to the JSON property parameterName

Returns:

  • (String) 


727
728
729
 
# File 'generated/google/apis/ml_v1/classes.rb', line 727

def parameter_name
  @parameter_name
end

#scale_type ⇒ String

Optional. How the parameter should be scaled to the hypercube. Leave unset for categorical parameters. Some kind of scaling is strongly recommended for real or integral parameters (e.g., UNIT_LINEAR_SCALE). Corresponds to the JSON property scaleType

Returns:

  • (String) 


735
736
737
 
# File 'generated/google/apis/ml_v1/classes.rb', line 735

def scale_type
  @scale_type
end

#type ⇒ String

Required. The type of the parameter. Corresponds to the JSON property type

Returns:

  • (String) 


740
741
742
 
# File 'generated/google/apis/ml_v1/classes.rb', line 740

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



747
748
749
750
751
752
753
754
755
 
# File 'generated/google/apis/ml_v1/classes.rb', line 747

def update!(**args)
  @categorical_values = args[:categorical_values] if args.key?(:categorical_values)
  @discrete_values = args[:discrete_values] if args.key?(:discrete_values)
  @max_value = args[:max_value] if args.key?(:max_value)
  @min_value = args[:min_value] if args.key?(:min_value)
  @parameter_name = args[:parameter_name] if args.key?(:parameter_name)
  @scale_type = args[:scale_type] if args.key?(:scale_type)
  @type = args[:type] if args.key?(:type)
end