com.amazonaws.services.sagemaker.model

Class HyperParameterTuningJobObjective

java.lang.Object

com.amazonaws.services.sagemaker.model.HyperParameterTuningJobObjective

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Defines the objective metric for a hyperparameter tuning job. Hyperparameter tuning uses the value of this metric to evaluate the training jobs it launches, and returns the training job that results in either the highest or lowest value for this metric, depending on the value you specify for the Type parameter. If you want to define a custom objective metric, see Define metrics and environment variables.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
HyperParameterTuningJobObjective()

Method Summary

Modifier and Type	Method and Description
HyperParameterTuningJobObjective	clone()
boolean	equals(Object obj)
String	getMetricName() The name of the metric to use for the objective metric.
String	getType() Whether to minimize or maximize the objective metric.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setMetricName(String metricName) The name of the metric to use for the objective metric.
void	setType(String type) Whether to minimize or maximize the objective metric.
String	toString() Returns a string representation of this object.
HyperParameterTuningJobObjective	withMetricName(String metricName) The name of the metric to use for the objective metric.
HyperParameterTuningJobObjective	withType(HyperParameterTuningJobObjectiveType type) Whether to minimize or maximize the objective metric.
HyperParameterTuningJobObjective	withType(String type) Whether to minimize or maximize the objective metric.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HyperParameterTuningJobObjective

public HyperParameterTuningJobObjective()

Method Detail

setType

public void setType(String type)

Whether to minimize or maximize the objective metric.

Parameters:

type - Whether to minimize or maximize the objective metric.

See Also:

HyperParameterTuningJobObjectiveType

getType

public String getType()

Whether to minimize or maximize the objective metric.

Returns:

Whether to minimize or maximize the objective metric.

See Also:

HyperParameterTuningJobObjectiveType

withType

public HyperParameterTuningJobObjective withType(String type)

Whether to minimize or maximize the objective metric.

Parameters:

type - Whether to minimize or maximize the objective metric.

Returns:

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

See Also:

HyperParameterTuningJobObjectiveType

withType

public HyperParameterTuningJobObjective withType(HyperParameterTuningJobObjectiveType type)

Whether to minimize or maximize the objective metric.

Parameters:

type - Whether to minimize or maximize the objective metric.

Returns:

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

See Also:

HyperParameterTuningJobObjectiveType

setMetricName

public void setMetricName(String metricName)

The name of the metric to use for the objective metric.

Parameters:

metricName - The name of the metric to use for the objective metric.

getMetricName

public String getMetricName()

The name of the metric to use for the objective metric.

Returns:

The name of the metric to use for the objective metric.

withMetricName

public HyperParameterTuningJobObjective withMetricName(String metricName)

The name of the metric to use for the objective metric.

Parameters:

metricName - The name of the metric to use for the objective metric.

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 HyperParameterTuningJobObjective 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.