{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.SageMaker.Types.StoppingCondition
-- 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)
module Amazonka.SageMaker.Types.StoppingCondition where

import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude

-- | 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.
data StoppingCondition = StoppingCondition'
  { -- | 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 -> Maybe Natural
maxWaitTimeInSeconds :: Prelude.Maybe Prelude.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.
    StoppingCondition -> Maybe Natural
maxRuntimeInSeconds :: Prelude.Maybe Prelude.Natural
  }
  deriving (StoppingCondition -> StoppingCondition -> Bool
(StoppingCondition -> StoppingCondition -> Bool)
-> (StoppingCondition -> StoppingCondition -> Bool)
-> Eq StoppingCondition
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: StoppingCondition -> StoppingCondition -> Bool
$c/= :: StoppingCondition -> StoppingCondition -> Bool
== :: StoppingCondition -> StoppingCondition -> Bool
$c== :: StoppingCondition -> StoppingCondition -> Bool
Prelude.Eq, ReadPrec [StoppingCondition]
ReadPrec StoppingCondition
Int -> ReadS StoppingCondition
ReadS [StoppingCondition]
(Int -> ReadS StoppingCondition)
-> ReadS [StoppingCondition]
-> ReadPrec StoppingCondition
-> ReadPrec [StoppingCondition]
-> Read StoppingCondition
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [StoppingCondition]
$creadListPrec :: ReadPrec [StoppingCondition]
readPrec :: ReadPrec StoppingCondition
$creadPrec :: ReadPrec StoppingCondition
readList :: ReadS [StoppingCondition]
$creadList :: ReadS [StoppingCondition]
readsPrec :: Int -> ReadS StoppingCondition
$creadsPrec :: Int -> ReadS StoppingCondition
Prelude.Read, Int -> StoppingCondition -> ShowS
[StoppingCondition] -> ShowS
StoppingCondition -> String
(Int -> StoppingCondition -> ShowS)
-> (StoppingCondition -> String)
-> ([StoppingCondition] -> ShowS)
-> Show StoppingCondition
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [StoppingCondition] -> ShowS
$cshowList :: [StoppingCondition] -> ShowS
show :: StoppingCondition -> String
$cshow :: StoppingCondition -> String
showsPrec :: Int -> StoppingCondition -> ShowS
$cshowsPrec :: Int -> StoppingCondition -> ShowS
Prelude.Show, (forall x. StoppingCondition -> Rep StoppingCondition x)
-> (forall x. Rep StoppingCondition x -> StoppingCondition)
-> Generic StoppingCondition
forall x. Rep StoppingCondition x -> StoppingCondition
forall x. StoppingCondition -> Rep StoppingCondition x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep StoppingCondition x -> StoppingCondition
$cfrom :: forall x. StoppingCondition -> Rep StoppingCondition x
Prelude.Generic)

-- |
-- Create a value of 'StoppingCondition' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'maxWaitTimeInSeconds', '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.
--
-- 'maxRuntimeInSeconds', '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.
newStoppingCondition ::
  StoppingCondition
newStoppingCondition :: StoppingCondition
newStoppingCondition =
  StoppingCondition' :: Maybe Natural -> Maybe Natural -> StoppingCondition
StoppingCondition'
    { $sel:maxWaitTimeInSeconds:StoppingCondition' :: Maybe Natural
maxWaitTimeInSeconds =
        Maybe Natural
forall a. Maybe a
Prelude.Nothing,
      $sel:maxRuntimeInSeconds:StoppingCondition' :: Maybe Natural
maxRuntimeInSeconds = Maybe Natural
forall a. Maybe a
Prelude.Nothing
    }

-- | 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_maxWaitTimeInSeconds :: Lens.Lens' StoppingCondition (Prelude.Maybe Prelude.Natural)
stoppingCondition_maxWaitTimeInSeconds :: (Maybe Natural -> f (Maybe Natural))
-> StoppingCondition -> f StoppingCondition
stoppingCondition_maxWaitTimeInSeconds = (StoppingCondition -> Maybe Natural)
-> (StoppingCondition -> Maybe Natural -> StoppingCondition)
-> Lens
     StoppingCondition StoppingCondition (Maybe Natural) (Maybe Natural)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StoppingCondition' {Maybe Natural
maxWaitTimeInSeconds :: Maybe Natural
$sel:maxWaitTimeInSeconds:StoppingCondition' :: StoppingCondition -> Maybe Natural
maxWaitTimeInSeconds} -> Maybe Natural
maxWaitTimeInSeconds) (\s :: StoppingCondition
s@StoppingCondition' {} Maybe Natural
a -> StoppingCondition
s {$sel:maxWaitTimeInSeconds:StoppingCondition' :: Maybe Natural
maxWaitTimeInSeconds = Maybe Natural
a} :: StoppingCondition)

-- | 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_maxRuntimeInSeconds :: Lens.Lens' StoppingCondition (Prelude.Maybe Prelude.Natural)
stoppingCondition_maxRuntimeInSeconds :: (Maybe Natural -> f (Maybe Natural))
-> StoppingCondition -> f StoppingCondition
stoppingCondition_maxRuntimeInSeconds = (StoppingCondition -> Maybe Natural)
-> (StoppingCondition -> Maybe Natural -> StoppingCondition)
-> Lens
     StoppingCondition StoppingCondition (Maybe Natural) (Maybe Natural)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StoppingCondition' {Maybe Natural
maxRuntimeInSeconds :: Maybe Natural
$sel:maxRuntimeInSeconds:StoppingCondition' :: StoppingCondition -> Maybe Natural
maxRuntimeInSeconds} -> Maybe Natural
maxRuntimeInSeconds) (\s :: StoppingCondition
s@StoppingCondition' {} Maybe Natural
a -> StoppingCondition
s {$sel:maxRuntimeInSeconds:StoppingCondition' :: Maybe Natural
maxRuntimeInSeconds = Maybe Natural
a} :: StoppingCondition)

instance Core.FromJSON StoppingCondition where
  parseJSON :: Value -> Parser StoppingCondition
parseJSON =
    String
-> (Object -> Parser StoppingCondition)
-> Value
-> Parser StoppingCondition
forall a. String -> (Object -> Parser a) -> Value -> Parser a
Core.withObject
      String
"StoppingCondition"
      ( \Object
x ->
          Maybe Natural -> Maybe Natural -> StoppingCondition
StoppingCondition'
            (Maybe Natural -> Maybe Natural -> StoppingCondition)
-> Parser (Maybe Natural)
-> Parser (Maybe Natural -> StoppingCondition)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x Object -> Text -> Parser (Maybe Natural)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"MaxWaitTimeInSeconds")
            Parser (Maybe Natural -> StoppingCondition)
-> Parser (Maybe Natural) -> Parser StoppingCondition
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser (Maybe Natural)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"MaxRuntimeInSeconds")
      )

instance Prelude.Hashable StoppingCondition

instance Prelude.NFData StoppingCondition

instance Core.ToJSON StoppingCondition where
  toJSON :: StoppingCondition -> Value
toJSON StoppingCondition' {Maybe Natural
maxRuntimeInSeconds :: Maybe Natural
maxWaitTimeInSeconds :: Maybe Natural
$sel:maxRuntimeInSeconds:StoppingCondition' :: StoppingCondition -> Maybe Natural
$sel:maxWaitTimeInSeconds:StoppingCondition' :: StoppingCondition -> Maybe Natural
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Text
"MaxWaitTimeInSeconds" Text -> Natural -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=)
              (Natural -> Pair) -> Maybe Natural -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Natural
maxWaitTimeInSeconds,
            (Text
"MaxRuntimeInSeconds" Text -> Natural -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=)
              (Natural -> Pair) -> Maybe Natural -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Natural
maxRuntimeInSeconds
          ]
      )