Package software.amazon.awssdk.services.sagemaker.model

Class HyperParameterSpecification

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.HyperParameterSpecification

All Implemented Interfaces:

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

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

Defines a hyperparameter to be used by an algorithm.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	HyperParameterSpecification.Builder

Method Summary

Modifier and Type	Method	Description
static HyperParameterSpecification.Builder	builder()
String	defaultValue()	The default value for this hyperparameter.
String	description()	A brief description of the hyperparameter.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	isRequired()	Indicates whether this hyperparameter is required.
Boolean	isTunable()	Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.
String	name()	The name of this hyperparameter.
ParameterRange	range()	The allowed range for this hyperparameter.
List<SdkField<?>>	sdkFields()
static Class<? extends HyperParameterSpecification.Builder>	serializableBuilderClass()
HyperParameterSpecification.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
ParameterType	type()	The type of this hyperparameter.
String	typeAsString()	The type of this hyperparameter.

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 this hyperparameter. The name must be unique.

Returns:

The name of this hyperparameter. The name must be unique.

description

public final String description()

A brief description of the hyperparameter.

Returns:

A brief description of the hyperparameter.

type

public final ParameterType type()

The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.

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

Returns:

The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.

See Also:

ParameterType

typeAsString

public final String typeAsString()

The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.

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

Returns:

The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.

See Also:

ParameterType

range

public final ParameterRange range()

The allowed range for this hyperparameter.

Returns:

The allowed range for this hyperparameter.

isTunable

public final Boolean isTunable()

Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.

Returns:

Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.

isRequired

public final Boolean isRequired()

Indicates whether this hyperparameter is required.

Returns:

Indicates whether this hyperparameter is required.

defaultValue

public final String defaultValue()

The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.

Returns:

The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.

toBuilder

public HyperParameterSpecification.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<HyperParameterSpecification.Builder,HyperParameterSpecification>

builder

public static HyperParameterSpecification.Builder builder()

serializableBuilderClass

public static Class<? extends HyperParameterSpecification.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