You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ForecastService::Types::IntegerParameterRange

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb

Overview

Note:

When making an API call, you may pass IntegerParameterRange data as a hash:

{
  name: "Name", # required
  max_value: 1, # required
  min_value: 1, # required
  scaling_type: "Auto", # accepts Auto, Linear, Logarithmic, ReverseLogarithmic
}

Specifies an integer hyperparameter and it's range of tunable values. This object is part of the ParameterRanges object.

Instance Attribute Summary collapse

Instance Attribute Details

#max_valueInteger

The maximum tunable value of the hyperparameter.

Returns:

  • (Integer)


2117
2118
2119
2120
2121
2122
2123
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2117

class IntegerParameterRange < Struct.new(
  :name,
  :max_value,
  :min_value,
  :scaling_type)
  include Aws::Structure
end

#min_valueInteger

The minimum tunable value of the hyperparameter.

Returns:

  • (Integer)


2117
2118
2119
2120
2121
2122
2123
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2117

class IntegerParameterRange < Struct.new(
  :name,
  :max_value,
  :min_value,
  :scaling_type)
  include Aws::Structure
end

#nameString

The name of the hyperparameter to tune.

Returns:

  • (String)


2117
2118
2119
2120
2121
2122
2123
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2117

class IntegerParameterRange < Struct.new(
  :name,
  :max_value,
  :min_value,
  :scaling_type)
  include Aws::Structure
end

#scaling_typeString

The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

Auto

Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.

Linear

Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

Logarithmic

Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

Logarithmic scaling works only for ranges that have only values greater than 0.

ReverseLogarithmic

Not supported for IntegerParameterRange.

Reverse logarithmic scaling works only for ranges that are entirely within the range 0 <= x < 1.0.

Returns:

  • (String)


2117
2118
2119
2120
2121
2122
2123
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2117

class IntegerParameterRange < Struct.new(
  :name,
  :max_value,
  :min_value,
  :scaling_type)
  include Aws::Structure
end