software.amazon.awssdk.services.sagemaker.model

Class IntegerParameterRange

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.IntegerParameterRange

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<IntegerParameterRange.Builder,IntegerParameterRange>

@Generated(value="software.amazon.awssdk:codegen")
public final class IntegerParameterRange
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<IntegerParameterRange.Builder,IntegerParameterRange>

For a hyperparameter of the integer type, specifies the range that a hyperparameter tuning job searches.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IntegerParameterRange.Builder

Method Summary

Modifier and Type	Method and Description
static IntegerParameterRange.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	maxValue() The maximum value of the hyperparameter to search.
String	minValue() The minimum value of the hyperparameter to search.
String	name() The name of the hyperparameter to search.
HyperParameterScalingType	scalingType() The scale that hyperparameter tuning uses to search the hyperparameter range.
String	scalingTypeAsString() The scale that hyperparameter tuning uses to search the hyperparameter range.
List<SdkField<?>>	sdkFields()
static Class<? extends IntegerParameterRange.Builder>	serializableBuilderClass()
IntegerParameterRange.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public final String name()

The name of the hyperparameter to search.

Returns:

The name of the hyperparameter to search.

minValue

public final String minValue()

The minimum value of the hyperparameter to search.

Returns:

The minimum value of the hyperparameter to search.

maxValue

public final String maxValue()

The maximum value of the hyperparameter to search.

Returns:

The maximum value of the hyperparameter to search.

scalingType

public final HyperParameterScalingType scalingType()

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 SageMaker 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.

If the service returns an enum value that is not available in the current SDK version, scalingType will return HyperParameterScalingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scalingTypeAsString().

Returns:

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 SageMaker 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.

See Also:

HyperParameterScalingType

scalingTypeAsString

public final String scalingTypeAsString()

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 SageMaker 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.

If the service returns an enum value that is not available in the current SDK version, scalingType will return HyperParameterScalingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scalingTypeAsString().

Returns:

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 SageMaker 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.

See Also:

HyperParameterScalingType

toBuilder

public IntegerParameterRange.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IntegerParameterRange.Builder,IntegerParameterRange>

builder

public static IntegerParameterRange.Builder builder()

serializableBuilderClass

public static Class<? extends IntegerParameterRange.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo