AWS SDK for C++  1.9.123
AWS SDK for C++
Public Member Functions | List of all members
Aws::SageMaker::Model::FinalHyperParameterTuningJobObjectiveMetric Class Reference

#include <FinalHyperParameterTuningJobObjectiveMetric.h>

Public Member Functions

 FinalHyperParameterTuningJobObjectiveMetric ()
 
 FinalHyperParameterTuningJobObjectiveMetric (Aws::Utils::Json::JsonView jsonValue)
 
FinalHyperParameterTuningJobObjectiveMetricoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const HyperParameterTuningJobObjectiveTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const HyperParameterTuningJobObjectiveType &value)
 
void SetType (HyperParameterTuningJobObjectiveType &&value)
 
FinalHyperParameterTuningJobObjectiveMetricWithType (const HyperParameterTuningJobObjectiveType &value)
 
FinalHyperParameterTuningJobObjectiveMetricWithType (HyperParameterTuningJobObjectiveType &&value)
 
const Aws::StringGetMetricName () const
 
bool MetricNameHasBeenSet () const
 
void SetMetricName (const Aws::String &value)
 
void SetMetricName (Aws::String &&value)
 
void SetMetricName (const char *value)
 
FinalHyperParameterTuningJobObjectiveMetricWithMetricName (const Aws::String &value)
 
FinalHyperParameterTuningJobObjectiveMetricWithMetricName (Aws::String &&value)
 
FinalHyperParameterTuningJobObjectiveMetricWithMetricName (const char *value)
 
double GetValue () const
 
bool ValueHasBeenSet () const
 
void SetValue (double value)
 
FinalHyperParameterTuningJobObjectiveMetricWithValue (double value)
 

Detailed Description

Shows the final value for the objective metric for 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 Reference

Definition at line 35 of file FinalHyperParameterTuningJobObjectiveMetric.h.

Constructor & Destructor Documentation

◆ FinalHyperParameterTuningJobObjectiveMetric() [1/2]

Aws::SageMaker::Model::FinalHyperParameterTuningJobObjectiveMetric::FinalHyperParameterTuningJobObjectiveMetric ( )

◆ FinalHyperParameterTuningJobObjectiveMetric() [2/2]

Aws::SageMaker::Model::FinalHyperParameterTuningJobObjectiveMetric::FinalHyperParameterTuningJobObjectiveMetric ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ GetMetricName()

const Aws::String& Aws::SageMaker::Model::FinalHyperParameterTuningJobObjectiveMetric::GetMetricName ( ) const
inline

The name of the objective metric.

Definition at line 84 of file FinalHyperParameterTuningJobObjectiveMetric.h.

◆ GetType()

const HyperParameterTuningJobObjectiveType& Aws::SageMaker::Model::FinalHyperParameterTuningJobObjectiveMetric::GetType ( ) const
inline

Whether to minimize or maximize the objective metric. Valid values are Minimize and Maximize.

Definition at line 48 of file FinalHyperParameterTuningJobObjectiveMetric.h.

◆ GetValue()

double Aws::SageMaker::Model::FinalHyperParameterTuningJobObjectiveMetric::GetValue ( ) const
inline

The value of the objective metric.

Definition at line 125 of file FinalHyperParameterTuningJobObjectiveMetric.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::SageMaker::Model::FinalHyperParameterTuningJobObjectiveMetric::Jsonize ( ) const

◆ MetricNameHasBeenSet()

bool Aws::SageMaker::Model::FinalHyperParameterTuningJobObjectiveMetric::MetricNameHasBeenSet ( ) const
inline

The name of the objective metric.

Definition at line 89 of file FinalHyperParameterTuningJobObjectiveMetric.h.

◆ operator=()

FinalHyperParameterTuningJobObjectiveMetric& Aws::SageMaker::Model::FinalHyperParameterTuningJobObjectiveMetric::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetMetricName() [1/3]

void Aws::SageMaker::Model::FinalHyperParameterTuningJobObjectiveMetric::SetMetricName ( Aws::String &&  value)
inline

The name of the objective metric.

Definition at line 99 of file FinalHyperParameterTuningJobObjectiveMetric.h.

◆ SetMetricName() [2/3]

void Aws::SageMaker::Model::FinalHyperParameterTuningJobObjectiveMetric::SetMetricName ( const Aws::String value)
inline

The name of the objective metric.

Definition at line 94 of file FinalHyperParameterTuningJobObjectiveMetric.h.

◆ SetMetricName() [3/3]

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

The name of the objective metric.

Definition at line 104 of file FinalHyperParameterTuningJobObjectiveMetric.h.

◆ SetType() [1/2]

void Aws::SageMaker::Model::FinalHyperParameterTuningJobObjectiveMetric::SetType ( const HyperParameterTuningJobObjectiveType value)
inline

Whether to minimize or maximize the objective metric. Valid values are Minimize and Maximize.

Definition at line 60 of file FinalHyperParameterTuningJobObjectiveMetric.h.

◆ SetType() [2/2]

void Aws::SageMaker::Model::FinalHyperParameterTuningJobObjectiveMetric::SetType ( HyperParameterTuningJobObjectiveType &&  value)
inline

Whether to minimize or maximize the objective metric. Valid values are Minimize and Maximize.

Definition at line 66 of file FinalHyperParameterTuningJobObjectiveMetric.h.

◆ SetValue()

void Aws::SageMaker::Model::FinalHyperParameterTuningJobObjectiveMetric::SetValue ( double  value)
inline

The value of the objective metric.

Definition at line 135 of file FinalHyperParameterTuningJobObjectiveMetric.h.

◆ TypeHasBeenSet()

bool Aws::SageMaker::Model::FinalHyperParameterTuningJobObjectiveMetric::TypeHasBeenSet ( ) const
inline

Whether to minimize or maximize the objective metric. Valid values are Minimize and Maximize.

Definition at line 54 of file FinalHyperParameterTuningJobObjectiveMetric.h.

◆ ValueHasBeenSet()

bool Aws::SageMaker::Model::FinalHyperParameterTuningJobObjectiveMetric::ValueHasBeenSet ( ) const
inline

The value of the objective metric.

Definition at line 130 of file FinalHyperParameterTuningJobObjectiveMetric.h.

◆ WithMetricName() [1/3]

FinalHyperParameterTuningJobObjectiveMetric& Aws::SageMaker::Model::FinalHyperParameterTuningJobObjectiveMetric::WithMetricName ( Aws::String &&  value)
inline

The name of the objective metric.

Definition at line 114 of file FinalHyperParameterTuningJobObjectiveMetric.h.

◆ WithMetricName() [2/3]

FinalHyperParameterTuningJobObjectiveMetric& Aws::SageMaker::Model::FinalHyperParameterTuningJobObjectiveMetric::WithMetricName ( const Aws::String value)
inline

The name of the objective metric.

Definition at line 109 of file FinalHyperParameterTuningJobObjectiveMetric.h.

◆ WithMetricName() [3/3]

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

The name of the objective metric.

Definition at line 119 of file FinalHyperParameterTuningJobObjectiveMetric.h.

◆ WithType() [1/2]

FinalHyperParameterTuningJobObjectiveMetric& Aws::SageMaker::Model::FinalHyperParameterTuningJobObjectiveMetric::WithType ( const HyperParameterTuningJobObjectiveType value)
inline

Whether to minimize or maximize the objective metric. Valid values are Minimize and Maximize.

Definition at line 72 of file FinalHyperParameterTuningJobObjectiveMetric.h.

◆ WithType() [2/2]

FinalHyperParameterTuningJobObjectiveMetric& Aws::SageMaker::Model::FinalHyperParameterTuningJobObjectiveMetric::WithType ( HyperParameterTuningJobObjectiveType &&  value)
inline

Whether to minimize or maximize the objective metric. Valid values are Minimize and Maximize.

Definition at line 78 of file FinalHyperParameterTuningJobObjectiveMetric.h.

◆ WithValue()

FinalHyperParameterTuningJobObjectiveMetric& Aws::SageMaker::Model::FinalHyperParameterTuningJobObjectiveMetric::WithValue ( double  value)
inline

The value of the objective metric.

Definition at line 140 of file FinalHyperParameterTuningJobObjectiveMetric.h.


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