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()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final String	metricName()	The name of the metric to use for the objective metric.
final 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.
final String	toString()	Returns a string representation of this object.
final HyperParameterTuningJobObjectiveType	type()	Whether to minimize or maximize the objective metric.
final 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 Details

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

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

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

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