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

#include <MetricDefinition.h>

Public Member Functions

 MetricDefinition ()
 
 MetricDefinition (Aws::Utils::Json::JsonView jsonValue)
 
MetricDefinitionoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
MetricDefinitionWithName (const Aws::String &value)
 
MetricDefinitionWithName (Aws::String &&value)
 
MetricDefinitionWithName (const char *value)
 
const Aws::StringGetRegex () const
 
bool RegexHasBeenSet () const
 
void SetRegex (const Aws::String &value)
 
void SetRegex (Aws::String &&value)
 
void SetRegex (const char *value)
 
MetricDefinitionWithRegex (const Aws::String &value)
 
MetricDefinitionWithRegex (Aws::String &&value)
 
MetricDefinitionWithRegex (const char *value)
 

Detailed Description

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

Definition at line 35 of file MetricDefinition.h.

Constructor & Destructor Documentation

◆ MetricDefinition() [1/2]

Aws::SageMaker::Model::MetricDefinition::MetricDefinition ( )

◆ MetricDefinition() [2/2]

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

Member Function Documentation

◆ GetName()

const Aws::String& Aws::SageMaker::Model::MetricDefinition::GetName ( ) const
inline

The name of the metric.

Definition at line 47 of file MetricDefinition.h.

◆ GetRegex()

const Aws::String& Aws::SageMaker::Model::MetricDefinition::GetRegex ( ) const
inline

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.

Definition at line 92 of file MetricDefinition.h.

◆ Jsonize()

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

◆ NameHasBeenSet()

bool Aws::SageMaker::Model::MetricDefinition::NameHasBeenSet ( ) const
inline

The name of the metric.

Definition at line 52 of file MetricDefinition.h.

◆ operator=()

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

◆ RegexHasBeenSet()

bool Aws::SageMaker::Model::MetricDefinition::RegexHasBeenSet ( ) const
inline

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.

Definition at line 101 of file MetricDefinition.h.

◆ SetName() [1/3]

void Aws::SageMaker::Model::MetricDefinition::SetName ( Aws::String &&  value)
inline

The name of the metric.

Definition at line 62 of file MetricDefinition.h.

◆ SetName() [2/3]

void Aws::SageMaker::Model::MetricDefinition::SetName ( const Aws::String value)
inline

The name of the metric.

Definition at line 57 of file MetricDefinition.h.

◆ SetName() [3/3]

void Aws::SageMaker::Model::MetricDefinition::SetName ( const char *  value)
inline

The name of the metric.

Definition at line 67 of file MetricDefinition.h.

◆ SetRegex() [1/3]

void Aws::SageMaker::Model::MetricDefinition::SetRegex ( Aws::String &&  value)
inline

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.

Definition at line 119 of file MetricDefinition.h.

◆ SetRegex() [2/3]

void Aws::SageMaker::Model::MetricDefinition::SetRegex ( const Aws::String value)
inline

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.

Definition at line 110 of file MetricDefinition.h.

◆ SetRegex() [3/3]

void Aws::SageMaker::Model::MetricDefinition::SetRegex ( const char *  value)
inline

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.

Definition at line 128 of file MetricDefinition.h.

◆ WithName() [1/3]

MetricDefinition& Aws::SageMaker::Model::MetricDefinition::WithName ( Aws::String &&  value)
inline

The name of the metric.

Definition at line 77 of file MetricDefinition.h.

◆ WithName() [2/3]

MetricDefinition& Aws::SageMaker::Model::MetricDefinition::WithName ( const Aws::String value)
inline

The name of the metric.

Definition at line 72 of file MetricDefinition.h.

◆ WithName() [3/3]

MetricDefinition& Aws::SageMaker::Model::MetricDefinition::WithName ( const char *  value)
inline

The name of the metric.

Definition at line 82 of file MetricDefinition.h.

◆ WithRegex() [1/3]

MetricDefinition& Aws::SageMaker::Model::MetricDefinition::WithRegex ( Aws::String &&  value)
inline

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.

Definition at line 146 of file MetricDefinition.h.

◆ WithRegex() [2/3]

MetricDefinition& Aws::SageMaker::Model::MetricDefinition::WithRegex ( const Aws::String value)
inline

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.

Definition at line 137 of file MetricDefinition.h.

◆ WithRegex() [3/3]

MetricDefinition& Aws::SageMaker::Model::MetricDefinition::WithRegex ( const char *  value)
inline

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.

Definition at line 155 of file MetricDefinition.h.


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