libZSservicesZSamazonka-forecastZSamazonka-forecast
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Forecast.Types.IntegerParameterRange

Description

 
Synopsis

Documentation

data IntegerParameterRange Source #

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

See: newIntegerParameterRange smart constructor.

Constructors

IntegerParameterRange' 

Fields

  • scalingType :: Maybe ScalingType

    The scale that hyperparameter tuning uses to search the hyperparameter range. Valid 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 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.

    For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

  • name :: Text

    The name of the hyperparameter to tune.

  • maxValue :: Int

    The maximum tunable value of the hyperparameter.

  • minValue :: Int

    The minimum tunable value of the hyperparameter.

Instances

Instances details
Eq IntegerParameterRange Source # 
Instance details

Defined in Amazonka.Forecast.Types.IntegerParameterRange

Read IntegerParameterRange Source # 
Instance details

Defined in Amazonka.Forecast.Types.IntegerParameterRange

Show IntegerParameterRange Source # 
Instance details

Defined in Amazonka.Forecast.Types.IntegerParameterRange

Generic IntegerParameterRange Source # 
Instance details

Defined in Amazonka.Forecast.Types.IntegerParameterRange

Associated Types

type Rep IntegerParameterRange :: Type -> Type #

NFData IntegerParameterRange Source # 
Instance details

Defined in Amazonka.Forecast.Types.IntegerParameterRange

Methods

rnf :: IntegerParameterRange -> () #

Hashable IntegerParameterRange Source # 
Instance details

Defined in Amazonka.Forecast.Types.IntegerParameterRange

ToJSON IntegerParameterRange Source # 
Instance details

Defined in Amazonka.Forecast.Types.IntegerParameterRange

FromJSON IntegerParameterRange Source # 
Instance details

Defined in Amazonka.Forecast.Types.IntegerParameterRange

type Rep IntegerParameterRange Source # 
Instance details

Defined in Amazonka.Forecast.Types.IntegerParameterRange

type Rep IntegerParameterRange = D1 ('MetaData "IntegerParameterRange" "Amazonka.Forecast.Types.IntegerParameterRange" "libZSservicesZSamazonka-forecastZSamazonka-forecast" 'False) (C1 ('MetaCons "IntegerParameterRange'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "scalingType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ScalingType)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "maxValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "minValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newIntegerParameterRange Source #

Create a value of IntegerParameterRange with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:scalingType:IntegerParameterRange', integerParameterRange_scalingType - The scale that hyperparameter tuning uses to search the hyperparameter range. Valid 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 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.

For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

$sel:name:IntegerParameterRange', integerParameterRange_name - The name of the hyperparameter to tune.

$sel:maxValue:IntegerParameterRange', integerParameterRange_maxValue - The maximum tunable value of the hyperparameter.

$sel:minValue:IntegerParameterRange', integerParameterRange_minValue - The minimum tunable value of the hyperparameter.

integerParameterRange_scalingType :: Lens' IntegerParameterRange (Maybe ScalingType) Source #

The scale that hyperparameter tuning uses to search the hyperparameter range. Valid 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 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.

For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

integerParameterRange_name :: Lens' IntegerParameterRange Text Source #

The name of the hyperparameter to tune.

integerParameterRange_maxValue :: Lens' IntegerParameterRange Int Source #

The maximum tunable value of the hyperparameter.

integerParameterRange_minValue :: Lens' IntegerParameterRange Int Source #

The minimum tunable value of the hyperparameter.