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

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