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

filter: Statementstmt 0.0% 0 / 40 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 41 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::SageMaker::TrainingJob;
3 use Moose;
4 has AlgorithmSpecification => (is => 'ro', isa => 'Paws::SageMaker::AlgorithmSpecification');
5 has AutoMLJobArn => (is => 'ro', isa => 'Str');
6 has BillableTimeInSeconds => (is => 'ro', isa => 'Int');
7 has CheckpointConfig => (is => 'ro', isa => 'Paws::SageMaker::CheckpointConfig');
8 has CreationTime => (is => 'ro', isa => 'Str');
9 has DebugHookConfig => (is => 'ro', isa => 'Paws::SageMaker::DebugHookConfig');
10 has DebugRuleConfigurations => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::DebugRuleConfiguration]');
11 has DebugRuleEvaluationStatuses => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::DebugRuleEvaluationStatus]');
12 has EnableInterContainerTrafficEncryption => (is => 'ro', isa => 'Bool');
13 has EnableManagedSpotTraining => (is => 'ro', isa => 'Bool');
14 has EnableNetworkIsolation => (is => 'ro', isa => 'Bool');
15 has Environment => (is => 'ro', isa => 'Paws::SageMaker::TrainingEnvironmentMap');
16 has ExperimentConfig => (is => 'ro', isa => 'Paws::SageMaker::ExperimentConfig');
17 has FailureReason => (is => 'ro', isa => 'Str');
18 has FinalMetricDataList => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::MetricData]');
19 has HyperParameters => (is => 'ro', isa => 'Paws::SageMaker::HyperParameters');
20 has InputDataConfig => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::Channel]');
21 has LabelingJobArn => (is => 'ro', isa => 'Str');
22 has LastModifiedTime => (is => 'ro', isa => 'Str');
23 has ModelArtifacts => (is => 'ro', isa => 'Paws::SageMaker::ModelArtifacts');
24 has OutputDataConfig => (is => 'ro', isa => 'Paws::SageMaker::OutputDataConfig');
25 has ResourceConfig => (is => 'ro', isa => 'Paws::SageMaker::ResourceConfig');
26 has RetryStrategy => (is => 'ro', isa => 'Paws::SageMaker::RetryStrategy');
27 has RoleArn => (is => 'ro', isa => 'Str');
28 has SecondaryStatus => (is => 'ro', isa => 'Str');
29 has SecondaryStatusTransitions => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::SecondaryStatusTransition]');
30 has StoppingCondition => (is => 'ro', isa => 'Paws::SageMaker::StoppingCondition');
31 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::Tag]');
32 has TensorBoardOutputConfig => (is => 'ro', isa => 'Paws::SageMaker::TensorBoardOutputConfig');
33 has TrainingEndTime => (is => 'ro', isa => 'Str');
34 has TrainingJobArn => (is => 'ro', isa => 'Str');
35 has TrainingJobName => (is => 'ro', isa => 'Str');
36 has TrainingJobStatus => (is => 'ro', isa => 'Str');
37 has TrainingStartTime => (is => 'ro', isa => 'Str');
38 has TrainingTimeInSeconds => (is => 'ro', isa => 'Int');
39 has TuningJobArn => (is => 'ro', isa => 'Str');
40 has VpcConfig => (is => 'ro', isa => 'Paws::SageMaker::VpcConfig');
41  
42 1;
43  
44 ### main pod documentation begin ###
45  
46 =head1 NAME
47  
48 Paws::SageMaker::TrainingJob
49  
50 =head1 USAGE
51  
52 This class represents one of two things:
53  
54 =head3 Arguments in a call to a service
55  
56 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
57 Each attribute should be used as a named argument in the calls that expect this type of object.
58  
59 As an example, if Att1 is expected to be a Paws::SageMaker::TrainingJob object:
60  
61 $service_obj->Method(Att1 => { AlgorithmSpecification => $value, ..., VpcConfig => $value });
62  
63 =head3 Results returned from an API call
64  
65 Use accessors for each attribute. If Att1 is expected to be an Paws::SageMaker::TrainingJob object:
66  
67 $result = $service_obj->Method(...);
68 $result->Att1->AlgorithmSpecification
69  
70 =head1 DESCRIPTION
71  
72 Contains information about a training job.
73  
74 =head1 ATTRIBUTES
75  
76  
77 =head2 AlgorithmSpecification => L<Paws::SageMaker::AlgorithmSpecification>
78  
79 Information about the algorithm used for training, and algorithm
80 metadata.
81  
82  
83 =head2 AutoMLJobArn => Str
84  
85 The Amazon Resource Name (ARN) of the job.
86  
87  
88 =head2 BillableTimeInSeconds => Int
89  
90 The billable time in seconds.
91  
92  
93 =head2 CheckpointConfig => L<Paws::SageMaker::CheckpointConfig>
94  
95  
96  
97  
98 =head2 CreationTime => Str
99  
100 A timestamp that indicates when the training job was created.
101  
102  
103 =head2 DebugHookConfig => L<Paws::SageMaker::DebugHookConfig>
104  
105  
106  
107  
108 =head2 DebugRuleConfigurations => ArrayRef[L<Paws::SageMaker::DebugRuleConfiguration>]
109  
110 Information about the debug rule configuration.
111  
112  
113 =head2 DebugRuleEvaluationStatuses => ArrayRef[L<Paws::SageMaker::DebugRuleEvaluationStatus>]
114  
115 Information about the evaluation status of the rules for the training
116 job.
117  
118  
119 =head2 EnableInterContainerTrafficEncryption => Bool
120  
121 To encrypt all communications between ML compute instances in
122 distributed training, choose C<True>. Encryption provides greater
123 security for distributed training, but training might take longer. How
124 long it takes depends on the amount of communication between compute
125 instances, especially if you use a deep learning algorithm in
126 distributed training.
127  
128  
129 =head2 EnableManagedSpotTraining => Bool
130  
131 When true, enables managed spot training using Amazon EC2 Spot
132 instances to run training jobs instead of on-demand instances. For more
133 information, see Managed Spot Training
134 (https://docs.aws.amazon.com/sagemaker/latest/dg/model-managed-spot-training.html).
135  
136  
137 =head2 EnableNetworkIsolation => Bool
138  
139 If the C<TrainingJob> was created with network isolation, the value is
140 set to C<true>. If network isolation is enabled, nodes can't
141 communicate beyond the VPC they run in.
142  
143  
144 =head2 Environment => L<Paws::SageMaker::TrainingEnvironmentMap>
145  
146 The environment variables to set in the Docker container.
147  
148  
149 =head2 ExperimentConfig => L<Paws::SageMaker::ExperimentConfig>
150  
151  
152  
153  
154 =head2 FailureReason => Str
155  
156 If the training job failed, the reason it failed.
157  
158  
159 =head2 FinalMetricDataList => ArrayRef[L<Paws::SageMaker::MetricData>]
160  
161 A list of final metric values that are set when the training job
162 completes. Used only if the training job was configured to use metrics.
163  
164  
165 =head2 HyperParameters => L<Paws::SageMaker::HyperParameters>
166  
167 Algorithm-specific parameters.
168  
169  
170 =head2 InputDataConfig => ArrayRef[L<Paws::SageMaker::Channel>]
171  
172 An array of C<Channel> objects that describes each data input channel.
173  
174  
175 =head2 LabelingJobArn => Str
176  
177 The Amazon Resource Name (ARN) of the labeling job.
178  
179  
180 =head2 LastModifiedTime => Str
181  
182 A timestamp that indicates when the status of the training job was last
183 modified.
184  
185  
186 =head2 ModelArtifacts => L<Paws::SageMaker::ModelArtifacts>
187  
188 Information about the Amazon S3 location that is configured for storing
189 model artifacts.
190  
191  
192 =head2 OutputDataConfig => L<Paws::SageMaker::OutputDataConfig>
193  
194 The S3 path where model artifacts that you configured when creating the
195 job are stored. Amazon SageMaker creates subfolders for model
196 artifacts.
197  
198  
199 =head2 ResourceConfig => L<Paws::SageMaker::ResourceConfig>
200  
201 Resources, including ML compute instances and ML storage volumes, that
202 are configured for model training.
203  
204  
205 =head2 RetryStrategy => L<Paws::SageMaker::RetryStrategy>
206  
207 The number of times to retry the job when the job fails due to an
208 C<InternalServerError>.
209  
210  
211 =head2 RoleArn => Str
212  
213 The Amazon Web Services Identity and Access Management (IAM) role
214 configured for the training job.
215  
216  
217 =head2 SecondaryStatus => Str
218  
219 Provides detailed information about the state of the training job. For
220 detailed information about the secondary status of the training job,
221 see C<StatusMessage> under SecondaryStatusTransition.
222  
223 Amazon SageMaker provides primary statuses and secondary statuses that
224 apply to each of them:
225  
226 =over
227  
228 =item InProgress
229  
230 =over
231  
232 =item *
233  
234 C<Starting> - Starting the training job.
235  
236 =item *
237  
238 C<Downloading> - An optional stage for algorithms that support C<File>
239 training input mode. It indicates that data is being downloaded to the
240 ML storage volumes.
241  
242 =item *
243  
244 C<Training> - Training is in progress.
245  
246 =item *
247  
248 C<Uploading> - Training is complete and the model artifacts are being
249 uploaded to the S3 location.
250  
251 =back
252  
253 =item Completed
254  
255 =over
256  
257 =item *
258  
259 C<Completed> - The training job has completed.
260  
261 =back
262  
263 =item Failed
264  
265 =over
266  
267 =item *
268  
269 C<Failed> - The training job has failed. The reason for the failure is
270 returned in the C<FailureReason> field of
271 C<DescribeTrainingJobResponse>.
272  
273 =back
274  
275 =item Stopped
276  
277 =over
278  
279 =item *
280  
281 C<MaxRuntimeExceeded> - The job stopped because it exceeded the maximum
282 allowed runtime.
283  
284 =item *
285  
286 C<Stopped> - The training job has stopped.
287  
288 =back
289  
290 =item Stopping
291  
292 =over
293  
294 =item *
295  
296 C<Stopping> - Stopping the training job.
297  
298 =back
299  
300 =back
301  
302 Valid values for C<SecondaryStatus> are subject to change.
303  
304 We no longer support the following secondary statuses:
305  
306 =over
307  
308 =item *
309  
310 C<LaunchingMLInstances>
311  
312 =item *
313  
314 C<PreparingTrainingStack>
315  
316 =item *
317  
318 C<DownloadingTrainingImage>
319  
320 =back
321  
322  
323  
324 =head2 SecondaryStatusTransitions => ArrayRef[L<Paws::SageMaker::SecondaryStatusTransition>]
325  
326 A history of all of the secondary statuses that the training job has
327 transitioned through.
328  
329  
330 =head2 StoppingCondition => L<Paws::SageMaker::StoppingCondition>
331  
332 Specifies a limit to how long a model training job can run. It also
333 specifies how long a managed Spot training job has to complete. When
334 the job reaches the time limit, Amazon SageMaker ends the training job.
335 Use this API to cap model training costs.
336  
337 To stop a job, Amazon SageMaker sends the algorithm the C<SIGTERM>
338 signal, which delays job termination for 120 seconds. Algorithms can
339 use this 120-second window to save the model artifacts, so the results
340 of training are not lost.
341  
342  
343 =head2 Tags => ArrayRef[L<Paws::SageMaker::Tag>]
344  
345 An array of key-value pairs. You can use tags to categorize your Amazon
346 Web Services resources in different ways, for example, by purpose,
347 owner, or environment. For more information, see Tagging Amazon Web
348 Services Resources
349 (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).
350  
351  
352 =head2 TensorBoardOutputConfig => L<Paws::SageMaker::TensorBoardOutputConfig>
353  
354  
355  
356  
357 =head2 TrainingEndTime => Str
358  
359 Indicates the time when the training job ends on training instances.
360 You are billed for the time interval between the value of
361 C<TrainingStartTime> and this time. For successful jobs and stopped
362 jobs, this is the time after model artifacts are uploaded. For failed
363 jobs, this is the time when Amazon SageMaker detects a job failure.
364  
365  
366 =head2 TrainingJobArn => Str
367  
368 The Amazon Resource Name (ARN) of the training job.
369  
370  
371 =head2 TrainingJobName => Str
372  
373 The name of the training job.
374  
375  
376 =head2 TrainingJobStatus => Str
377  
378 The status of the training job.
379  
380 Training job statuses are:
381  
382 =over
383  
384 =item *
385  
386 C<InProgress> - The training is in progress.
387  
388 =item *
389  
390 C<Completed> - The training job has completed.
391  
392 =item *
393  
394 C<Failed> - The training job has failed. To see the reason for the
395 failure, see the C<FailureReason> field in the response to a
396 C<DescribeTrainingJobResponse> call.
397  
398 =item *
399  
400 C<Stopping> - The training job is stopping.
401  
402 =item *
403  
404 C<Stopped> - The training job has stopped.
405  
406 =back
407  
408 For more detailed information, see C<SecondaryStatus>.
409  
410  
411 =head2 TrainingStartTime => Str
412  
413 Indicates the time when the training job starts on training instances.
414 You are billed for the time interval between this time and the value of
415 C<TrainingEndTime>. The start time in CloudWatch Logs might be later
416 than this time. The difference is due to the time it takes to download
417 the training data and to the size of the training container.
418  
419  
420 =head2 TrainingTimeInSeconds => Int
421  
422 The training time in seconds.
423  
424  
425 =head2 TuningJobArn => Str
426  
427 The Amazon Resource Name (ARN) of the associated hyperparameter tuning
428 job if the training job was launched by a hyperparameter tuning job.
429  
430  
431 =head2 VpcConfig => L<Paws::SageMaker::VpcConfig>
432  
433 A VpcConfig object that specifies the VPC that this training job has
434 access to. For more information, see Protect Training Jobs by Using an
435 Amazon Virtual Private Cloud
436 (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html).
437  
438  
439  
440 =head1 SEE ALSO
441  
442 This class forms part of L<Paws>, describing an object used in L<Paws::SageMaker>
443  
444 =head1 BUGS and CONTRIBUTIONS
445  
446 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
447  
448 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
449  
450 =cut
451