AWS SDK for C++  1.9.126
AWS SDK for C++
Public Member Functions | List of all members
Aws::SageMaker::Model::StoppingCondition Class Reference

#include <StoppingCondition.h>

Public Member Functions

 StoppingCondition ()
 
 StoppingCondition (Aws::Utils::Json::JsonView jsonValue)
 
StoppingConditionoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
int GetMaxRuntimeInSeconds () const
 
bool MaxRuntimeInSecondsHasBeenSet () const
 
void SetMaxRuntimeInSeconds (int value)
 
StoppingConditionWithMaxRuntimeInSeconds (int value)
 
int GetMaxWaitTimeInSeconds () const
 
bool MaxWaitTimeInSecondsHasBeenSet () const
 
void SetMaxWaitTimeInSeconds (int value)
 
StoppingConditionWithMaxWaitTimeInSeconds (int value)
 

Detailed Description

Specifies a limit to how long a model training job or model compilation job can run. It also specifies how long a managed spot training job has to complete. When the job reaches the time limit, Amazon SageMaker ends the training or compilation job. Use this API to cap model training costs.

To stop a training job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

The training algorithms provided by Amazon SageMaker automatically save the intermediate results of a model training job when possible. This attempt to save artifacts is only a best effort case as model might not be in a state from which it can be saved. For example, if training has just started, the model might not be ready to save. When saved, this intermediate data is a valid model artifact. You can use it to create a model with CreateModel.

The Neural Topic Model (NTM) currently does not support saving intermediate model artifacts. When training NTMs, make sure that the maximum runtime is sufficient for the training job to complete.

See Also:

AWS API Reference

Definition at line 45 of file StoppingCondition.h.

Constructor & Destructor Documentation

◆ StoppingCondition() [1/2]

Aws::SageMaker::Model::StoppingCondition::StoppingCondition ( )

◆ StoppingCondition() [2/2]

Aws::SageMaker::Model::StoppingCondition::StoppingCondition ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ GetMaxRuntimeInSeconds()

int Aws::SageMaker::Model::StoppingCondition::GetMaxRuntimeInSeconds ( ) const
inline

The maximum length of time, in seconds, that a training or compilation job can run.

For compilation jobs, if the job does not complete during this time, you will receive a TimeOut error. We recommend starting with 900 seconds and increase as necessary based on your model.

For all other jobs, if the job does not complete during this time, Amazon SageMaker ends the job. When RetryStrategy is specified in the job request, MaxRuntimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.

Definition at line 65 of file StoppingCondition.h.

◆ GetMaxWaitTimeInSeconds()

int Aws::SageMaker::Model::StoppingCondition::GetMaxWaitTimeInSeconds ( ) const
inline

The maximum length of time, in seconds, that a managed Spot training job has to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the job can run. It must be equal to or greater than MaxRuntimeInSeconds. If the job does not complete during this time, Amazon SageMaker ends the job.

When RetryStrategy is specified in the job request, MaxWaitTimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt.

Definition at line 116 of file StoppingCondition.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::SageMaker::Model::StoppingCondition::Jsonize ( ) const

◆ MaxRuntimeInSecondsHasBeenSet()

bool Aws::SageMaker::Model::StoppingCondition::MaxRuntimeInSecondsHasBeenSet ( ) const
inline

The maximum length of time, in seconds, that a training or compilation job can run.

For compilation jobs, if the job does not complete during this time, you will receive a TimeOut error. We recommend starting with 900 seconds and increase as necessary based on your model.

For all other jobs, if the job does not complete during this time, Amazon SageMaker ends the job. When RetryStrategy is specified in the job request, MaxRuntimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.

Definition at line 78 of file StoppingCondition.h.

◆ MaxWaitTimeInSecondsHasBeenSet()

bool Aws::SageMaker::Model::StoppingCondition::MaxWaitTimeInSecondsHasBeenSet ( ) const
inline

The maximum length of time, in seconds, that a managed Spot training job has to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the job can run. It must be equal to or greater than MaxRuntimeInSeconds. If the job does not complete during this time, Amazon SageMaker ends the job.

When RetryStrategy is specified in the job request, MaxWaitTimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt.

Definition at line 127 of file StoppingCondition.h.

◆ operator=()

StoppingCondition& Aws::SageMaker::Model::StoppingCondition::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetMaxRuntimeInSeconds()

void Aws::SageMaker::Model::StoppingCondition::SetMaxRuntimeInSeconds ( int  value)
inline

The maximum length of time, in seconds, that a training or compilation job can run.

For compilation jobs, if the job does not complete during this time, you will receive a TimeOut error. We recommend starting with 900 seconds and increase as necessary based on your model.

For all other jobs, if the job does not complete during this time, Amazon SageMaker ends the job. When RetryStrategy is specified in the job request, MaxRuntimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.

Definition at line 91 of file StoppingCondition.h.

◆ SetMaxWaitTimeInSeconds()

void Aws::SageMaker::Model::StoppingCondition::SetMaxWaitTimeInSeconds ( int  value)
inline

The maximum length of time, in seconds, that a managed Spot training job has to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the job can run. It must be equal to or greater than MaxRuntimeInSeconds. If the job does not complete during this time, Amazon SageMaker ends the job.

When RetryStrategy is specified in the job request, MaxWaitTimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt.

Definition at line 138 of file StoppingCondition.h.

◆ WithMaxRuntimeInSeconds()

StoppingCondition& Aws::SageMaker::Model::StoppingCondition::WithMaxRuntimeInSeconds ( int  value)
inline

The maximum length of time, in seconds, that a training or compilation job can run.

For compilation jobs, if the job does not complete during this time, you will receive a TimeOut error. We recommend starting with 900 seconds and increase as necessary based on your model.

For all other jobs, if the job does not complete during this time, Amazon SageMaker ends the job. When RetryStrategy is specified in the job request, MaxRuntimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.

Definition at line 104 of file StoppingCondition.h.

◆ WithMaxWaitTimeInSeconds()

StoppingCondition& Aws::SageMaker::Model::StoppingCondition::WithMaxWaitTimeInSeconds ( int  value)
inline

The maximum length of time, in seconds, that a managed Spot training job has to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the job can run. It must be equal to or greater than MaxRuntimeInSeconds. If the job does not complete during this time, Amazon SageMaker ends the job.

When RetryStrategy is specified in the job request, MaxWaitTimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt.

Definition at line 149 of file StoppingCondition.h.


The documentation for this class was generated from the following file: