com.amazonaws.services.forecast.model

Class IntegerParameterRange

java.lang.Object

com.amazonaws.services.forecast.model.IntegerParameterRange

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class IntegerParameterRange
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
IntegerParameterRange()

Method Summary

Modifier and Type	Method and Description
IntegerParameterRange	clone()
boolean	equals(Object obj)
Integer	getMaxValue() The maximum tunable value of the hyperparameter.
Integer	getMinValue() The minimum tunable value of the hyperparameter.
String	getName() The name of the hyperparameter to tune.
String	getScalingType() The scale that hyperparameter tuning uses to search the hyperparameter range.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setMaxValue(Integer maxValue) The maximum tunable value of the hyperparameter.
void	setMinValue(Integer minValue) The minimum tunable value of the hyperparameter.
void	setName(String name) The name of the hyperparameter to tune.
void	setScalingType(String scalingType) The scale that hyperparameter tuning uses to search the hyperparameter range.
String	toString() Returns a string representation of this object.
IntegerParameterRange	withMaxValue(Integer maxValue) The maximum tunable value of the hyperparameter.
IntegerParameterRange	withMinValue(Integer minValue) The minimum tunable value of the hyperparameter.
IntegerParameterRange	withName(String name) The name of the hyperparameter to tune.
IntegerParameterRange	withScalingType(ScalingType scalingType) The scale that hyperparameter tuning uses to search the hyperparameter range.
IntegerParameterRange	withScalingType(String scalingType) The scale that hyperparameter tuning uses to search the hyperparameter range.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IntegerParameterRange

public IntegerParameterRange()

Method Detail

setName

public void setName(String name)

The name of the hyperparameter to tune.

Parameters:

name - The name of the hyperparameter to tune.

getName

public String getName()

The name of the hyperparameter to tune.

Returns:

The name of the hyperparameter to tune.

withName

public IntegerParameterRange withName(String name)

The name of the hyperparameter to tune.

Parameters:

name - The name of the hyperparameter to tune.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMaxValue

public void setMaxValue(Integer maxValue)

The maximum tunable value of the hyperparameter.

Parameters:

maxValue - The maximum tunable value of the hyperparameter.

getMaxValue

public Integer getMaxValue()

The maximum tunable value of the hyperparameter.

Returns:

The maximum tunable value of the hyperparameter.

withMaxValue

public IntegerParameterRange withMaxValue(Integer maxValue)

The maximum tunable value of the hyperparameter.

Parameters:

maxValue - The maximum tunable value of the hyperparameter.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMinValue

public void setMinValue(Integer minValue)

The minimum tunable value of the hyperparameter.

Parameters:

minValue - The minimum tunable value of the hyperparameter.

getMinValue

public Integer getMinValue()

The minimum tunable value of the hyperparameter.

Returns:

The minimum tunable value of the hyperparameter.

withMinValue

public IntegerParameterRange withMinValue(Integer minValue)

The minimum tunable value of the hyperparameter.

Parameters:

minValue - The minimum tunable value of the hyperparameter.

Returns:

Returns a reference to this object so that method calls can be chained together.

setScalingType

public void setScalingType(String 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:

Parameters:

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:

See Also:

ScalingType

getScalingType

public String getScalingType()

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:

Returns:

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:

See Also:

ScalingType

withScalingType

public IntegerParameterRange withScalingType(String 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:

Parameters:

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:

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ScalingType

withScalingType

public IntegerParameterRange withScalingType(ScalingType 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:

Parameters:

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:

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ScalingType

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public IntegerParameterRange clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.