{-# 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.Personalize.Types.DefaultContinuousHyperParameterRange
-- 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.Personalize.Types.DefaultContinuousHyperParameterRange 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

-- | Provides the name and default range of a continuous hyperparameter and
-- whether the hyperparameter is tunable. A tunable hyperparameter can have
-- its value determined during hyperparameter optimization (HPO).
--
-- /See:/ 'newDefaultContinuousHyperParameterRange' smart constructor.
data DefaultContinuousHyperParameterRange = DefaultContinuousHyperParameterRange'
  { -- | Whether the hyperparameter is tunable.
    DefaultContinuousHyperParameterRange -> Maybe Bool
isTunable :: Prelude.Maybe Prelude.Bool,
    -- | The maximum allowable value for the hyperparameter.
    DefaultContinuousHyperParameterRange -> Maybe Double
maxValue :: Prelude.Maybe Prelude.Double,
    -- | The minimum allowable value for the hyperparameter.
    DefaultContinuousHyperParameterRange -> Maybe Double
minValue :: Prelude.Maybe Prelude.Double,
    -- | The name of the hyperparameter.
    DefaultContinuousHyperParameterRange -> Maybe Text
name :: Prelude.Maybe Prelude.Text
  }
  deriving (DefaultContinuousHyperParameterRange
-> DefaultContinuousHyperParameterRange -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DefaultContinuousHyperParameterRange
-> DefaultContinuousHyperParameterRange -> Bool
$c/= :: DefaultContinuousHyperParameterRange
-> DefaultContinuousHyperParameterRange -> Bool
== :: DefaultContinuousHyperParameterRange
-> DefaultContinuousHyperParameterRange -> Bool
$c== :: DefaultContinuousHyperParameterRange
-> DefaultContinuousHyperParameterRange -> Bool
Prelude.Eq, ReadPrec [DefaultContinuousHyperParameterRange]
ReadPrec DefaultContinuousHyperParameterRange
Int -> ReadS DefaultContinuousHyperParameterRange
ReadS [DefaultContinuousHyperParameterRange]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DefaultContinuousHyperParameterRange]
$creadListPrec :: ReadPrec [DefaultContinuousHyperParameterRange]
readPrec :: ReadPrec DefaultContinuousHyperParameterRange
$creadPrec :: ReadPrec DefaultContinuousHyperParameterRange
readList :: ReadS [DefaultContinuousHyperParameterRange]
$creadList :: ReadS [DefaultContinuousHyperParameterRange]
readsPrec :: Int -> ReadS DefaultContinuousHyperParameterRange
$creadsPrec :: Int -> ReadS DefaultContinuousHyperParameterRange
Prelude.Read, Int -> DefaultContinuousHyperParameterRange -> ShowS
[DefaultContinuousHyperParameterRange] -> ShowS
DefaultContinuousHyperParameterRange -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DefaultContinuousHyperParameterRange] -> ShowS
$cshowList :: [DefaultContinuousHyperParameterRange] -> ShowS
show :: DefaultContinuousHyperParameterRange -> String
$cshow :: DefaultContinuousHyperParameterRange -> String
showsPrec :: Int -> DefaultContinuousHyperParameterRange -> ShowS
$cshowsPrec :: Int -> DefaultContinuousHyperParameterRange -> ShowS
Prelude.Show, forall x.
Rep DefaultContinuousHyperParameterRange x
-> DefaultContinuousHyperParameterRange
forall x.
DefaultContinuousHyperParameterRange
-> Rep DefaultContinuousHyperParameterRange x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep DefaultContinuousHyperParameterRange x
-> DefaultContinuousHyperParameterRange
$cfrom :: forall x.
DefaultContinuousHyperParameterRange
-> Rep DefaultContinuousHyperParameterRange x
Prelude.Generic)

-- |
-- Create a value of 'DefaultContinuousHyperParameterRange' 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:
--
-- 'isTunable', 'defaultContinuousHyperParameterRange_isTunable' - Whether the hyperparameter is tunable.
--
-- 'maxValue', 'defaultContinuousHyperParameterRange_maxValue' - The maximum allowable value for the hyperparameter.
--
-- 'minValue', 'defaultContinuousHyperParameterRange_minValue' - The minimum allowable value for the hyperparameter.
--
-- 'name', 'defaultContinuousHyperParameterRange_name' - The name of the hyperparameter.
newDefaultContinuousHyperParameterRange ::
  DefaultContinuousHyperParameterRange
newDefaultContinuousHyperParameterRange :: DefaultContinuousHyperParameterRange
newDefaultContinuousHyperParameterRange =
  DefaultContinuousHyperParameterRange'
    { $sel:isTunable:DefaultContinuousHyperParameterRange' :: Maybe Bool
isTunable =
        forall a. Maybe a
Prelude.Nothing,
      $sel:maxValue:DefaultContinuousHyperParameterRange' :: Maybe Double
maxValue = forall a. Maybe a
Prelude.Nothing,
      $sel:minValue:DefaultContinuousHyperParameterRange' :: Maybe Double
minValue = forall a. Maybe a
Prelude.Nothing,
      $sel:name:DefaultContinuousHyperParameterRange' :: Maybe Text
name = forall a. Maybe a
Prelude.Nothing
    }

-- | Whether the hyperparameter is tunable.
defaultContinuousHyperParameterRange_isTunable :: Lens.Lens' DefaultContinuousHyperParameterRange (Prelude.Maybe Prelude.Bool)
defaultContinuousHyperParameterRange_isTunable :: Lens' DefaultContinuousHyperParameterRange (Maybe Bool)
defaultContinuousHyperParameterRange_isTunable = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DefaultContinuousHyperParameterRange' {Maybe Bool
isTunable :: Maybe Bool
$sel:isTunable:DefaultContinuousHyperParameterRange' :: DefaultContinuousHyperParameterRange -> Maybe Bool
isTunable} -> Maybe Bool
isTunable) (\s :: DefaultContinuousHyperParameterRange
s@DefaultContinuousHyperParameterRange' {} Maybe Bool
a -> DefaultContinuousHyperParameterRange
s {$sel:isTunable:DefaultContinuousHyperParameterRange' :: Maybe Bool
isTunable = Maybe Bool
a} :: DefaultContinuousHyperParameterRange)

-- | The maximum allowable value for the hyperparameter.
defaultContinuousHyperParameterRange_maxValue :: Lens.Lens' DefaultContinuousHyperParameterRange (Prelude.Maybe Prelude.Double)
defaultContinuousHyperParameterRange_maxValue :: Lens' DefaultContinuousHyperParameterRange (Maybe Double)
defaultContinuousHyperParameterRange_maxValue = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DefaultContinuousHyperParameterRange' {Maybe Double
maxValue :: Maybe Double
$sel:maxValue:DefaultContinuousHyperParameterRange' :: DefaultContinuousHyperParameterRange -> Maybe Double
maxValue} -> Maybe Double
maxValue) (\s :: DefaultContinuousHyperParameterRange
s@DefaultContinuousHyperParameterRange' {} Maybe Double
a -> DefaultContinuousHyperParameterRange
s {$sel:maxValue:DefaultContinuousHyperParameterRange' :: Maybe Double
maxValue = Maybe Double
a} :: DefaultContinuousHyperParameterRange)

-- | The minimum allowable value for the hyperparameter.
defaultContinuousHyperParameterRange_minValue :: Lens.Lens' DefaultContinuousHyperParameterRange (Prelude.Maybe Prelude.Double)
defaultContinuousHyperParameterRange_minValue :: Lens' DefaultContinuousHyperParameterRange (Maybe Double)
defaultContinuousHyperParameterRange_minValue = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DefaultContinuousHyperParameterRange' {Maybe Double
minValue :: Maybe Double
$sel:minValue:DefaultContinuousHyperParameterRange' :: DefaultContinuousHyperParameterRange -> Maybe Double
minValue} -> Maybe Double
minValue) (\s :: DefaultContinuousHyperParameterRange
s@DefaultContinuousHyperParameterRange' {} Maybe Double
a -> DefaultContinuousHyperParameterRange
s {$sel:minValue:DefaultContinuousHyperParameterRange' :: Maybe Double
minValue = Maybe Double
a} :: DefaultContinuousHyperParameterRange)

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

instance
  Data.FromJSON
    DefaultContinuousHyperParameterRange
  where
  parseJSON :: Value -> Parser DefaultContinuousHyperParameterRange
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"DefaultContinuousHyperParameterRange"
      ( \Object
x ->
          Maybe Bool
-> Maybe Double
-> Maybe Double
-> Maybe Text
-> DefaultContinuousHyperParameterRange
DefaultContinuousHyperParameterRange'
            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
"isTunable")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"maxValue")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe 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 (Maybe a)
Data..:? Key
"name")
      )

instance
  Prelude.Hashable
    DefaultContinuousHyperParameterRange
  where
  hashWithSalt :: Int -> DefaultContinuousHyperParameterRange -> Int
hashWithSalt
    Int
_salt
    DefaultContinuousHyperParameterRange' {Maybe Bool
Maybe Double
Maybe Text
name :: Maybe Text
minValue :: Maybe Double
maxValue :: Maybe Double
isTunable :: Maybe Bool
$sel:name:DefaultContinuousHyperParameterRange' :: DefaultContinuousHyperParameterRange -> Maybe Text
$sel:minValue:DefaultContinuousHyperParameterRange' :: DefaultContinuousHyperParameterRange -> Maybe Double
$sel:maxValue:DefaultContinuousHyperParameterRange' :: DefaultContinuousHyperParameterRange -> Maybe Double
$sel:isTunable:DefaultContinuousHyperParameterRange' :: DefaultContinuousHyperParameterRange -> Maybe Bool
..} =
      Int
_salt
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
isTunable
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Double
maxValue
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Double
minValue
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
name

instance
  Prelude.NFData
    DefaultContinuousHyperParameterRange
  where
  rnf :: DefaultContinuousHyperParameterRange -> ()
rnf DefaultContinuousHyperParameterRange' {Maybe Bool
Maybe Double
Maybe Text
name :: Maybe Text
minValue :: Maybe Double
maxValue :: Maybe Double
isTunable :: Maybe Bool
$sel:name:DefaultContinuousHyperParameterRange' :: DefaultContinuousHyperParameterRange -> Maybe Text
$sel:minValue:DefaultContinuousHyperParameterRange' :: DefaultContinuousHyperParameterRange -> Maybe Double
$sel:maxValue:DefaultContinuousHyperParameterRange' :: DefaultContinuousHyperParameterRange -> Maybe Double
$sel:isTunable:DefaultContinuousHyperParameterRange' :: DefaultContinuousHyperParameterRange -> Maybe Bool
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
isTunable
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Double
maxValue
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Double
minValue
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
name