Class IntegerParameterRange
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<IntegerParameterRange.Builder,
IntegerParameterRange>
Specifies an integer hyperparameter and it's range of tunable values. This object is part of the ParameterRanges object.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Integer
maxValue()
The maximum tunable value of the hyperparameter.final Integer
minValue()
The minimum tunable value of the hyperparameter.final String
name()
The name of the hyperparameter to tune.final ScalingType
The scale that hyperparameter tuning uses to search the hyperparameter range.final String
The scale that hyperparameter tuning uses to search the hyperparameter range.static Class
<? extends IntegerParameterRange.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the hyperparameter to tune.
- Returns:
- The name of the hyperparameter to tune.
-
maxValue
The maximum tunable value of the hyperparameter.
- Returns:
- The maximum tunable value of the hyperparameter.
-
minValue
The minimum tunable value of the hyperparameter.
- Returns:
- The minimum tunable value of the hyperparameter.
-
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:
If the service returns an enum value that is not available in the current SDK version,
scalingType
will returnScalingType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromscalingTypeAsString()
.- 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:
-
scalingTypeAsString
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:
If the service returns an enum value that is not available in the current SDK version,
scalingType
will returnScalingType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromscalingTypeAsString()
.- 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:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<IntegerParameterRange.Builder,
IntegerParameterRange> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-