com.amazonaws.services.sagemaker.model

Class MetricDefinition

java.lang.Object

com.amazonaws.services.sagemaker.model.MetricDefinition

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class MetricDefinition
extends Object
implements Serializable, Cloneable, StructuredPojo

Specifies a metric that the training algorithm writes to stderr or stdout. 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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
MetricDefinition()

Method Summary

Modifier and Type	Method and Description
MetricDefinition	clone()
boolean	equals(Object obj)
String	getName() The name of the metric.
String	getRegex() A regular expression that searches the output of a training job and gets the value of the metric.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setName(String name) The name of the metric.
void	setRegex(String regex) A regular expression that searches the output of a training job and gets the value of the metric.
String	toString() Returns a string representation of this object.
MetricDefinition	withName(String name) The name of the metric.
MetricDefinition	withRegex(String regex) A regular expression that searches the output of a training job and gets the value of the metric.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MetricDefinition

public MetricDefinition()

Method Detail

setName

public void setName(String name)

The name of the metric.

Parameters:

name - The name of the metric.

getName

public String getName()

The name of the metric.

Returns:

The name of the metric.

withName

public MetricDefinition withName(String name)

The name of the metric.

Parameters:

name - The name of the metric.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRegex

public void setRegex(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.

Parameters:

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.

getRegex

public String getRegex()

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.

withRegex

public MetricDefinition withRegex(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public MetricDefinition clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.