{-# 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.IntegerParameterRange
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.SageMaker.Types.IntegerParameterRange where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
import Amazonka.SageMaker.Types.HyperParameterScalingType

-- | For a hyperparameter of the integer type, specifies the range that a
-- hyperparameter tuning job searches.
--
-- /See:/ 'newIntegerParameterRange' smart constructor.
data IntegerParameterRange = IntegerParameterRange'
  { -- | The scale that hyperparameter tuning uses to search the hyperparameter
    -- range. For information about choosing a hyperparameter scale, see
    -- <https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type Hyperparameter Scaling>.
    -- One of the following values:
    --
    -- [Auto]
    --     SageMaker hyperparameter tuning chooses the best scale for the
    --     hyperparameter.
    --
    -- [Linear]
    --     Hyperparameter tuning searches the values in the hyperparameter
    --     range by using a linear scale.
    --
    -- [Logarithmic]
    --     Hyperparameter tuning searches the values in the hyperparameter
    --     range by using a logarithmic scale.
    --
    --     Logarithmic scaling works only for ranges that have only values
    --     greater than 0.
    IntegerParameterRange -> Maybe HyperParameterScalingType
scalingType :: Prelude.Maybe HyperParameterScalingType,
    -- | The name of the hyperparameter to search.
    IntegerParameterRange -> Text
name :: Prelude.Text,
    -- | The minimum value of the hyperparameter to search.
    IntegerParameterRange -> Text
minValue :: Prelude.Text,
    -- | The maximum value of the hyperparameter to search.
    IntegerParameterRange -> Text
maxValue :: Prelude.Text
  }
  deriving (IntegerParameterRange -> IntegerParameterRange -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: IntegerParameterRange -> IntegerParameterRange -> Bool
$c/= :: IntegerParameterRange -> IntegerParameterRange -> Bool
== :: IntegerParameterRange -> IntegerParameterRange -> Bool
$c== :: IntegerParameterRange -> IntegerParameterRange -> Bool
Prelude.Eq, ReadPrec [IntegerParameterRange]
ReadPrec IntegerParameterRange
Int -> ReadS IntegerParameterRange
ReadS [IntegerParameterRange]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [IntegerParameterRange]
$creadListPrec :: ReadPrec [IntegerParameterRange]
readPrec :: ReadPrec IntegerParameterRange
$creadPrec :: ReadPrec IntegerParameterRange
readList :: ReadS [IntegerParameterRange]
$creadList :: ReadS [IntegerParameterRange]
readsPrec :: Int -> ReadS IntegerParameterRange
$creadsPrec :: Int -> ReadS IntegerParameterRange
Prelude.Read, Int -> IntegerParameterRange -> ShowS
[IntegerParameterRange] -> ShowS
IntegerParameterRange -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [IntegerParameterRange] -> ShowS
$cshowList :: [IntegerParameterRange] -> ShowS
show :: IntegerParameterRange -> String
$cshow :: IntegerParameterRange -> String
showsPrec :: Int -> IntegerParameterRange -> ShowS
$cshowsPrec :: Int -> IntegerParameterRange -> ShowS
Prelude.Show, forall x. Rep IntegerParameterRange x -> IntegerParameterRange
forall x. IntegerParameterRange -> Rep IntegerParameterRange x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep IntegerParameterRange x -> IntegerParameterRange
$cfrom :: forall x. IntegerParameterRange -> Rep IntegerParameterRange x
Prelude.Generic)

-- |
-- Create a value of 'IntegerParameterRange' 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:
--
-- 'scalingType', 'integerParameterRange_scalingType' - The scale that hyperparameter tuning uses to search the hyperparameter
-- range. For information about choosing a hyperparameter scale, see
-- <https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type Hyperparameter Scaling>.
-- One of the following values:
--
-- [Auto]
--     SageMaker hyperparameter tuning chooses the best scale for the
--     hyperparameter.
--
-- [Linear]
--     Hyperparameter tuning searches the values in the hyperparameter
--     range by using a linear scale.
--
-- [Logarithmic]
--     Hyperparameter tuning searches the values in the hyperparameter
--     range by using a logarithmic scale.
--
--     Logarithmic scaling works only for ranges that have only values
--     greater than 0.
--
-- 'name', 'integerParameterRange_name' - The name of the hyperparameter to search.
--
-- 'minValue', 'integerParameterRange_minValue' - The minimum value of the hyperparameter to search.
--
-- 'maxValue', 'integerParameterRange_maxValue' - The maximum value of the hyperparameter to search.
newIntegerParameterRange ::
  -- | 'name'
  Prelude.Text ->
  -- | 'minValue'
  Prelude.Text ->
  -- | 'maxValue'
  Prelude.Text ->
  IntegerParameterRange
newIntegerParameterRange :: Text -> Text -> Text -> IntegerParameterRange
newIntegerParameterRange Text
pName_ Text
pMinValue_ Text
pMaxValue_ =
  IntegerParameterRange'
    { $sel:scalingType:IntegerParameterRange' :: Maybe HyperParameterScalingType
scalingType =
        forall a. Maybe a
Prelude.Nothing,
      $sel:name:IntegerParameterRange' :: Text
name = Text
pName_,
      $sel:minValue:IntegerParameterRange' :: Text
minValue = Text
pMinValue_,
      $sel:maxValue:IntegerParameterRange' :: Text
maxValue = Text
pMaxValue_
    }

-- | The scale that hyperparameter tuning uses to search the hyperparameter
-- range. For information about choosing a hyperparameter scale, see
-- <https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type Hyperparameter Scaling>.
-- One of the following values:
--
-- [Auto]
--     SageMaker hyperparameter tuning chooses the best scale for the
--     hyperparameter.
--
-- [Linear]
--     Hyperparameter tuning searches the values in the hyperparameter
--     range by using a linear scale.
--
-- [Logarithmic]
--     Hyperparameter tuning searches the values in the hyperparameter
--     range by using a logarithmic scale.
--
--     Logarithmic scaling works only for ranges that have only values
--     greater than 0.
integerParameterRange_scalingType :: Lens.Lens' IntegerParameterRange (Prelude.Maybe HyperParameterScalingType)
integerParameterRange_scalingType :: Lens' IntegerParameterRange (Maybe HyperParameterScalingType)
integerParameterRange_scalingType = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\IntegerParameterRange' {Maybe HyperParameterScalingType
scalingType :: Maybe HyperParameterScalingType
$sel:scalingType:IntegerParameterRange' :: IntegerParameterRange -> Maybe HyperParameterScalingType
scalingType} -> Maybe HyperParameterScalingType
scalingType) (\s :: IntegerParameterRange
s@IntegerParameterRange' {} Maybe HyperParameterScalingType
a -> IntegerParameterRange
s {$sel:scalingType:IntegerParameterRange' :: Maybe HyperParameterScalingType
scalingType = Maybe HyperParameterScalingType
a} :: IntegerParameterRange)

-- | The name of the hyperparameter to search.
integerParameterRange_name :: Lens.Lens' IntegerParameterRange Prelude.Text
integerParameterRange_name :: Lens' IntegerParameterRange Text
integerParameterRange_name = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\IntegerParameterRange' {Text
name :: Text
$sel:name:IntegerParameterRange' :: IntegerParameterRange -> Text
name} -> Text
name) (\s :: IntegerParameterRange
s@IntegerParameterRange' {} Text
a -> IntegerParameterRange
s {$sel:name:IntegerParameterRange' :: Text
name = Text
a} :: IntegerParameterRange)

-- | The minimum value of the hyperparameter to search.
integerParameterRange_minValue :: Lens.Lens' IntegerParameterRange Prelude.Text
integerParameterRange_minValue :: Lens' IntegerParameterRange Text
integerParameterRange_minValue = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\IntegerParameterRange' {Text
minValue :: Text
$sel:minValue:IntegerParameterRange' :: IntegerParameterRange -> Text
minValue} -> Text
minValue) (\s :: IntegerParameterRange
s@IntegerParameterRange' {} Text
a -> IntegerParameterRange
s {$sel:minValue:IntegerParameterRange' :: Text
minValue = Text
a} :: IntegerParameterRange)

-- | The maximum value of the hyperparameter to search.
integerParameterRange_maxValue :: Lens.Lens' IntegerParameterRange Prelude.Text
integerParameterRange_maxValue :: Lens' IntegerParameterRange Text
integerParameterRange_maxValue = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\IntegerParameterRange' {Text
maxValue :: Text
$sel:maxValue:IntegerParameterRange' :: IntegerParameterRange -> Text
maxValue} -> Text
maxValue) (\s :: IntegerParameterRange
s@IntegerParameterRange' {} Text
a -> IntegerParameterRange
s {$sel:maxValue:IntegerParameterRange' :: Text
maxValue = Text
a} :: IntegerParameterRange)

instance Data.FromJSON IntegerParameterRange where
  parseJSON :: Value -> Parser IntegerParameterRange
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"IntegerParameterRange"
      ( \Object
x ->
          Maybe HyperParameterScalingType
-> Text -> Text -> Text -> IntegerParameterRange
IntegerParameterRange'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"ScalingType")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"Name")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"MinValue")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"MaxValue")
      )

instance Prelude.Hashable IntegerParameterRange where
  hashWithSalt :: Int -> IntegerParameterRange -> Int
hashWithSalt Int
_salt IntegerParameterRange' {Maybe HyperParameterScalingType
Text
maxValue :: Text
minValue :: Text
name :: Text
scalingType :: Maybe HyperParameterScalingType
$sel:maxValue:IntegerParameterRange' :: IntegerParameterRange -> Text
$sel:minValue:IntegerParameterRange' :: IntegerParameterRange -> Text
$sel:name:IntegerParameterRange' :: IntegerParameterRange -> Text
$sel:scalingType:IntegerParameterRange' :: IntegerParameterRange -> Maybe HyperParameterScalingType
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe HyperParameterScalingType
scalingType
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
name
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
minValue
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
maxValue

instance Prelude.NFData IntegerParameterRange where
  rnf :: IntegerParameterRange -> ()
rnf IntegerParameterRange' {Maybe HyperParameterScalingType
Text
maxValue :: Text
minValue :: Text
name :: Text
scalingType :: Maybe HyperParameterScalingType
$sel:maxValue:IntegerParameterRange' :: IntegerParameterRange -> Text
$sel:minValue:IntegerParameterRange' :: IntegerParameterRange -> Text
$sel:name:IntegerParameterRange' :: IntegerParameterRange -> Text
$sel:scalingType:IntegerParameterRange' :: IntegerParameterRange -> Maybe HyperParameterScalingType
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe HyperParameterScalingType
scalingType
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
name
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
minValue
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
maxValue

instance Data.ToJSON IntegerParameterRange where
  toJSON :: IntegerParameterRange -> Value
toJSON IntegerParameterRange' {Maybe HyperParameterScalingType
Text
maxValue :: Text
minValue :: Text
name :: Text
scalingType :: Maybe HyperParameterScalingType
$sel:maxValue:IntegerParameterRange' :: IntegerParameterRange -> Text
$sel:minValue:IntegerParameterRange' :: IntegerParameterRange -> Text
$sel:name:IntegerParameterRange' :: IntegerParameterRange -> Text
$sel:scalingType:IntegerParameterRange' :: IntegerParameterRange -> Maybe HyperParameterScalingType
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"ScalingType" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe HyperParameterScalingType
scalingType,
            forall a. a -> Maybe a
Prelude.Just (Key
"Name" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
name),
            forall a. a -> Maybe a
Prelude.Just (Key
"MinValue" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
minValue),
            forall a. a -> Maybe a
Prelude.Just (Key
"MaxValue" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
maxValue)
          ]
      )