software.amazon.awssdk.services.sagemaker.model

Class FinalHyperParameterTuningJobObjectiveMetric

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.FinalHyperParameterTuningJobObjectiveMetric

All Implemented Interfaces:

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

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

Shows the final value for the objective metric for a training job that was launched by a hyperparameter tuning job. You define the objective metric in the HyperParameterTuningJobObjective parameter of HyperParameterTuningJobConfig.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FinalHyperParameterTuningJobObjectiveMetric.Builder

Method Summary

Modifier and Type	Method and Description
static FinalHyperParameterTuningJobObjectiveMetric.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 objective metric.
List<SdkField<?>>	sdkFields()
static Class<? extends FinalHyperParameterTuningJobObjectiveMetric.Builder>	serializableBuilderClass()
FinalHyperParameterTuningJobObjectiveMetric.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.
Float	value() The value of 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 HyperParameterTuningJobObjectiveType type()

Whether to minimize or maximize the objective metric. Valid values are Minimize and Maximize.

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. Valid values are Minimize and Maximize.

See Also:

HyperParameterTuningJobObjectiveType

typeAsString

public String typeAsString()

Whether to minimize or maximize the objective metric. Valid values are Minimize and Maximize.

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. Valid values are Minimize and Maximize.

See Also:

HyperParameterTuningJobObjectiveType

metricName

public String metricName()

The name of the objective metric.

Returns:

The name of the objective metric.

value

public Float value()

The value of the objective metric.

Returns:

The value of the objective metric.

toBuilder

public FinalHyperParameterTuningJobObjectiveMetric.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FinalHyperParameterTuningJobObjectiveMetric.Builder,FinalHyperParameterTuningJobObjectiveMetric>

builder

public static FinalHyperParameterTuningJobObjectiveMetric.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo