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(value="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. Amazon SageMakerhyperparameter tuning captures all defined metrics. You specify one metric that a hyperparameter tuning job uses as its objective metric to choose the best training job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MetricDefinition.Builder

Method Summary

Modifier and Type	Method and Description
static MetricDefinition.Builder	builder()
boolean	equals(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.
List<SdkField<?>>	sdkFields()
static Class<? extends MetricDefinition.Builder>	serializableBuilderClass()
MetricDefinition.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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 Detail

name

public String name()

The name of the metric.

Returns:

The name of the metric.

regex

public 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 Objective Metrics.

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 Objective Metrics.

toBuilder

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

Returns:

a builder for type T

builder

public static MetricDefinition.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

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

Returns:

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