AWS SDK for C++

AWS SDK for C++ Version 1.11.612

Loading...
Searching...
No Matches
TrainingSpecification.h
1
6#pragma once
7#include <aws/sagemaker/SageMaker_EXPORTS.h>
8#include <aws/core/utils/memory/stl/AWSString.h>
9#include <aws/core/utils/memory/stl/AWSVector.h>
10#include <aws/sagemaker/model/AdditionalS3DataSource.h>
11#include <aws/sagemaker/model/HyperParameterSpecification.h>
12#include <aws/sagemaker/model/TrainingInstanceType.h>
13#include <aws/sagemaker/model/MetricDefinition.h>
14#include <aws/sagemaker/model/ChannelSpecification.h>
15#include <aws/sagemaker/model/HyperParameterTuningJobObjective.h>
16#include <utility>
17
18namespace Aws
19{
20namespace Utils
21{
22namespace Json
23{
24 class JsonValue;
25 class JsonView;
26} // namespace Json
27} // namespace Utils
28namespace SageMaker
29{
30namespace Model
31{
32
40 {
41 public:
42 AWS_SAGEMAKER_API TrainingSpecification() = default;
45 AWS_SAGEMAKER_API Aws::Utils::Json::JsonValue Jsonize() const;
46
47
49
53 inline const Aws::String& GetTrainingImage() const { return m_trainingImage; }
54 inline bool TrainingImageHasBeenSet() const { return m_trainingImageHasBeenSet; }
55 template<typename TrainingImageT = Aws::String>
56 void SetTrainingImage(TrainingImageT&& value) { m_trainingImageHasBeenSet = true; m_trainingImage = std::forward<TrainingImageT>(value); }
57 template<typename TrainingImageT = Aws::String>
58 TrainingSpecification& WithTrainingImage(TrainingImageT&& value) { SetTrainingImage(std::forward<TrainingImageT>(value)); return *this;}
60
62
66 inline const Aws::String& GetTrainingImageDigest() const { return m_trainingImageDigest; }
67 inline bool TrainingImageDigestHasBeenSet() const { return m_trainingImageDigestHasBeenSet; }
68 template<typename TrainingImageDigestT = Aws::String>
69 void SetTrainingImageDigest(TrainingImageDigestT&& value) { m_trainingImageDigestHasBeenSet = true; m_trainingImageDigest = std::forward<TrainingImageDigestT>(value); }
70 template<typename TrainingImageDigestT = Aws::String>
71 TrainingSpecification& WithTrainingImageDigest(TrainingImageDigestT&& value) { SetTrainingImageDigest(std::forward<TrainingImageDigestT>(value)); return *this;}
73
75
80 inline const Aws::Vector<HyperParameterSpecification>& GetSupportedHyperParameters() const { return m_supportedHyperParameters; }
81 inline bool SupportedHyperParametersHasBeenSet() const { return m_supportedHyperParametersHasBeenSet; }
82 template<typename SupportedHyperParametersT = Aws::Vector<HyperParameterSpecification>>
83 void SetSupportedHyperParameters(SupportedHyperParametersT&& value) { m_supportedHyperParametersHasBeenSet = true; m_supportedHyperParameters = std::forward<SupportedHyperParametersT>(value); }
84 template<typename SupportedHyperParametersT = Aws::Vector<HyperParameterSpecification>>
85 TrainingSpecification& WithSupportedHyperParameters(SupportedHyperParametersT&& value) { SetSupportedHyperParameters(std::forward<SupportedHyperParametersT>(value)); return *this;}
86 template<typename SupportedHyperParametersT = HyperParameterSpecification>
87 TrainingSpecification& AddSupportedHyperParameters(SupportedHyperParametersT&& value) { m_supportedHyperParametersHasBeenSet = true; m_supportedHyperParameters.emplace_back(std::forward<SupportedHyperParametersT>(value)); return *this; }
89
91
94 inline const Aws::Vector<TrainingInstanceType>& GetSupportedTrainingInstanceTypes() const { return m_supportedTrainingInstanceTypes; }
95 inline bool SupportedTrainingInstanceTypesHasBeenSet() const { return m_supportedTrainingInstanceTypesHasBeenSet; }
96 template<typename SupportedTrainingInstanceTypesT = Aws::Vector<TrainingInstanceType>>
97 void SetSupportedTrainingInstanceTypes(SupportedTrainingInstanceTypesT&& value) { m_supportedTrainingInstanceTypesHasBeenSet = true; m_supportedTrainingInstanceTypes = std::forward<SupportedTrainingInstanceTypesT>(value); }
98 template<typename SupportedTrainingInstanceTypesT = Aws::Vector<TrainingInstanceType>>
99 TrainingSpecification& WithSupportedTrainingInstanceTypes(SupportedTrainingInstanceTypesT&& value) { SetSupportedTrainingInstanceTypes(std::forward<SupportedTrainingInstanceTypesT>(value)); return *this;}
100 inline TrainingSpecification& AddSupportedTrainingInstanceTypes(TrainingInstanceType value) { m_supportedTrainingInstanceTypesHasBeenSet = true; m_supportedTrainingInstanceTypes.push_back(value); return *this; }
102
104
108 inline bool GetSupportsDistributedTraining() const { return m_supportsDistributedTraining; }
109 inline bool SupportsDistributedTrainingHasBeenSet() const { return m_supportsDistributedTrainingHasBeenSet; }
110 inline void SetSupportsDistributedTraining(bool value) { m_supportsDistributedTrainingHasBeenSet = true; m_supportsDistributedTraining = value; }
113
115
119 inline const Aws::Vector<MetricDefinition>& GetMetricDefinitions() const { return m_metricDefinitions; }
120 inline bool MetricDefinitionsHasBeenSet() const { return m_metricDefinitionsHasBeenSet; }
121 template<typename MetricDefinitionsT = Aws::Vector<MetricDefinition>>
122 void SetMetricDefinitions(MetricDefinitionsT&& value) { m_metricDefinitionsHasBeenSet = true; m_metricDefinitions = std::forward<MetricDefinitionsT>(value); }
123 template<typename MetricDefinitionsT = Aws::Vector<MetricDefinition>>
124 TrainingSpecification& WithMetricDefinitions(MetricDefinitionsT&& value) { SetMetricDefinitions(std::forward<MetricDefinitionsT>(value)); return *this;}
125 template<typename MetricDefinitionsT = MetricDefinition>
126 TrainingSpecification& AddMetricDefinitions(MetricDefinitionsT&& value) { m_metricDefinitionsHasBeenSet = true; m_metricDefinitions.emplace_back(std::forward<MetricDefinitionsT>(value)); return *this; }
128
130
134 inline const Aws::Vector<ChannelSpecification>& GetTrainingChannels() const { return m_trainingChannels; }
135 inline bool TrainingChannelsHasBeenSet() const { return m_trainingChannelsHasBeenSet; }
136 template<typename TrainingChannelsT = Aws::Vector<ChannelSpecification>>
137 void SetTrainingChannels(TrainingChannelsT&& value) { m_trainingChannelsHasBeenSet = true; m_trainingChannels = std::forward<TrainingChannelsT>(value); }
138 template<typename TrainingChannelsT = Aws::Vector<ChannelSpecification>>
139 TrainingSpecification& WithTrainingChannels(TrainingChannelsT&& value) { SetTrainingChannels(std::forward<TrainingChannelsT>(value)); return *this;}
140 template<typename TrainingChannelsT = ChannelSpecification>
141 TrainingSpecification& AddTrainingChannels(TrainingChannelsT&& value) { m_trainingChannelsHasBeenSet = true; m_trainingChannels.emplace_back(std::forward<TrainingChannelsT>(value)); return *this; }
143
145
149 inline const Aws::Vector<HyperParameterTuningJobObjective>& GetSupportedTuningJobObjectiveMetrics() const { return m_supportedTuningJobObjectiveMetrics; }
150 inline bool SupportedTuningJobObjectiveMetricsHasBeenSet() const { return m_supportedTuningJobObjectiveMetricsHasBeenSet; }
151 template<typename SupportedTuningJobObjectiveMetricsT = Aws::Vector<HyperParameterTuningJobObjective>>
152 void SetSupportedTuningJobObjectiveMetrics(SupportedTuningJobObjectiveMetricsT&& value) { m_supportedTuningJobObjectiveMetricsHasBeenSet = true; m_supportedTuningJobObjectiveMetrics = std::forward<SupportedTuningJobObjectiveMetricsT>(value); }
153 template<typename SupportedTuningJobObjectiveMetricsT = Aws::Vector<HyperParameterTuningJobObjective>>
154 TrainingSpecification& WithSupportedTuningJobObjectiveMetrics(SupportedTuningJobObjectiveMetricsT&& value) { SetSupportedTuningJobObjectiveMetrics(std::forward<SupportedTuningJobObjectiveMetricsT>(value)); return *this;}
155 template<typename SupportedTuningJobObjectiveMetricsT = HyperParameterTuningJobObjective>
156 TrainingSpecification& AddSupportedTuningJobObjectiveMetrics(SupportedTuningJobObjectiveMetricsT&& value) { m_supportedTuningJobObjectiveMetricsHasBeenSet = true; m_supportedTuningJobObjectiveMetrics.emplace_back(std::forward<SupportedTuningJobObjectiveMetricsT>(value)); return *this; }
158
160
163 inline const AdditionalS3DataSource& GetAdditionalS3DataSource() const { return m_additionalS3DataSource; }
164 inline bool AdditionalS3DataSourceHasBeenSet() const { return m_additionalS3DataSourceHasBeenSet; }
165 template<typename AdditionalS3DataSourceT = AdditionalS3DataSource>
166 void SetAdditionalS3DataSource(AdditionalS3DataSourceT&& value) { m_additionalS3DataSourceHasBeenSet = true; m_additionalS3DataSource = std::forward<AdditionalS3DataSourceT>(value); }
167 template<typename AdditionalS3DataSourceT = AdditionalS3DataSource>
168 TrainingSpecification& WithAdditionalS3DataSource(AdditionalS3DataSourceT&& value) { SetAdditionalS3DataSource(std::forward<AdditionalS3DataSourceT>(value)); return *this;}
170 private:
171
172 Aws::String m_trainingImage;
173 bool m_trainingImageHasBeenSet = false;
174
175 Aws::String m_trainingImageDigest;
176 bool m_trainingImageDigestHasBeenSet = false;
177
178 Aws::Vector<HyperParameterSpecification> m_supportedHyperParameters;
179 bool m_supportedHyperParametersHasBeenSet = false;
180
181 Aws::Vector<TrainingInstanceType> m_supportedTrainingInstanceTypes;
182 bool m_supportedTrainingInstanceTypesHasBeenSet = false;
183
184 bool m_supportsDistributedTraining{false};
185 bool m_supportsDistributedTrainingHasBeenSet = false;
186
187 Aws::Vector<MetricDefinition> m_metricDefinitions;
188 bool m_metricDefinitionsHasBeenSet = false;
189
190 Aws::Vector<ChannelSpecification> m_trainingChannels;
191 bool m_trainingChannelsHasBeenSet = false;
192
193 Aws::Vector<HyperParameterTuningJobObjective> m_supportedTuningJobObjectiveMetrics;
194 bool m_supportedTuningJobObjectiveMetricsHasBeenSet = false;
195
196 AdditionalS3DataSource m_additionalS3DataSource;
197 bool m_additionalS3DataSourceHasBeenSet = false;
198 };
199
200} // namespace Model
201} // namespace SageMaker
202} // namespace Aws
TrainingSpecification & WithTrainingImage(TrainingImageT &&value)
TrainingSpecification & WithAdditionalS3DataSource(AdditionalS3DataSourceT &&value)
AWS_SAGEMAKER_API Aws::Utils::Json::JsonValue Jsonize() const
TrainingSpecification & WithSupportedTuningJobObjectiveMetrics(SupportedTuningJobObjectiveMetricsT &&value)
const Aws::Vector< TrainingInstanceType > & GetSupportedTrainingInstanceTypes() const
AWS_SAGEMAKER_API TrainingSpecification & operator=(Aws::Utils::Json::JsonView jsonValue)
TrainingSpecification & WithTrainingImageDigest(TrainingImageDigestT &&value)
const Aws::Vector< MetricDefinition > & GetMetricDefinitions() const
AWS_SAGEMAKER_API TrainingSpecification()=default
void SetMetricDefinitions(MetricDefinitionsT &&value)
void SetSupportedHyperParameters(SupportedHyperParametersT &&value)
void SetTrainingImageDigest(TrainingImageDigestT &&value)
TrainingSpecification & AddMetricDefinitions(MetricDefinitionsT &&value)
const AdditionalS3DataSource & GetAdditionalS3DataSource() const
TrainingSpecification & WithSupportsDistributedTraining(bool value)
const Aws::Vector< HyperParameterTuningJobObjective > & GetSupportedTuningJobObjectiveMetrics() const
const Aws::Vector< HyperParameterSpecification > & GetSupportedHyperParameters() const
TrainingSpecification & AddSupportedTrainingInstanceTypes(TrainingInstanceType value)
void SetAdditionalS3DataSource(AdditionalS3DataSourceT &&value)
AWS_SAGEMAKER_API TrainingSpecification(Aws::Utils::Json::JsonView jsonValue)
TrainingSpecification & WithSupportedHyperParameters(SupportedHyperParametersT &&value)
void SetTrainingChannels(TrainingChannelsT &&value)
void SetSupportedTuningJobObjectiveMetrics(SupportedTuningJobObjectiveMetricsT &&value)
TrainingSpecification & AddTrainingChannels(TrainingChannelsT &&value)
TrainingSpecification & WithMetricDefinitions(MetricDefinitionsT &&value)
TrainingSpecification & AddSupportedHyperParameters(SupportedHyperParametersT &&value)
TrainingSpecification & WithSupportedTrainingInstanceTypes(SupportedTrainingInstanceTypesT &&value)
TrainingSpecification & AddSupportedTuningJobObjectiveMetrics(SupportedTuningJobObjectiveMetricsT &&value)
TrainingSpecification & WithTrainingChannels(TrainingChannelsT &&value)
void SetSupportedTrainingInstanceTypes(SupportedTrainingInstanceTypesT &&value)
const Aws::Vector< ChannelSpecification > & GetTrainingChannels() const
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector
Aws::Utils::Json::JsonValue JsonValue