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



964
965
966
# File 'generated/google/apis/ml_v1/classes.rb', line 964

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

Instance Attribute Details

#categorical_valuesArray<String>

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

Returns:

  • (Array<String>)


920
921
922
# File 'generated/google/apis/ml_v1/classes.rb', line 920

def categorical_values
  @categorical_values
end

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


929
930
931
# File 'generated/google/apis/ml_v1/classes.rb', line 929

def discrete_values
  @discrete_values
end

#max_valueFloat

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)


936
937
938
# File 'generated/google/apis/ml_v1/classes.rb', line 936

def max_value
  @max_value
end

#min_valueFloat

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)


943
944
945
# File 'generated/google/apis/ml_v1/classes.rb', line 943

def min_value
  @min_value
end

#parameter_nameString

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)


949
950
951
# File 'generated/google/apis/ml_v1/classes.rb', line 949

def parameter_name
  @parameter_name
end

#scale_typeString

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)


957
958
959
# File 'generated/google/apis/ml_v1/classes.rb', line 957

def scale_type
  @scale_type
end

#typeString

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

Returns:

  • (String)


962
963
964
# File 'generated/google/apis/ml_v1/classes.rb', line 962

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



969
970
971
972
973
974
975
976
977
# File 'generated/google/apis/ml_v1/classes.rb', line 969

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