« blib/lib/Paws/SageMaker/StopTransformJob.pm
↑ Summary
blib/lib/Paws/SageMaker/SubscribedWorkteam.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SageMaker::StoppingCondition; | ||
| 3 | use Moose; | ||
| 4 | has MaxRuntimeInSeconds => (is => 'ro', isa => 'Int'); | ||
| 5 | has MaxWaitTimeInSeconds => (is => 'ro', isa => 'Int'); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::SageMaker::StoppingCondition | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::SageMaker::StoppingCondition object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { MaxRuntimeInSeconds => $value, ..., MaxWaitTimeInSeconds => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::SageMaker::StoppingCondition object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->MaxRuntimeInSeconds | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | Specifies a limit to how long a model training job, model compilation | ||
| 38 | job, or hyperparameter tuning job can run. It also specifies how long a | ||
| 39 | managed Spot training job has to complete. When the job reaches the | ||
| 40 | time limit, Amazon SageMaker ends the training or compilation job. Use | ||
| 41 | this API to cap model training costs. | ||
| 42 | |||
| 43 | To stop a job, Amazon SageMaker sends the algorithm the C<SIGTERM> | ||
| 44 | signal, which delays job termination for 120 seconds. Algorithms can | ||
| 45 | use this 120-second window to save the model artifacts, so the results | ||
| 46 | of training are not lost. | ||
| 47 | |||
| 48 | The training algorithms provided by Amazon SageMaker automatically save | ||
| 49 | the intermediate results of a model training job when possible. This | ||
| 50 | attempt to save artifacts is only a best effort case as model might not | ||
| 51 | be in a state from which it can be saved. For example, if training has | ||
| 52 | just started, the model might not be ready to save. When saved, this | ||
| 53 | intermediate data is a valid model artifact. You can use it to create a | ||
| 54 | model with C<CreateModel>. | ||
| 55 | |||
| 56 | The Neural Topic Model (NTM) currently does not support saving | ||
| 57 | intermediate model artifacts. When training NTMs, make sure that the | ||
| 58 | maximum runtime is sufficient for the training job to complete. | ||
| 59 | |||
| 60 | =head1 ATTRIBUTES | ||
| 61 | |||
| 62 | |||
| 63 | =head2 MaxRuntimeInSeconds => Int | ||
| 64 | |||
| 65 | The maximum length of time, in seconds, that a training or compilation | ||
| 66 | job can run. If the job does not complete during this time, Amazon | ||
| 67 | SageMaker ends the job. | ||
| 68 | |||
| 69 | When C<RetryStrategy> is specified in the job request, | ||
| 70 | C<MaxRuntimeInSeconds> specifies the maximum time for all of the | ||
| 71 | attempts in total, not each individual attempt. | ||
| 72 | |||
| 73 | The default value is 1 day. The maximum value is 28 days. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 MaxWaitTimeInSeconds => Int | ||
| 77 | |||
| 78 | The maximum length of time, in seconds, that a managed Spot training | ||
| 79 | job has to complete. It is the amount of time spent waiting for Spot | ||
| 80 | capacity plus the amount of time the job can run. It must be equal to | ||
| 81 | or greater than C<MaxRuntimeInSeconds>. If the job does not complete | ||
| 82 | during this time, Amazon SageMaker ends the job. | ||
| 83 | |||
| 84 | When C<RetryStrategy> is specified in the job request, | ||
| 85 | C<MaxWaitTimeInSeconds> specifies the maximum time for all of the | ||
| 86 | attempts in total, not each individual attempt. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head1 SEE ALSO | ||
| 91 | |||
| 92 | This class forms part of L<Paws>, describing an object used in L<Paws::SageMaker> | ||
| 93 | |||
| 94 | =head1 BUGS and CONTRIBUTIONS | ||
| 95 | |||
| 96 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 97 | |||
| 98 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 99 | |||
| 100 | =cut | ||
| 101 |