Class MetricDefinition
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic MetricDefinition.Builder
builder()
final boolean
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
name()
The name of the metric.final String
regex()
A regular expression that searches the output of a training job and gets the value of the metric.static Class
<? extends MetricDefinition.Builder> 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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the metric.
- Returns:
- The name of the metric.
-
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
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 interfaceToCopyableBuilder<MetricDefinition.Builder,
MetricDefinition> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-