com.amazonaws.services.sagemaker.model

Class FinalHyperParameterTuningJobObjectiveMetric

java.lang.Object

com.amazonaws.services.sagemaker.model.FinalHyperParameterTuningJobObjectiveMetric

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Shows the latest objective metric emitted by a training job that was launched by a hyperparameter tuning job. You define the objective metric in the HyperParameterTuningJobObjective parameter of HyperParameterTuningJobConfig.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
FinalHyperParameterTuningJobObjectiveMetric()

Method Summary

Modifier and Type	Method and Description
FinalHyperParameterTuningJobObjectiveMetric	clone()
boolean	equals(Object obj)
String	getMetricName() The name of the objective metric.
String	getType() Select if you want to minimize or maximize the objective metric during hyperparameter tuning.
Float	getValue() The value of 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 objective metric.
void	setType(String type) Select if you want to minimize or maximize the objective metric during hyperparameter tuning.
void	setValue(Float value) The value of the objective metric.
String	toString() Returns a string representation of this object.
FinalHyperParameterTuningJobObjectiveMetric	withMetricName(String metricName) The name of the objective metric.
FinalHyperParameterTuningJobObjectiveMetric	withType(HyperParameterTuningJobObjectiveType type) Select if you want to minimize or maximize the objective metric during hyperparameter tuning.
FinalHyperParameterTuningJobObjectiveMetric	withType(String type) Select if you want to minimize or maximize the objective metric during hyperparameter tuning.
FinalHyperParameterTuningJobObjectiveMetric	withValue(Float value) The value of the objective metric.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FinalHyperParameterTuningJobObjectiveMetric

public FinalHyperParameterTuningJobObjectiveMetric()

Method Detail

setType

public void setType(String type)

Select if you want to minimize or maximize the objective metric during hyperparameter tuning.

Parameters:

type - Select if you want to minimize or maximize the objective metric during hyperparameter tuning.

See Also:

HyperParameterTuningJobObjectiveType

getType

public String getType()

Select if you want to minimize or maximize the objective metric during hyperparameter tuning.

Returns:

Select if you want to minimize or maximize the objective metric during hyperparameter tuning.

See Also:

HyperParameterTuningJobObjectiveType

withType

public FinalHyperParameterTuningJobObjectiveMetric withType(String type)

Select if you want to minimize or maximize the objective metric during hyperparameter tuning.

Parameters:

type - Select if you want to minimize or maximize the objective metric during hyperparameter tuning.

Returns:

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

See Also:

HyperParameterTuningJobObjectiveType

withType

public FinalHyperParameterTuningJobObjectiveMetric withType(HyperParameterTuningJobObjectiveType type)

Select if you want to minimize or maximize the objective metric during hyperparameter tuning.

Parameters:

type - Select if you want to minimize or maximize the objective metric during hyperparameter tuning.

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 objective metric. For SageMaker built-in algorithms, metrics are defined per algorithm. See the metrics for XGBoost as an example. You can also use a custom algorithm for training and define your own metrics. For more information, see Define metrics and environment variables.

Parameters:

metricName - The name of the objective metric. For SageMaker built-in algorithms, metrics are defined per algorithm. See the metrics for XGBoost as an example. You can also use a custom algorithm for training and define your own metrics. For more information, see Define metrics and environment variables.

getMetricName

public String getMetricName()

The name of the objective metric. For SageMaker built-in algorithms, metrics are defined per algorithm. See the metrics for XGBoost as an example. You can also use a custom algorithm for training and define your own metrics. For more information, see Define metrics and environment variables.

Returns:

The name of the objective metric. For SageMaker built-in algorithms, metrics are defined per algorithm. See the metrics for XGBoost as an example. You can also use a custom algorithm for training and define your own metrics. For more information, see Define metrics and environment variables.

withMetricName

public FinalHyperParameterTuningJobObjectiveMetric withMetricName(String metricName)

The name of the objective metric. For SageMaker built-in algorithms, metrics are defined per algorithm. See the metrics for XGBoost as an example. You can also use a custom algorithm for training and define your own metrics. For more information, see Define metrics and environment variables.

Parameters:

metricName - The name of the objective metric. For SageMaker built-in algorithms, metrics are defined per algorithm. See the metrics for XGBoost as an example. You can also use a custom algorithm for training and define your own metrics. For more information, see Define metrics and environment variables.

Returns:

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

setValue

public void setValue(Float value)

The value of the objective metric.

Parameters:

value - The value of the objective metric.

getValue

public Float getValue()

The value of the objective metric.

Returns:

The value of the objective metric.

withValue

public FinalHyperParameterTuningJobObjectiveMetric withValue(Float value)

The value of the objective metric.

Parameters:

value - The value of 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 FinalHyperParameterTuningJobObjectiveMetric 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.