software.amazon.awssdk.services.sagemaker.model

Class HyperParameterTuningJobObjective

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.HyperParameterTuningJobObjective

All Implemented Interfaces:

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

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

Defines the objective metric for a hyperparameter tuning job. Hyperparameter tuning uses the value of this metric to evaluate the training jobs it launches, and returns the training job that results in either the highest or lowest value for this metric, depending on the value you specify for the Type parameter.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HyperParameterTuningJobObjective.Builder

Method Summary

Modifier and Type	Method and Description
static HyperParameterTuningJobObjective.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	metricName() The name of the metric to use for the objective metric.
List<SdkField<?>>	sdkFields()
static Class<? extends HyperParameterTuningJobObjective.Builder>	serializableBuilderClass()
HyperParameterTuningJobObjective.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
HyperParameterTuningJobObjectiveType	type() Whether to minimize or maximize the objective metric.
String	typeAsString() Whether to minimize or maximize the objective metric.

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

type

public HyperParameterTuningJobObjectiveType type()

Whether to minimize or maximize the objective metric.

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

Returns:

Whether to minimize or maximize the objective metric.

See Also:

HyperParameterTuningJobObjectiveType

typeAsString

public String typeAsString()

Whether to minimize or maximize the objective metric.

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

Returns:

Whether to minimize or maximize the objective metric.

See Also:

HyperParameterTuningJobObjectiveType

metricName

public String metricName()

The name of the metric to use for the objective metric.

Returns:

The name of the metric to use for the objective metric.

toBuilder

public HyperParameterTuningJobObjective.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<HyperParameterTuningJobObjective.Builder,HyperParameterTuningJobObjective>

Returns:

a builder for type T

builder

public static HyperParameterTuningJobObjective.Builder builder()

serializableBuilderClass

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