software.amazon.awssdk.services.sagemaker.model

Class ParameterRanges

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.ParameterRanges

All Implemented Interfaces:

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

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

Specifies ranges of integer, continuous, and categorical hyperparameters that a hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs with hyperparameter values within these ranges to find the combination of values that result in the training job with the best performance as measured by the objective metric of the hyperparameter tuning job.

You can specify a maximum of 20 hyperparameters that a hyperparameter tuning job can search over. Every possible value of a categorical parameter range counts against this limit.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ParameterRanges.Builder

Method Summary

Modifier and Type	Method and Description
static ParameterRanges.Builder	builder()
List<CategoricalParameterRange>	categoricalParameterRanges() The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.
List<ContinuousParameterRange>	continuousParameterRanges() The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCategoricalParameterRanges() Returns true if the CategoricalParameterRanges property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasContinuousParameterRanges() Returns true if the ContinuousParameterRanges property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasIntegerParameterRanges() Returns true if the IntegerParameterRanges property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<IntegerParameterRange>	integerParameterRanges() The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.
List<SdkField<?>>	sdkFields()
static Class<? extends ParameterRanges.Builder>	serializableBuilderClass()
ParameterRanges.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

hasIntegerParameterRanges

public boolean hasIntegerParameterRanges()

Returns true if the IntegerParameterRanges property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

integerParameterRanges

public List<IntegerParameterRange> integerParameterRanges()

The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasIntegerParameterRanges() to see if a value was sent in this field.

Returns:

The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.

hasContinuousParameterRanges

public boolean hasContinuousParameterRanges()

Returns true if the ContinuousParameterRanges property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

continuousParameterRanges

public List<ContinuousParameterRange> continuousParameterRanges()

The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasContinuousParameterRanges() to see if a value was sent in this field.

Returns:

The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.

hasCategoricalParameterRanges

public boolean hasCategoricalParameterRanges()

Returns true if the CategoricalParameterRanges property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

categoricalParameterRanges

public List<CategoricalParameterRange> categoricalParameterRanges()

The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasCategoricalParameterRanges() to see if a value was sent in this field.

Returns:

The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.

toBuilder

public ParameterRanges.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ParameterRanges.Builder,ParameterRanges>

builder

public static ParameterRanges.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

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

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo