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

#include <HyperParameterAlgorithmSpecification.h>

Public Member Functions

 HyperParameterAlgorithmSpecification ()
 
 HyperParameterAlgorithmSpecification (Aws::Utils::Json::JsonView jsonValue)
 
HyperParameterAlgorithmSpecificationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetTrainingImage () const
 
bool TrainingImageHasBeenSet () const
 
void SetTrainingImage (const Aws::String &value)
 
void SetTrainingImage (Aws::String &&value)
 
void SetTrainingImage (const char *value)
 
HyperParameterAlgorithmSpecificationWithTrainingImage (const Aws::String &value)
 
HyperParameterAlgorithmSpecificationWithTrainingImage (Aws::String &&value)
 
HyperParameterAlgorithmSpecificationWithTrainingImage (const char *value)
 
const TrainingInputModeGetTrainingInputMode () const
 
bool TrainingInputModeHasBeenSet () const
 
void SetTrainingInputMode (const TrainingInputMode &value)
 
void SetTrainingInputMode (TrainingInputMode &&value)
 
HyperParameterAlgorithmSpecificationWithTrainingInputMode (const TrainingInputMode &value)
 
HyperParameterAlgorithmSpecificationWithTrainingInputMode (TrainingInputMode &&value)
 
const Aws::StringGetAlgorithmName () const
 
bool AlgorithmNameHasBeenSet () const
 
void SetAlgorithmName (const Aws::String &value)
 
void SetAlgorithmName (Aws::String &&value)
 
void SetAlgorithmName (const char *value)
 
HyperParameterAlgorithmSpecificationWithAlgorithmName (const Aws::String &value)
 
HyperParameterAlgorithmSpecificationWithAlgorithmName (Aws::String &&value)
 
HyperParameterAlgorithmSpecificationWithAlgorithmName (const char *value)
 
const Aws::Vector< MetricDefinition > & GetMetricDefinitions () const
 
bool MetricDefinitionsHasBeenSet () const
 
void SetMetricDefinitions (const Aws::Vector< MetricDefinition > &value)
 
void SetMetricDefinitions (Aws::Vector< MetricDefinition > &&value)
 
HyperParameterAlgorithmSpecificationWithMetricDefinitions (const Aws::Vector< MetricDefinition > &value)
 
HyperParameterAlgorithmSpecificationWithMetricDefinitions (Aws::Vector< MetricDefinition > &&value)
 
HyperParameterAlgorithmSpecificationAddMetricDefinitions (const MetricDefinition &value)
 
HyperParameterAlgorithmSpecificationAddMetricDefinitions (MetricDefinition &&value)
 

Detailed Description

Specifies which training algorithm to use for training jobs that a hyperparameter tuning job launches and the metrics to monitor.

See Also:

AWS API Reference

Definition at line 36 of file HyperParameterAlgorithmSpecification.h.

Constructor & Destructor Documentation

◆ HyperParameterAlgorithmSpecification() [1/2]

Aws::SageMaker::Model::HyperParameterAlgorithmSpecification::HyperParameterAlgorithmSpecification ( )

◆ HyperParameterAlgorithmSpecification() [2/2]

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

Member Function Documentation

◆ AddMetricDefinitions() [1/2]

HyperParameterAlgorithmSpecification& Aws::SageMaker::Model::HyperParameterAlgorithmSpecification::AddMetricDefinitions ( const MetricDefinition value)
inline

An array of MetricDefinition objects that specify the metrics that the algorithm emits.

Definition at line 266 of file HyperParameterAlgorithmSpecification.h.

◆ AddMetricDefinitions() [2/2]

HyperParameterAlgorithmSpecification& Aws::SageMaker::Model::HyperParameterAlgorithmSpecification::AddMetricDefinitions ( MetricDefinition &&  value)
inline

An array of MetricDefinition objects that specify the metrics that the algorithm emits.

Definition at line 272 of file HyperParameterAlgorithmSpecification.h.

◆ AlgorithmNameHasBeenSet()

bool Aws::SageMaker::Model::HyperParameterAlgorithmSpecification::AlgorithmNameHasBeenSet ( ) const
inline

The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage.

Definition at line 181 of file HyperParameterAlgorithmSpecification.h.

◆ GetAlgorithmName()

const Aws::String& Aws::SageMaker::Model::HyperParameterAlgorithmSpecification::GetAlgorithmName ( ) const
inline

The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage.

Definition at line 174 of file HyperParameterAlgorithmSpecification.h.

◆ GetMetricDefinitions()

const Aws::Vector<MetricDefinition>& Aws::SageMaker::Model::HyperParameterAlgorithmSpecification::GetMetricDefinitions ( ) const
inline

An array of MetricDefinition objects that specify the metrics that the algorithm emits.

Definition at line 230 of file HyperParameterAlgorithmSpecification.h.

◆ GetTrainingImage()

const Aws::String& Aws::SageMaker::Model::HyperParameterAlgorithmSpecification::GetTrainingImage ( ) const
inline

The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

Definition at line 56 of file HyperParameterAlgorithmSpecification.h.

◆ GetTrainingInputMode()

const TrainingInputMode& Aws::SageMaker::Model::HyperParameterAlgorithmSpecification::GetTrainingInputMode ( ) const
inline

Definition at line 151 of file HyperParameterAlgorithmSpecification.h.

◆ Jsonize()

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

◆ MetricDefinitionsHasBeenSet()

bool Aws::SageMaker::Model::HyperParameterAlgorithmSpecification::MetricDefinitionsHasBeenSet ( ) const
inline

An array of MetricDefinition objects that specify the metrics that the algorithm emits.

Definition at line 236 of file HyperParameterAlgorithmSpecification.h.

◆ operator=()

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

◆ SetAlgorithmName() [1/3]

void Aws::SageMaker::Model::HyperParameterAlgorithmSpecification::SetAlgorithmName ( Aws::String &&  value)
inline

The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage.

Definition at line 195 of file HyperParameterAlgorithmSpecification.h.

◆ SetAlgorithmName() [2/3]

void Aws::SageMaker::Model::HyperParameterAlgorithmSpecification::SetAlgorithmName ( const Aws::String value)
inline

The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage.

Definition at line 188 of file HyperParameterAlgorithmSpecification.h.

◆ SetAlgorithmName() [3/3]

void Aws::SageMaker::Model::HyperParameterAlgorithmSpecification::SetAlgorithmName ( const char *  value)
inline

The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage.

Definition at line 202 of file HyperParameterAlgorithmSpecification.h.

◆ SetMetricDefinitions() [1/2]

void Aws::SageMaker::Model::HyperParameterAlgorithmSpecification::SetMetricDefinitions ( Aws::Vector< MetricDefinition > &&  value)
inline

An array of MetricDefinition objects that specify the metrics that the algorithm emits.

Definition at line 248 of file HyperParameterAlgorithmSpecification.h.

◆ SetMetricDefinitions() [2/2]

void Aws::SageMaker::Model::HyperParameterAlgorithmSpecification::SetMetricDefinitions ( const Aws::Vector< MetricDefinition > &  value)
inline

An array of MetricDefinition objects that specify the metrics that the algorithm emits.

Definition at line 242 of file HyperParameterAlgorithmSpecification.h.

◆ SetTrainingImage() [1/3]

void Aws::SageMaker::Model::HyperParameterAlgorithmSpecification::SetTrainingImage ( Aws::String &&  value)
inline

The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

Definition at line 95 of file HyperParameterAlgorithmSpecification.h.

◆ SetTrainingImage() [2/3]

void Aws::SageMaker::Model::HyperParameterAlgorithmSpecification::SetTrainingImage ( const Aws::String value)
inline

The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

Definition at line 82 of file HyperParameterAlgorithmSpecification.h.

◆ SetTrainingImage() [3/3]

void Aws::SageMaker::Model::HyperParameterAlgorithmSpecification::SetTrainingImage ( const char *  value)
inline

The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

Definition at line 108 of file HyperParameterAlgorithmSpecification.h.

◆ SetTrainingInputMode() [1/2]

void Aws::SageMaker::Model::HyperParameterAlgorithmSpecification::SetTrainingInputMode ( const TrainingInputMode value)
inline

Definition at line 157 of file HyperParameterAlgorithmSpecification.h.

◆ SetTrainingInputMode() [2/2]

void Aws::SageMaker::Model::HyperParameterAlgorithmSpecification::SetTrainingInputMode ( TrainingInputMode &&  value)
inline

Definition at line 160 of file HyperParameterAlgorithmSpecification.h.

◆ TrainingImageHasBeenSet()

bool Aws::SageMaker::Model::HyperParameterAlgorithmSpecification::TrainingImageHasBeenSet ( ) const
inline

The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

Definition at line 69 of file HyperParameterAlgorithmSpecification.h.

◆ TrainingInputModeHasBeenSet()

bool Aws::SageMaker::Model::HyperParameterAlgorithmSpecification::TrainingInputModeHasBeenSet ( ) const
inline

Definition at line 154 of file HyperParameterAlgorithmSpecification.h.

◆ WithAlgorithmName() [1/3]

HyperParameterAlgorithmSpecification& Aws::SageMaker::Model::HyperParameterAlgorithmSpecification::WithAlgorithmName ( Aws::String &&  value)
inline

The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage.

Definition at line 216 of file HyperParameterAlgorithmSpecification.h.

◆ WithAlgorithmName() [2/3]

HyperParameterAlgorithmSpecification& Aws::SageMaker::Model::HyperParameterAlgorithmSpecification::WithAlgorithmName ( const Aws::String value)
inline

The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage.

Definition at line 209 of file HyperParameterAlgorithmSpecification.h.

◆ WithAlgorithmName() [3/3]

HyperParameterAlgorithmSpecification& Aws::SageMaker::Model::HyperParameterAlgorithmSpecification::WithAlgorithmName ( const char *  value)
inline

The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage.

Definition at line 223 of file HyperParameterAlgorithmSpecification.h.

◆ WithMetricDefinitions() [1/2]

HyperParameterAlgorithmSpecification& Aws::SageMaker::Model::HyperParameterAlgorithmSpecification::WithMetricDefinitions ( Aws::Vector< MetricDefinition > &&  value)
inline

An array of MetricDefinition objects that specify the metrics that the algorithm emits.

Definition at line 260 of file HyperParameterAlgorithmSpecification.h.

◆ WithMetricDefinitions() [2/2]

HyperParameterAlgorithmSpecification& Aws::SageMaker::Model::HyperParameterAlgorithmSpecification::WithMetricDefinitions ( const Aws::Vector< MetricDefinition > &  value)
inline

An array of MetricDefinition objects that specify the metrics that the algorithm emits.

Definition at line 254 of file HyperParameterAlgorithmSpecification.h.

◆ WithTrainingImage() [1/3]

HyperParameterAlgorithmSpecification& Aws::SageMaker::Model::HyperParameterAlgorithmSpecification::WithTrainingImage ( Aws::String &&  value)
inline

The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

Definition at line 134 of file HyperParameterAlgorithmSpecification.h.

◆ WithTrainingImage() [2/3]

HyperParameterAlgorithmSpecification& Aws::SageMaker::Model::HyperParameterAlgorithmSpecification::WithTrainingImage ( const Aws::String value)
inline

The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

Definition at line 121 of file HyperParameterAlgorithmSpecification.h.

◆ WithTrainingImage() [3/3]

HyperParameterAlgorithmSpecification& Aws::SageMaker::Model::HyperParameterAlgorithmSpecification::WithTrainingImage ( const char *  value)
inline

The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

Definition at line 147 of file HyperParameterAlgorithmSpecification.h.

◆ WithTrainingInputMode() [1/2]

HyperParameterAlgorithmSpecification& Aws::SageMaker::Model::HyperParameterAlgorithmSpecification::WithTrainingInputMode ( const TrainingInputMode value)
inline

Definition at line 163 of file HyperParameterAlgorithmSpecification.h.

◆ WithTrainingInputMode() [2/2]

HyperParameterAlgorithmSpecification& Aws::SageMaker::Model::HyperParameterAlgorithmSpecification::WithTrainingInputMode ( TrainingInputMode &&  value)
inline

Definition at line 166 of file HyperParameterAlgorithmSpecification.h.


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