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.



1076
1077
1078
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1076

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


1032
1033
1034
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1032

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


1041
1042
1043
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1041

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) 


1048
1049
1050
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1048

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) 


1055
1056
1057
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1055

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) 


1061
1062
1063
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1061

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) 


1069
1070
1071
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1069

def scale_type
  @scale_type
end

#type ⇒ String

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

Returns:

  • (String) 


1074
1075
1076
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1074

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1081
1082
1083
1084
1085
1086
1087
1088
1089
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1081

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