blib/lib/Paws/SageMaker/CreateTrainingJob.pm untested

filter: Statementstmt 0.0% 0 / 31 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 33 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::SageMaker::CreateTrainingJob;
3 use Moose;
4 has AlgorithmSpecification => (is => 'ro', isa => 'Paws::SageMaker::AlgorithmSpecification', required => 1);
5 has CheckpointConfig => (is => 'ro', isa => 'Paws::SageMaker::CheckpointConfig');
6 has DebugHookConfig => (is => 'ro', isa => 'Paws::SageMaker::DebugHookConfig');
7 has DebugRuleConfigurations => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::DebugRuleConfiguration]');
8 has EnableInterContainerTrafficEncryption => (is => 'ro', isa => 'Bool');
9 has EnableManagedSpotTraining => (is => 'ro', isa => 'Bool');
10 has EnableNetworkIsolation => (is => 'ro', isa => 'Bool');
11 has Environment => (is => 'ro', isa => 'Paws::SageMaker::TrainingEnvironmentMap');
12 has ExperimentConfig => (is => 'ro', isa => 'Paws::SageMaker::ExperimentConfig');
13 has HyperParameters => (is => 'ro', isa => 'Paws::SageMaker::HyperParameters');
14 has InputDataConfig => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::Channel]');
15 has OutputDataConfig => (is => 'ro', isa => 'Paws::SageMaker::OutputDataConfig', required => 1);
16 has ProfilerConfig => (is => 'ro', isa => 'Paws::SageMaker::ProfilerConfig');
17 has ProfilerRuleConfigurations => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::ProfilerRuleConfiguration]');
18 has ResourceConfig => (is => 'ro', isa => 'Paws::SageMaker::ResourceConfig', required => 1);
19 has RetryStrategy => (is => 'ro', isa => 'Paws::SageMaker::RetryStrategy');
20 has RoleArn => (is => 'ro', isa => 'Str', required => 1);
21 has StoppingCondition => (is => 'ro', isa => 'Paws::SageMaker::StoppingCondition', required => 1);
22 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::Tag]');
23 has TensorBoardOutputConfig => (is => 'ro', isa => 'Paws::SageMaker::TensorBoardOutputConfig');
24 has TrainingJobName => (is => 'ro', isa => 'Str', required => 1);
25 has VpcConfig => (is => 'ro', isa => 'Paws::SageMaker::VpcConfig');
26  
27 use MooseX::ClassAttribute;
28  
29 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateTrainingJob');
30 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SageMaker::CreateTrainingJobResponse');
31 class_has _result_key => (isa => 'Str', is => 'ro');
32 1;
33  
34 ### main pod documentation begin ###
35  
36 =head1 NAME
37  
38 Paws::SageMaker::CreateTrainingJob - Arguments for method CreateTrainingJob on L<Paws::SageMaker>
39  
40 =head1 DESCRIPTION
41  
42 This class represents the parameters used for calling the method CreateTrainingJob on the
43 L<Amazon SageMaker Service|Paws::SageMaker> service. Use the attributes of this class
44 as arguments to method CreateTrainingJob.
45  
46 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateTrainingJob.
47  
48 =head1 SYNOPSIS
49  
50 my $api.sagemaker = Paws->service('SageMaker');
51 my $CreateTrainingJobResponse = $api . sagemaker->CreateTrainingJob(
52 AlgorithmSpecification => {
53 TrainingInputMode => 'Pipe', # values: Pipe, File
54 AlgorithmName => 'MyArnOrName', # min: 1, max: 170; OPTIONAL
55 EnableSageMakerMetricsTimeSeries => 1, # OPTIONAL
56 MetricDefinitions => [
57 {
58 Name => 'MyMetricName', # min: 1, max: 255
59 Regex => 'MyMetricRegex', # min: 1, max: 500
60  
61 },
62 ...
63 ], # max: 40; OPTIONAL
64 TrainingImage => 'MyAlgorithmImage', # max: 255; OPTIONAL
65 },
66 OutputDataConfig => {
67 S3OutputPath => 'MyS3Uri', # max: 1024
68 KmsKeyId => 'MyKmsKeyId', # max: 2048; OPTIONAL
69 },
70 ResourceConfig => {
71 InstanceCount => 1, # min: 1
72 InstanceType => 'ml.m4.xlarge'
73 , # values: ml.m4.xlarge, ml.m4.2xlarge, ml.m4.4xlarge, ml.m4.10xlarge, ml.m4.16xlarge, ml.g4dn.xlarge, ml.g4dn.2xlarge, ml.g4dn.4xlarge, ml.g4dn.8xlarge, ml.g4dn.12xlarge, ml.g4dn.16xlarge, ml.m5.large, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.12xlarge, ml.m5.24xlarge, ml.c4.xlarge, ml.c4.2xlarge, ml.c4.4xlarge, ml.c4.8xlarge, ml.p2.xlarge, ml.p2.8xlarge, ml.p2.16xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.p3dn.24xlarge, ml.p4d.24xlarge, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.18xlarge, ml.c5n.xlarge, ml.c5n.2xlarge, ml.c5n.4xlarge, ml.c5n.9xlarge, ml.c5n.18xlarge
74 VolumeSizeInGB => 1, # min: 1
75 VolumeKmsKeyId => 'MyKmsKeyId', # max: 2048; OPTIONAL
76 },
77 RoleArn => 'MyRoleArn',
78 StoppingCondition => {
79 MaxRuntimeInSeconds => 1, # min: 1; OPTIONAL
80 MaxWaitTimeInSeconds => 1, # min: 1; OPTIONAL
81 },
82 TrainingJobName => 'MyTrainingJobName',
83 CheckpointConfig => {
84 S3Uri => 'MyS3Uri', # max: 1024
85 LocalPath => 'MyDirectoryPath', # max: 4096; OPTIONAL
86 }, # OPTIONAL
87 DebugHookConfig => {
88 S3OutputPath => 'MyS3Uri', # max: 1024
89 CollectionConfigurations => [
90 {
91 CollectionName => 'MyCollectionName', # min: 1, max: 256; OPTIONAL
92 CollectionParameters => {
93 'MyConfigKey' =>
94 'MyConfigValue', # key: min: 1, max: 256, value: max: 256
95 }, # max: 20; OPTIONAL
96 },
97 ...
98 ], # max: 20; OPTIONAL
99 HookParameters => {
100 'MyConfigKey' =>
101 'MyConfigValue', # key: min: 1, max: 256, value: max: 256
102 }, # max: 20; OPTIONAL
103 LocalPath => 'MyDirectoryPath', # max: 4096; OPTIONAL
104 }, # OPTIONAL
105 DebugRuleConfigurations => [
106 {
107 RuleConfigurationName => 'MyRuleConfigurationName', # min: 1, max: 256
108 RuleEvaluatorImage => 'MyAlgorithmImage', # max: 255; OPTIONAL
109 InstanceType => 'ml.t3.medium'
110 , # values: ml.t3.medium, ml.t3.large, ml.t3.xlarge, ml.t3.2xlarge, ml.m4.xlarge, ml.m4.2xlarge, ml.m4.4xlarge, ml.m4.10xlarge, ml.m4.16xlarge, ml.c4.xlarge, ml.c4.2xlarge, ml.c4.4xlarge, ml.c4.8xlarge, ml.p2.xlarge, ml.p2.8xlarge, ml.p2.16xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.18xlarge, ml.m5.large, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.12xlarge, ml.m5.24xlarge, ml.r5.large, ml.r5.xlarge, ml.r5.2xlarge, ml.r5.4xlarge, ml.r5.8xlarge, ml.r5.12xlarge, ml.r5.16xlarge, ml.r5.24xlarge, ml.g4dn.xlarge, ml.g4dn.2xlarge, ml.g4dn.4xlarge, ml.g4dn.8xlarge, ml.g4dn.12xlarge, ml.g4dn.16xlarge; OPTIONAL
111 LocalPath => 'MyDirectoryPath', # max: 4096; OPTIONAL
112 RuleParameters => {
113 'MyConfigKey' =>
114 'MyConfigValue', # key: min: 1, max: 256, value: max: 256
115 }, # max: 100; OPTIONAL
116 S3OutputPath => 'MyS3Uri', # max: 1024
117 VolumeSizeInGB => 1, # OPTIONAL
118 },
119 ...
120 ], # OPTIONAL
121 EnableInterContainerTrafficEncryption => 1, # OPTIONAL
122 EnableManagedSpotTraining => 1, # OPTIONAL
123 EnableNetworkIsolation => 1, # OPTIONAL
124 Environment => {
125 'MyTrainingEnvironmentKey' =>
126 'MyTrainingEnvironmentValue', # key: max: 512, value: max: 512
127 }, # OPTIONAL
128 ExperimentConfig => {
129 ExperimentName => 'MyExperimentEntityName', # min: 1, max: 120; OPTIONAL
130 TrialComponentDisplayName =>
131 'MyExperimentEntityName', # min: 1, max: 120; OPTIONAL
132 TrialName => 'MyExperimentEntityName', # min: 1, max: 120; OPTIONAL
133 }, # OPTIONAL
134 HyperParameters => {
135 'MyHyperParameterKey' =>
136 'MyHyperParameterValue', # key: max: 256, value: max: 2500
137 }, # OPTIONAL
138 InputDataConfig => [
139 {
140 ChannelName => 'MyChannelName', # min: 1, max: 64
141 DataSource => {
142 FileSystemDataSource => {
143 DirectoryPath => 'MyDirectoryPath', # max: 4096; OPTIONAL
144 FileSystemAccessMode => 'rw', # values: rw, ro
145 FileSystemId => 'MyFileSystemId', # min: 11
146 FileSystemType => 'EFS', # values: EFS, FSxLustre
147  
148 }, # OPTIONAL
149 S3DataSource => {
150 S3DataType => 'ManifestFile'
151 , # values: ManifestFile, S3Prefix, AugmentedManifestFile
152 S3Uri => 'MyS3Uri', # max: 1024
153 AttributeNames => [
154 'MyAttributeName', ... # min: 1, max: 256
155 ], # max: 16; OPTIONAL
156 S3DataDistributionType => 'FullyReplicated'
157 , # values: FullyReplicated, ShardedByS3Key; OPTIONAL
158 }, # OPTIONAL
159 },
160 CompressionType => 'None', # values: None, Gzip; OPTIONAL
161 ContentType => 'MyContentType', # max: 256; OPTIONAL
162 InputMode => 'Pipe', # values: Pipe, File
163 RecordWrapperType => 'None', # values: None, RecordIO; OPTIONAL
164 ShuffleConfig => {
165 Seed => 1,
166  
167 }, # OPTIONAL
168 },
169 ...
170 ], # OPTIONAL
171 ProfilerConfig => {
172 S3OutputPath => 'MyS3Uri', # max: 1024
173 ProfilingIntervalInMilliseconds => 1, # OPTIONAL
174 ProfilingParameters => {
175 'MyConfigKey' =>
176 'MyConfigValue', # key: min: 1, max: 256, value: max: 256
177 }, # max: 20; OPTIONAL
178 }, # OPTIONAL
179 ProfilerRuleConfigurations => [
180 {
181 RuleConfigurationName => 'MyRuleConfigurationName', # min: 1, max: 256
182 RuleEvaluatorImage => 'MyAlgorithmImage', # max: 255; OPTIONAL
183 InstanceType => 'ml.t3.medium'
184 , # values: ml.t3.medium, ml.t3.large, ml.t3.xlarge, ml.t3.2xlarge, ml.m4.xlarge, ml.m4.2xlarge, ml.m4.4xlarge, ml.m4.10xlarge, ml.m4.16xlarge, ml.c4.xlarge, ml.c4.2xlarge, ml.c4.4xlarge, ml.c4.8xlarge, ml.p2.xlarge, ml.p2.8xlarge, ml.p2.16xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.18xlarge, ml.m5.large, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.12xlarge, ml.m5.24xlarge, ml.r5.large, ml.r5.xlarge, ml.r5.2xlarge, ml.r5.4xlarge, ml.r5.8xlarge, ml.r5.12xlarge, ml.r5.16xlarge, ml.r5.24xlarge, ml.g4dn.xlarge, ml.g4dn.2xlarge, ml.g4dn.4xlarge, ml.g4dn.8xlarge, ml.g4dn.12xlarge, ml.g4dn.16xlarge; OPTIONAL
185 LocalPath => 'MyDirectoryPath', # max: 4096; OPTIONAL
186 RuleParameters => {
187 'MyConfigKey' =>
188 'MyConfigValue', # key: min: 1, max: 256, value: max: 256
189 }, # max: 100; OPTIONAL
190 S3OutputPath => 'MyS3Uri', # max: 1024
191 VolumeSizeInGB => 1, # OPTIONAL
192 },
193 ...
194 ], # OPTIONAL
195 RetryStrategy => {
196 MaximumRetryAttempts => 1, # min: 1, max: 30
197  
198 }, # OPTIONAL
199 Tags => [
200 {
201 Key => 'MyTagKey', # min: 1, max: 128
202 Value => 'MyTagValue', # max: 256
203  
204 },
205 ...
206 ], # OPTIONAL
207 TensorBoardOutputConfig => {
208 S3OutputPath => 'MyS3Uri', # max: 1024
209 LocalPath => 'MyDirectoryPath', # max: 4096; OPTIONAL
210 }, # OPTIONAL
211 VpcConfig => {
212 SecurityGroupIds => [
213 'MySecurityGroupId', ... # max: 32
214 ], # min: 1, max: 5
215 Subnets => [
216 'MySubnetId', ... # max: 32
217 ], # min: 1, max: 16
218  
219 }, # OPTIONAL
220 );
221  
222 # Results:
223 my $TrainingJobArn = $CreateTrainingJobResponse->TrainingJobArn;
224  
225 # Returns a L<Paws::SageMaker::CreateTrainingJobResponse> object.
226  
227 Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
228 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.sagemaker/CreateTrainingJob>
229  
230 =head1 ATTRIBUTES
231  
232  
233 =head2 B<REQUIRED> AlgorithmSpecification => L<Paws::SageMaker::AlgorithmSpecification>
234  
235 The registry path of the Docker image that contains the training
236 algorithm and algorithm-specific metadata, including the input mode.
237 For more information about algorithms provided by Amazon SageMaker, see
238 Algorithms
239 (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html). For
240 information about providing your own algorithms, see Using Your Own
241 Algorithms with Amazon SageMaker
242 (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html).
243  
244  
245  
246 =head2 CheckpointConfig => L<Paws::SageMaker::CheckpointConfig>
247  
248 Contains information about the output location for managed spot
249 training checkpoint data.
250  
251  
252  
253 =head2 DebugHookConfig => L<Paws::SageMaker::DebugHookConfig>
254  
255  
256  
257  
258  
259 =head2 DebugRuleConfigurations => ArrayRef[L<Paws::SageMaker::DebugRuleConfiguration>]
260  
261 Configuration information for Debugger rules for debugging output
262 tensors.
263  
264  
265  
266 =head2 EnableInterContainerTrafficEncryption => Bool
267  
268 To encrypt all communications between ML compute instances in
269 distributed training, choose C<True>. Encryption provides greater
270 security for distributed training, but training might take longer. How
271 long it takes depends on the amount of communication between compute
272 instances, especially if you use a deep learning algorithm in
273 distributed training. For more information, see Protect Communications
274 Between ML Compute Instances in a Distributed Training Job
275 (https://docs.aws.amazon.com/sagemaker/latest/dg/train-encrypt.html).
276  
277  
278  
279 =head2 EnableManagedSpotTraining => Bool
280  
281 To train models using managed spot training, choose C<True>. Managed
282 spot training provides a fully managed and scalable infrastructure for
283 training machine learning models. this option is useful when training
284 jobs can be interrupted and when there is flexibility when the training
285 job is run.
286  
287 The complete and intermediate results of jobs are stored in an Amazon
288 S3 bucket, and can be used as a starting point to train models
289 incrementally. Amazon SageMaker provides metrics and logs in
290 CloudWatch. They can be used to see when managed spot training jobs are
291 running, interrupted, resumed, or completed.
292  
293  
294  
295 =head2 EnableNetworkIsolation => Bool
296  
297 Isolates the training container. No inbound or outbound network calls
298 can be made, except for calls between peers within a training cluster
299 for distributed training. If you enable network isolation for training
300 jobs that are configured to use a VPC, Amazon SageMaker downloads and
301 uploads customer data and model artifacts through the specified VPC,
302 but the training container does not have network access.
303  
304  
305  
306 =head2 Environment => L<Paws::SageMaker::TrainingEnvironmentMap>
307  
308 The environment variables to set in the Docker container.
309  
310  
311  
312 =head2 ExperimentConfig => L<Paws::SageMaker::ExperimentConfig>
313  
314  
315  
316  
317  
318 =head2 HyperParameters => L<Paws::SageMaker::HyperParameters>
319  
320 Algorithm-specific parameters that influence the quality of the model.
321 You set hyperparameters before you start the learning process. For a
322 list of hyperparameters for each training algorithm provided by Amazon
323 SageMaker, see Algorithms
324 (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html).
325  
326 You can specify a maximum of 100 hyperparameters. Each hyperparameter
327 is a key-value pair. Each key and value is limited to 256 characters,
328 as specified by the C<Length Constraint>.
329  
330  
331  
332 =head2 InputDataConfig => ArrayRef[L<Paws::SageMaker::Channel>]
333  
334 An array of C<Channel> objects. Each channel is a named input source.
335 C<InputDataConfig> describes the input data and its location.
336  
337 Algorithms can accept input data from one or more channels. For
338 example, an algorithm might have two channels of input data,
339 C<training_data> and C<validation_data>. The configuration for each
340 channel provides the S3, EFS, or FSx location where the input data is
341 stored. It also provides information about the stored data: the MIME
342 type, compression method, and whether the data is wrapped in RecordIO
343 format.
344  
345 Depending on the input mode that the algorithm supports, Amazon
346 SageMaker either copies input data files from an S3 bucket to a local
347 directory in the Docker container, or makes it available as input
348 streams. For example, if you specify an EFS location, input data files
349 will be made available as input streams. They do not need to be
350 downloaded.
351  
352  
353  
354 =head2 B<REQUIRED> OutputDataConfig => L<Paws::SageMaker::OutputDataConfig>
355  
356 Specifies the path to the S3 location where you want to store model
357 artifacts. Amazon SageMaker creates subfolders for the artifacts.
358  
359  
360  
361 =head2 ProfilerConfig => L<Paws::SageMaker::ProfilerConfig>
362  
363  
364  
365  
366  
367 =head2 ProfilerRuleConfigurations => ArrayRef[L<Paws::SageMaker::ProfilerRuleConfiguration>]
368  
369 Configuration information for Debugger rules for profiling system and
370 framework metrics.
371  
372  
373  
374 =head2 B<REQUIRED> ResourceConfig => L<Paws::SageMaker::ResourceConfig>
375  
376 The resources, including the ML compute instances and ML storage
377 volumes, to use for model training.
378  
379 ML storage volumes store model artifacts and incremental states.
380 Training algorithms might also use ML storage volumes for scratch
381 space. If you want Amazon SageMaker to use the ML storage volume to
382 store the training data, choose C<File> as the C<TrainingInputMode> in
383 the algorithm specification. For distributed training algorithms,
384 specify an instance count greater than 1.
385  
386  
387  
388 =head2 RetryStrategy => L<Paws::SageMaker::RetryStrategy>
389  
390 The number of times to retry the job when the job fails due to an
391 C<InternalServerError>.
392  
393  
394  
395 =head2 B<REQUIRED> RoleArn => Str
396  
397 The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can
398 assume to perform tasks on your behalf.
399  
400 During model training, Amazon SageMaker needs your permission to read
401 input data from an S3 bucket, download a Docker image that contains
402 training code, write model artifacts to an S3 bucket, write logs to
403 Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You
404 grant permissions for all of these tasks to an IAM role. For more
405 information, see Amazon SageMaker Roles
406 (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html).
407  
408 To be able to pass this role to Amazon SageMaker, the caller of this
409 API must have the C<iam:PassRole> permission.
410  
411  
412  
413 =head2 B<REQUIRED> StoppingCondition => L<Paws::SageMaker::StoppingCondition>
414  
415 Specifies a limit to how long a model training job can run. It also
416 specifies how long a managed Spot training job has to complete. When
417 the job reaches the time limit, Amazon SageMaker ends the training job.
418 Use this API to cap model training costs.
419  
420 To stop a job, Amazon SageMaker sends the algorithm the C<SIGTERM>
421 signal, which delays job termination for 120 seconds. Algorithms can
422 use this 120-second window to save the model artifacts, so the results
423 of training are not lost.
424  
425  
426  
427 =head2 Tags => ArrayRef[L<Paws::SageMaker::Tag>]
428  
429 An array of key-value pairs. You can use tags to categorize your Amazon
430 Web Services resources in different ways, for example, by purpose,
431 owner, or environment. For more information, see Tagging Amazon Web
432 Services Resources
433 (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).
434  
435  
436  
437 =head2 TensorBoardOutputConfig => L<Paws::SageMaker::TensorBoardOutputConfig>
438  
439  
440  
441  
442  
443 =head2 B<REQUIRED> TrainingJobName => Str
444  
445 The name of the training job. The name must be unique within an Amazon
446 Web Services Region in an Amazon Web Services account.
447  
448  
449  
450 =head2 VpcConfig => L<Paws::SageMaker::VpcConfig>
451  
452 A VpcConfig object that specifies the VPC that you want your training
453 job to connect to. Control access to and from your training container
454 by configuring the VPC. For more information, see Protect Training Jobs
455 by Using an Amazon Virtual Private Cloud
456 (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html).
457  
458  
459  
460  
461 =head1 SEE ALSO
462  
463 This class forms part of L<Paws>, documenting arguments for method CreateTrainingJob in L<Paws::SageMaker>
464  
465 =head1 BUGS and CONTRIBUTIONS
466  
467 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
468  
469 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
470  
471 =cut
472