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(value="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 and Description
static interface	HyperParameterSpecification.Builder

Method Summary

Modifier and Type	Method and 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)
<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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
ParameterType	type() The type of this hyperparameter.
String	typeAsString() The type of this hyperparameter.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

name

public 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 String description()

A brief description of the hyperparameter.

Returns:

A brief description of the hyperparameter.

type

public 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 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 ParameterRange range()

The allowed range for this hyperparameter.

Returns:

The allowed range for this hyperparameter.

isTunable

public 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 Boolean isRequired()

Indicates whether this hyperparameter is required.

Returns:

Indicates whether this hyperparameter is required.

defaultValue

public 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()

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 interface ToCopyableBuilder<HyperParameterSpecification.Builder,HyperParameterSpecification>

Returns:

a builder for type T

builder

public static HyperParameterSpecification.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.