AWS SDK for C++  1.9.75
AWS SDK for C++
Public Member Functions | List of all members
Aws::Personalize::Model::HPOObjective Class Reference

#include <HPOObjective.h>

Public Member Functions

 HPOObjective ()
 
 HPOObjective (Aws::Utils::Json::JsonView jsonValue)
 
HPOObjectiveoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const Aws::String &value)
 
void SetType (Aws::String &&value)
 
void SetType (const char *value)
 
HPOObjectiveWithType (const Aws::String &value)
 
HPOObjectiveWithType (Aws::String &&value)
 
HPOObjectiveWithType (const char *value)
 
const Aws::StringGetMetricName () const
 
bool MetricNameHasBeenSet () const
 
void SetMetricName (const Aws::String &value)
 
void SetMetricName (Aws::String &&value)
 
void SetMetricName (const char *value)
 
HPOObjectiveWithMetricName (const Aws::String &value)
 
HPOObjectiveWithMetricName (Aws::String &&value)
 
HPOObjectiveWithMetricName (const char *value)
 
const Aws::StringGetMetricRegex () const
 
bool MetricRegexHasBeenSet () const
 
void SetMetricRegex (const Aws::String &value)
 
void SetMetricRegex (Aws::String &&value)
 
void SetMetricRegex (const char *value)
 
HPOObjectiveWithMetricRegex (const Aws::String &value)
 
HPOObjectiveWithMetricRegex (Aws::String &&value)
 
HPOObjectiveWithMetricRegex (const char *value)
 

Detailed Description

The metric to optimize during hyperparameter optimization (HPO).

Amazon Personalize doesn't support configuring the hpoObjective at this time.

See Also:

AWS API Reference

Definition at line 33 of file HPOObjective.h.

Constructor & Destructor Documentation

◆ HPOObjective() [1/2]

Aws::Personalize::Model::HPOObjective::HPOObjective ( )

◆ HPOObjective() [2/2]

Aws::Personalize::Model::HPOObjective::HPOObjective ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ GetMetricName()

const Aws::String& Aws::Personalize::Model::HPOObjective::GetMetricName ( ) const
inline

The name of the metric.

Definition at line 94 of file HPOObjective.h.

◆ GetMetricRegex()

const Aws::String& Aws::Personalize::Model::HPOObjective::GetMetricRegex ( ) const
inline

A regular expression for finding the metric in the training job logs.

Definition at line 135 of file HPOObjective.h.

◆ GetType()

const Aws::String& Aws::Personalize::Model::HPOObjective::GetType ( ) const
inline

The type of the metric. Valid values are Maximize and Minimize.

Definition at line 46 of file HPOObjective.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Personalize::Model::HPOObjective::Jsonize ( ) const

◆ MetricNameHasBeenSet()

bool Aws::Personalize::Model::HPOObjective::MetricNameHasBeenSet ( ) const
inline

The name of the metric.

Definition at line 99 of file HPOObjective.h.

◆ MetricRegexHasBeenSet()

bool Aws::Personalize::Model::HPOObjective::MetricRegexHasBeenSet ( ) const
inline

A regular expression for finding the metric in the training job logs.

Definition at line 140 of file HPOObjective.h.

◆ operator=()

HPOObjective& Aws::Personalize::Model::HPOObjective::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetMetricName() [1/3]

void Aws::Personalize::Model::HPOObjective::SetMetricName ( Aws::String &&  value)
inline

The name of the metric.

Definition at line 109 of file HPOObjective.h.

◆ SetMetricName() [2/3]

void Aws::Personalize::Model::HPOObjective::SetMetricName ( const Aws::String value)
inline

The name of the metric.

Definition at line 104 of file HPOObjective.h.

◆ SetMetricName() [3/3]

void Aws::Personalize::Model::HPOObjective::SetMetricName ( const char *  value)
inline

The name of the metric.

Definition at line 114 of file HPOObjective.h.

◆ SetMetricRegex() [1/3]

void Aws::Personalize::Model::HPOObjective::SetMetricRegex ( Aws::String &&  value)
inline

A regular expression for finding the metric in the training job logs.

Definition at line 150 of file HPOObjective.h.

◆ SetMetricRegex() [2/3]

void Aws::Personalize::Model::HPOObjective::SetMetricRegex ( const Aws::String value)
inline

A regular expression for finding the metric in the training job logs.

Definition at line 145 of file HPOObjective.h.

◆ SetMetricRegex() [3/3]

void Aws::Personalize::Model::HPOObjective::SetMetricRegex ( const char *  value)
inline

A regular expression for finding the metric in the training job logs.

Definition at line 155 of file HPOObjective.h.

◆ SetType() [1/3]

void Aws::Personalize::Model::HPOObjective::SetType ( Aws::String &&  value)
inline

The type of the metric. Valid values are Maximize and Minimize.

Definition at line 64 of file HPOObjective.h.

◆ SetType() [2/3]

void Aws::Personalize::Model::HPOObjective::SetType ( const Aws::String value)
inline

The type of the metric. Valid values are Maximize and Minimize.

Definition at line 58 of file HPOObjective.h.

◆ SetType() [3/3]

void Aws::Personalize::Model::HPOObjective::SetType ( const char *  value)
inline

The type of the metric. Valid values are Maximize and Minimize.

Definition at line 70 of file HPOObjective.h.

◆ TypeHasBeenSet()

bool Aws::Personalize::Model::HPOObjective::TypeHasBeenSet ( ) const
inline

The type of the metric. Valid values are Maximize and Minimize.

Definition at line 52 of file HPOObjective.h.

◆ WithMetricName() [1/3]

HPOObjective& Aws::Personalize::Model::HPOObjective::WithMetricName ( Aws::String &&  value)
inline

The name of the metric.

Definition at line 124 of file HPOObjective.h.

◆ WithMetricName() [2/3]

HPOObjective& Aws::Personalize::Model::HPOObjective::WithMetricName ( const Aws::String value)
inline

The name of the metric.

Definition at line 119 of file HPOObjective.h.

◆ WithMetricName() [3/3]

HPOObjective& Aws::Personalize::Model::HPOObjective::WithMetricName ( const char *  value)
inline

The name of the metric.

Definition at line 129 of file HPOObjective.h.

◆ WithMetricRegex() [1/3]

HPOObjective& Aws::Personalize::Model::HPOObjective::WithMetricRegex ( Aws::String &&  value)
inline

A regular expression for finding the metric in the training job logs.

Definition at line 165 of file HPOObjective.h.

◆ WithMetricRegex() [2/3]

HPOObjective& Aws::Personalize::Model::HPOObjective::WithMetricRegex ( const Aws::String value)
inline

A regular expression for finding the metric in the training job logs.

Definition at line 160 of file HPOObjective.h.

◆ WithMetricRegex() [3/3]

HPOObjective& Aws::Personalize::Model::HPOObjective::WithMetricRegex ( const char *  value)
inline

A regular expression for finding the metric in the training job logs.

Definition at line 170 of file HPOObjective.h.

◆ WithType() [1/3]

HPOObjective& Aws::Personalize::Model::HPOObjective::WithType ( Aws::String &&  value)
inline

The type of the metric. Valid values are Maximize and Minimize.

Definition at line 82 of file HPOObjective.h.

◆ WithType() [2/3]

HPOObjective& Aws::Personalize::Model::HPOObjective::WithType ( const Aws::String value)
inline

The type of the metric. Valid values are Maximize and Minimize.

Definition at line 76 of file HPOObjective.h.

◆ WithType() [3/3]

HPOObjective& Aws::Personalize::Model::HPOObjective::WithType ( const char *  value)
inline

The type of the metric. Valid values are Maximize and Minimize.

Definition at line 88 of file HPOObjective.h.


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