Class FinalHyperParameterTuningJobObjectiveMetric

java.lang.Object

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

All Implemented Interfaces:

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

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

Shows the latest objective metric emitted by 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	Description
static interface	FinalHyperParameterTuningJobObjectiveMetric.Builder

Method Summary

Modifier and Type	Method	Description
static FinalHyperParameterTuningJobObjectiveMetric.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 objective metric.
final List<SdkField<?>>	sdkFields()
static Class<? extends FinalHyperParameterTuningJobObjectiveMetric.Builder>	serializableBuilderClass()
FinalHyperParameterTuningJobObjectiveMetric.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()	Select if you want to minimize or maximize the objective metric during hyperparameter tuning.
final String	typeAsString()	Select if you want to minimize or maximize the objective metric during hyperparameter tuning.
final Float	value()	The value of 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()

Select if you want to minimize or maximize the objective metric during hyperparameter tuning.

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:

Select if you want to minimize or maximize the objective metric during hyperparameter tuning.

See Also:

• HyperParameterTuningJobObjectiveType

typeAsString

public final String typeAsString()

Select if you want to minimize or maximize the objective metric during hyperparameter tuning.

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:

Select if you want to minimize or maximize the objective metric during hyperparameter tuning.

See Also:

• HyperParameterTuningJobObjectiveType

metricName

public final String metricName()

The name of the objective metric. For SageMaker built-in algorithms, metrics are defined per algorithm. See the metrics for XGBoost as an example. You can also use a custom algorithm for training and define your own metrics. For more information, see Define metrics and environment variables.

Returns:

The name of the objective metric. For SageMaker built-in algorithms, metrics are defined per algorithm. See the metrics for XGBoost as an example. You can also use a custom algorithm for training and define your own metrics. For more information, see Define metrics and environment variables.

value

public final Float value()

The value of the objective metric.

Returns:

The value of the objective metric.

toBuilder

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

Returns:

a builder for type T

builder

public static FinalHyperParameterTuningJobObjectiveMetric.Builder builder()

serializableBuilderClass

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