Aws::SageMaker::Model::HyperParameterTuningJobObjective Class Reference

#include <HyperParameterTuningJobObjective.h>

Public Member Functions
	HyperParameterTuningJobObjective ()
	HyperParameterTuningJobObjective (Aws::Utils::Json::JsonView jsonValue)
HyperParameterTuningJobObjective &	operator= (Aws::Utils::Json::JsonView jsonValue)
Aws::Utils::Json::JsonValue	Jsonize () const
const HyperParameterTuningJobObjectiveType &	GetType () const
bool	TypeHasBeenSet () const
void	SetType (const HyperParameterTuningJobObjectiveType &value)
void	SetType (HyperParameterTuningJobObjectiveType &&value)
HyperParameterTuningJobObjective &	WithType (const HyperParameterTuningJobObjectiveType &value)
HyperParameterTuningJobObjective &	WithType (HyperParameterTuningJobObjectiveType &&value)
const Aws::String &	GetMetricName () const
bool	MetricNameHasBeenSet () const
void	SetMetricName (const Aws::String &value)
void	SetMetricName (Aws::String &&value)
void	SetMetricName (const char *value)
HyperParameterTuningJobObjective &	WithMetricName (const Aws::String &value)
HyperParameterTuningJobObjective &	WithMetricName (Aws::String &&value)
HyperParameterTuningJobObjective &	WithMetricName (const char *value)

Detailed Description

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.

See Also:

AWS API Reference

Definition at line 36 of file HyperParameterTuningJobObjective.h.

Constructor & Destructor Documentation

HyperParameterTuningJobObjective() [1/2]

Aws::SageMaker::Model::HyperParameterTuningJobObjective::HyperParameterTuningJobObjective

(

)

HyperParameterTuningJobObjective() [2/2]

Aws::SageMaker::Model::HyperParameterTuningJobObjective::HyperParameterTuningJobObjective

(

Aws::Utils::Json::JsonView

jsonValue

)

Member Function Documentation

GetMetricName()

const Aws::String& Aws::SageMaker::Model::HyperParameterTuningJobObjective::GetMetricName ( ) const

inline

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

Definition at line 79 of file HyperParameterTuningJobObjective.h.

GetType()

const HyperParameterTuningJobObjectiveType& Aws::SageMaker::Model::HyperParameterTuningJobObjective::GetType ( ) const

inline

Whether to minimize or maximize the objective metric.

Definition at line 48 of file HyperParameterTuningJobObjective.h.

Jsonize()

Aws::Utils::Json::JsonValue Aws::SageMaker::Model::HyperParameterTuningJobObjective::Jsonize

(

)

const

MetricNameHasBeenSet()

bool Aws::SageMaker::Model::HyperParameterTuningJobObjective::MetricNameHasBeenSet ( ) const

inline

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

Definition at line 84 of file HyperParameterTuningJobObjective.h.

operator=()

HyperParameterTuningJobObjective& Aws::SageMaker::Model::HyperParameterTuningJobObjective::operator=

(

Aws::Utils::Json::JsonView

jsonValue

)

SetMetricName() [1/3]

void Aws::SageMaker::Model::HyperParameterTuningJobObjective::SetMetricName ( Aws::String &&  value )

inline

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

Definition at line 94 of file HyperParameterTuningJobObjective.h.

SetMetricName() [2/3]

void Aws::SageMaker::Model::HyperParameterTuningJobObjective::SetMetricName ( const Aws::String &  value )

inline

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

Definition at line 89 of file HyperParameterTuningJobObjective.h.

SetMetricName() [3/3]

void Aws::SageMaker::Model::HyperParameterTuningJobObjective::SetMetricName ( const char *  value )

inline

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

Definition at line 99 of file HyperParameterTuningJobObjective.h.

SetType() [1/2]

void Aws::SageMaker::Model::HyperParameterTuningJobObjective::SetType ( const HyperParameterTuningJobObjectiveType &  value )

inline

Whether to minimize or maximize the objective metric.

Definition at line 58 of file HyperParameterTuningJobObjective.h.

SetType() [2/2]

void Aws::SageMaker::Model::HyperParameterTuningJobObjective::SetType ( HyperParameterTuningJobObjectiveType &&  value )

inline

Whether to minimize or maximize the objective metric.

Definition at line 63 of file HyperParameterTuningJobObjective.h.

TypeHasBeenSet()

bool Aws::SageMaker::Model::HyperParameterTuningJobObjective::TypeHasBeenSet ( ) const

inline

Whether to minimize or maximize the objective metric.

Definition at line 53 of file HyperParameterTuningJobObjective.h.

WithMetricName() [1/3]

HyperParameterTuningJobObjective& Aws::SageMaker::Model::HyperParameterTuningJobObjective::WithMetricName ( Aws::String &&  value )

inline

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

Definition at line 109 of file HyperParameterTuningJobObjective.h.

WithMetricName() [2/3]

HyperParameterTuningJobObjective& Aws::SageMaker::Model::HyperParameterTuningJobObjective::WithMetricName ( const Aws::String &  value )

inline

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

Definition at line 104 of file HyperParameterTuningJobObjective.h.

WithMetricName() [3/3]

HyperParameterTuningJobObjective& Aws::SageMaker::Model::HyperParameterTuningJobObjective::WithMetricName ( const char *  value )

inline

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

Definition at line 114 of file HyperParameterTuningJobObjective.h.

WithType() [1/2]

HyperParameterTuningJobObjective& Aws::SageMaker::Model::HyperParameterTuningJobObjective::WithType ( const HyperParameterTuningJobObjectiveType &  value )

inline

Whether to minimize or maximize the objective metric.

Definition at line 68 of file HyperParameterTuningJobObjective.h.

WithType() [2/2]

HyperParameterTuningJobObjective& Aws::SageMaker::Model::HyperParameterTuningJobObjective::WithType ( HyperParameterTuningJobObjectiveType &&  value )

inline

Whether to minimize or maximize the objective metric.

Definition at line 73 of file HyperParameterTuningJobObjective.h.

---

The documentation for this class was generated from the following file:

• aws-cpp-sdk-sagemaker/include/aws/sagemaker/model/HyperParameterTuningJobObjective.h