Package 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("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. If you want to define a custom objective metric, see Define metrics and environment variables.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	HyperParameterTuningJobObjective.Builder

Method Summary

Modifier and Type	Method	Description
static HyperParameterTuningJobObjective.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(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.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends HyperParameterTuningJobObjective.Builder>	serializableBuilderClass()
HyperParameterTuningJobObjective.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
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

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

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

copy

Method Detail

type

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

Specified by:

toBuilder in interface ToCopyableBuilder<HyperParameterTuningJobObjective.Builder,HyperParameterTuningJobObjective>

builder

public static HyperParameterTuningJobObjective.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo