Package software.amazon.awssdk.services.sagemaker.model

Class MetricDefinition

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.MetricDefinition

All Implemented Interfaces:

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

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

Specifies a metric that the training algorithm writes to stderr or stdout. You can view these logs to understand how your training job performs and check for any errors encountered during training. SageMaker hyperparameter tuning captures all defined metrics. Specify one of the defined metrics to use as an objective metric using the TuningObjective parameter in the HyperParameterTrainingJobDefinition API to evaluate job performance during hyperparameter tuning.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MetricDefinition.Builder

Method Summary

Modifier and Type	Method	Description
static MetricDefinition.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The name of the metric.
String	regex()	A regular expression that searches the output of a training job and gets the value of the metric.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends MetricDefinition.Builder>	serializableBuilderClass()
MetricDefinition.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

name

public final String name()

The name of the metric.

Returns:

The name of the metric.

regex

public final String regex()

A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining metrics and environment variables.

Returns:

A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining metrics and environment variables.

toBuilder

public MetricDefinition.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MetricDefinition.Builder,MetricDefinition>

builder

public static MetricDefinition.Builder builder()

serializableBuilderClass

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