Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SageMaker.Types.StoppingCondition

Description

Documentation

data StoppingCondition Source #

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: newStoppingCondition smart constructor.

Constructors

StoppingCondition'

Fields

maxWaitTimeInSeconds :: Maybe Natural
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.
maxRuntimeInSeconds :: Maybe Natural
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.

Instances

Instances details

Eq StoppingCondition Source #
Instance details Defined in Amazonka.SageMaker.Types.StoppingCondition Methods (==) :: StoppingCondition -> StoppingCondition -> Bool # (/=) :: StoppingCondition -> StoppingCondition -> Bool #
Read StoppingCondition Source #
Instance details Defined in Amazonka.SageMaker.Types.StoppingCondition Methods readsPrec :: Int -> ReadS StoppingCondition # readList :: ReadS [StoppingCondition] # readPrec :: ReadPrec StoppingCondition # readListPrec :: ReadPrec [StoppingCondition] #
Show StoppingCondition Source #
Instance details Defined in Amazonka.SageMaker.Types.StoppingCondition Methods showsPrec :: Int -> StoppingCondition -> ShowS # show :: StoppingCondition -> String # showList :: [StoppingCondition] -> ShowS #
Generic StoppingCondition Source #
Instance details Defined in Amazonka.SageMaker.Types.StoppingCondition Associated Types type Rep StoppingCondition :: Type -> Type # Methods from :: StoppingCondition -> Rep StoppingCondition x # to :: Rep StoppingCondition x -> StoppingCondition #
NFData StoppingCondition Source #
Instance details Defined in Amazonka.SageMaker.Types.StoppingCondition Methods rnf :: StoppingCondition -> () #
Hashable StoppingCondition Source #
Instance details Defined in Amazonka.SageMaker.Types.StoppingCondition Methods hashWithSalt :: Int -> StoppingCondition -> Int # hash :: StoppingCondition -> Int #
ToJSON StoppingCondition Source #
Instance details Defined in Amazonka.SageMaker.Types.StoppingCondition Methods toJSON :: StoppingCondition -> Value # toEncoding :: StoppingCondition -> Encoding # toJSONList :: [StoppingCondition] -> Value # toEncodingList :: [StoppingCondition] -> Encoding #
FromJSON StoppingCondition Source #
Instance details Defined in Amazonka.SageMaker.Types.StoppingCondition Methods parseJSON :: Value -> Parser StoppingCondition # parseJSONList :: Value -> Parser [StoppingCondition] #
type Rep StoppingCondition Source #
Instance details Defined in Amazonka.SageMaker.Types.StoppingCondition type Rep StoppingCondition = D1 ('MetaData "StoppingCondition" "Amazonka.SageMaker.Types.StoppingCondition" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "StoppingCondition'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxWaitTimeInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "maxRuntimeInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))

newStoppingCondition :: StoppingCondition Source #

Create a value of StoppingCondition with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:maxWaitTimeInSeconds:StoppingCondition', stoppingCondition_maxWaitTimeInSeconds - 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.

$sel:maxRuntimeInSeconds:StoppingCondition', stoppingCondition_maxRuntimeInSeconds - 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.

stoppingCondition_maxWaitTimeInSeconds :: Lens' StoppingCondition (Maybe Natural) Source #

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.

stoppingCondition_maxRuntimeInSeconds :: Lens' StoppingCondition (Maybe Natural) Source #

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.