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

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

Overview

Represents a single hyperparameter to optimize.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudMlV1ParameterSpec

Returns a new instance of GoogleCloudMlV1ParameterSpec.



1955
1956
1957
 
# File 'lib/google/apis/ml_v1/classes.rb', line 1955

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


1915
1916
1917
 
# File 'lib/google/apis/ml_v1/classes.rb', line 1915

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


1923
1924
1925
 
# File 'lib/google/apis/ml_v1/classes.rb', line 1923

def discrete_values
  @discrete_values
end

#max_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 maxValue

Returns:

  • (Float) 


1929
1930
1931
 
# File 'lib/google/apis/ml_v1/classes.rb', line 1929

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) 


1935
1936
1937
 
# File 'lib/google/apis/ml_v1/classes.rb', line 1935

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) 


1941
1942
1943
 
# File 'lib/google/apis/ml_v1/classes.rb', line 1941

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) 


1948
1949
1950
 
# File 'lib/google/apis/ml_v1/classes.rb', line 1948

def scale_type
  @scale_type
end

#type ⇒ String

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

Returns:

  • (String) 


1953
1954
1955
 
# File 'lib/google/apis/ml_v1/classes.rb', line 1953

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1960
1961
1962
1963
1964
1965
1966
1967
1968
 
# File 'lib/google/apis/ml_v1/classes.rb', line 1960

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