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

#include <AlgorithmSpecification.h>

Public Member Functions

 AlgorithmSpecification ()
 
 AlgorithmSpecification (Aws::Utils::Json::JsonView jsonValue)
 
AlgorithmSpecificationoperator= (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)
 
AlgorithmSpecificationWithTrainingImage (const Aws::String &value)
 
AlgorithmSpecificationWithTrainingImage (Aws::String &&value)
 
AlgorithmSpecificationWithTrainingImage (const char *value)
 
const Aws::StringGetAlgorithmName () const
 
bool AlgorithmNameHasBeenSet () const
 
void SetAlgorithmName (const Aws::String &value)
 
void SetAlgorithmName (Aws::String &&value)
 
void SetAlgorithmName (const char *value)
 
AlgorithmSpecificationWithAlgorithmName (const Aws::String &value)
 
AlgorithmSpecificationWithAlgorithmName (Aws::String &&value)
 
AlgorithmSpecificationWithAlgorithmName (const char *value)
 
const TrainingInputModeGetTrainingInputMode () const
 
bool TrainingInputModeHasBeenSet () const
 
void SetTrainingInputMode (const TrainingInputMode &value)
 
void SetTrainingInputMode (TrainingInputMode &&value)
 
AlgorithmSpecificationWithTrainingInputMode (const TrainingInputMode &value)
 
AlgorithmSpecificationWithTrainingInputMode (TrainingInputMode &&value)
 
const Aws::Vector< MetricDefinition > & GetMetricDefinitions () const
 
bool MetricDefinitionsHasBeenSet () const
 
void SetMetricDefinitions (const Aws::Vector< MetricDefinition > &value)
 
void SetMetricDefinitions (Aws::Vector< MetricDefinition > &&value)
 
AlgorithmSpecificationWithMetricDefinitions (const Aws::Vector< MetricDefinition > &value)
 
AlgorithmSpecificationWithMetricDefinitions (Aws::Vector< MetricDefinition > &&value)
 
AlgorithmSpecificationAddMetricDefinitions (const MetricDefinition &value)
 
AlgorithmSpecificationAddMetricDefinitions (MetricDefinition &&value)
 
bool GetEnableSageMakerMetricsTimeSeries () const
 
bool EnableSageMakerMetricsTimeSeriesHasBeenSet () const
 
void SetEnableSageMakerMetricsTimeSeries (bool value)
 
AlgorithmSpecificationWithEnableSageMakerMetricsTimeSeries (bool value)
 

Detailed Description

Specifies the training algorithm to use in a CreateTrainingJob request.

For more information about algorithms provided by Amazon SageMaker, see Algorithms. For information about using your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.

See Also:

AWS API Reference

Definition at line 40 of file AlgorithmSpecification.h.

Constructor & Destructor Documentation

◆ AlgorithmSpecification() [1/2]

Aws::SageMaker::Model::AlgorithmSpecification::AlgorithmSpecification ( )

◆ AlgorithmSpecification() [2/2]

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

Member Function Documentation

◆ AddMetricDefinitions() [1/2]

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

A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. Amazon SageMaker publishes each metric to Amazon CloudWatch.

Definition at line 285 of file AlgorithmSpecification.h.

◆ AddMetricDefinitions() [2/2]

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

A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. Amazon SageMaker publishes each metric to Amazon CloudWatch.

Definition at line 292 of file AlgorithmSpecification.h.

◆ AlgorithmNameHasBeenSet()

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

The name of the algorithm resource to use for the training job. This must be an algorithm resource that you created or subscribe to on Amazon Web Services Marketplace. If you specify a value for this parameter, you can't specify a value for TrainingImage.

Definition at line 168 of file AlgorithmSpecification.h.

◆ EnableSageMakerMetricsTimeSeriesHasBeenSet()

bool Aws::SageMaker::Model::AlgorithmSpecification::EnableSageMakerMetricsTimeSeriesHasBeenSet ( ) const
inline

To generate and save time-series metrics during training, set to true. The default is false and time-series metrics aren't generated except in the following cases:

Definition at line 321 of file AlgorithmSpecification.h.

◆ GetAlgorithmName()

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

The name of the algorithm resource to use for the training job. This must be an algorithm resource that you created or subscribe to on Amazon Web Services Marketplace. If you specify a value for this parameter, you can't specify a value for TrainingImage.

Definition at line 160 of file AlgorithmSpecification.h.

◆ GetEnableSageMakerMetricsTimeSeries()

bool Aws::SageMaker::Model::AlgorithmSpecification::GetEnableSageMakerMetricsTimeSeries ( ) const
inline

To generate and save time-series metrics during training, set to true. The default is false and time-series metrics aren't generated except in the following cases:

Definition at line 307 of file AlgorithmSpecification.h.

◆ GetMetricDefinitions()

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

A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. Amazon SageMaker publishes each metric to Amazon CloudWatch.

Definition at line 243 of file AlgorithmSpecification.h.

◆ GetTrainingImage()

const Aws::String& Aws::SageMaker::Model::AlgorithmSpecification::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 60 of file AlgorithmSpecification.h.

◆ GetTrainingInputMode()

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

Definition at line 220 of file AlgorithmSpecification.h.

◆ Jsonize()

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

◆ MetricDefinitionsHasBeenSet()

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

A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. Amazon SageMaker publishes each metric to Amazon CloudWatch.

Definition at line 250 of file AlgorithmSpecification.h.

◆ operator=()

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

◆ SetAlgorithmName() [1/3]

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

The name of the algorithm resource to use for the training job. This must be an algorithm resource that you created or subscribe to on Amazon Web Services Marketplace. If you specify a value for this parameter, you can't specify a value for TrainingImage.

Definition at line 184 of file AlgorithmSpecification.h.

◆ SetAlgorithmName() [2/3]

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

The name of the algorithm resource to use for the training job. This must be an algorithm resource that you created or subscribe to on Amazon Web Services Marketplace. If you specify a value for this parameter, you can't specify a value for TrainingImage.

Definition at line 176 of file AlgorithmSpecification.h.

◆ SetAlgorithmName() [3/3]

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

The name of the algorithm resource to use for the training job. This must be an algorithm resource that you created or subscribe to on Amazon Web Services Marketplace. If you specify a value for this parameter, you can't specify a value for TrainingImage.

Definition at line 192 of file AlgorithmSpecification.h.

◆ SetEnableSageMakerMetricsTimeSeries()

void Aws::SageMaker::Model::AlgorithmSpecification::SetEnableSageMakerMetricsTimeSeries ( bool  value)
inline

To generate and save time-series metrics during training, set to true. The default is false and time-series metrics aren't generated except in the following cases:

Definition at line 335 of file AlgorithmSpecification.h.

◆ SetMetricDefinitions() [1/2]

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

A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. Amazon SageMaker publishes each metric to Amazon CloudWatch.

Definition at line 264 of file AlgorithmSpecification.h.

◆ SetMetricDefinitions() [2/2]

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

A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. Amazon SageMaker publishes each metric to Amazon CloudWatch.

Definition at line 257 of file AlgorithmSpecification.h.

◆ SetTrainingImage() [1/3]

void Aws::SageMaker::Model::AlgorithmSpecification::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 99 of file AlgorithmSpecification.h.

◆ SetTrainingImage() [2/3]

void Aws::SageMaker::Model::AlgorithmSpecification::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 86 of file AlgorithmSpecification.h.

◆ SetTrainingImage() [3/3]

void Aws::SageMaker::Model::AlgorithmSpecification::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 112 of file AlgorithmSpecification.h.

◆ SetTrainingInputMode() [1/2]

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

Definition at line 226 of file AlgorithmSpecification.h.

◆ SetTrainingInputMode() [2/2]

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

Definition at line 229 of file AlgorithmSpecification.h.

◆ TrainingImageHasBeenSet()

bool Aws::SageMaker::Model::AlgorithmSpecification::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 73 of file AlgorithmSpecification.h.

◆ TrainingInputModeHasBeenSet()

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

Definition at line 223 of file AlgorithmSpecification.h.

◆ WithAlgorithmName() [1/3]

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

The name of the algorithm resource to use for the training job. This must be an algorithm resource that you created or subscribe to on Amazon Web Services Marketplace. If you specify a value for this parameter, you can't specify a value for TrainingImage.

Definition at line 208 of file AlgorithmSpecification.h.

◆ WithAlgorithmName() [2/3]

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

The name of the algorithm resource to use for the training job. This must be an algorithm resource that you created or subscribe to on Amazon Web Services Marketplace. If you specify a value for this parameter, you can't specify a value for TrainingImage.

Definition at line 200 of file AlgorithmSpecification.h.

◆ WithAlgorithmName() [3/3]

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

The name of the algorithm resource to use for the training job. This must be an algorithm resource that you created or subscribe to on Amazon Web Services Marketplace. If you specify a value for this parameter, you can't specify a value for TrainingImage.

Definition at line 216 of file AlgorithmSpecification.h.

◆ WithEnableSageMakerMetricsTimeSeries()

AlgorithmSpecification& Aws::SageMaker::Model::AlgorithmSpecification::WithEnableSageMakerMetricsTimeSeries ( bool  value)
inline

To generate and save time-series metrics during training, set to true. The default is false and time-series metrics aren't generated except in the following cases:

Definition at line 349 of file AlgorithmSpecification.h.

◆ WithMetricDefinitions() [1/2]

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

A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. Amazon SageMaker publishes each metric to Amazon CloudWatch.

Definition at line 278 of file AlgorithmSpecification.h.

◆ WithMetricDefinitions() [2/2]

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

A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. Amazon SageMaker publishes each metric to Amazon CloudWatch.

Definition at line 271 of file AlgorithmSpecification.h.

◆ WithTrainingImage() [1/3]

AlgorithmSpecification& Aws::SageMaker::Model::AlgorithmSpecification::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 138 of file AlgorithmSpecification.h.

◆ WithTrainingImage() [2/3]

AlgorithmSpecification& Aws::SageMaker::Model::AlgorithmSpecification::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 125 of file AlgorithmSpecification.h.

◆ WithTrainingImage() [3/3]

AlgorithmSpecification& Aws::SageMaker::Model::AlgorithmSpecification::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 151 of file AlgorithmSpecification.h.

◆ WithTrainingInputMode() [1/2]

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

Definition at line 232 of file AlgorithmSpecification.h.

◆ WithTrainingInputMode() [2/2]

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

Definition at line 235 of file AlgorithmSpecification.h.


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