{-# 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.DefaultCategoricalHyperParameterRange
-- 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.DefaultCategoricalHyperParameterRange 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 categorical hyperparameter and
-- whether the hyperparameter is tunable. A tunable hyperparameter can have
-- its value determined during hyperparameter optimization (HPO).
--
-- /See:/ 'newDefaultCategoricalHyperParameterRange' smart constructor.
data DefaultCategoricalHyperParameterRange = DefaultCategoricalHyperParameterRange'
  { -- | Whether the hyperparameter is tunable.
    DefaultCategoricalHyperParameterRange -> Maybe Bool
isTunable :: Prelude.Maybe Prelude.Bool,
    -- | The name of the hyperparameter.
    DefaultCategoricalHyperParameterRange -> Maybe Text
name :: Prelude.Maybe Prelude.Text,
    -- | A list of the categories for the hyperparameter.
    DefaultCategoricalHyperParameterRange -> Maybe [Text]
values :: Prelude.Maybe [Prelude.Text]
  }
  deriving (DefaultCategoricalHyperParameterRange
-> DefaultCategoricalHyperParameterRange -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DefaultCategoricalHyperParameterRange
-> DefaultCategoricalHyperParameterRange -> Bool
$c/= :: DefaultCategoricalHyperParameterRange
-> DefaultCategoricalHyperParameterRange -> Bool
== :: DefaultCategoricalHyperParameterRange
-> DefaultCategoricalHyperParameterRange -> Bool
$c== :: DefaultCategoricalHyperParameterRange
-> DefaultCategoricalHyperParameterRange -> Bool
Prelude.Eq, ReadPrec [DefaultCategoricalHyperParameterRange]
ReadPrec DefaultCategoricalHyperParameterRange
Int -> ReadS DefaultCategoricalHyperParameterRange
ReadS [DefaultCategoricalHyperParameterRange]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DefaultCategoricalHyperParameterRange]
$creadListPrec :: ReadPrec [DefaultCategoricalHyperParameterRange]
readPrec :: ReadPrec DefaultCategoricalHyperParameterRange
$creadPrec :: ReadPrec DefaultCategoricalHyperParameterRange
readList :: ReadS [DefaultCategoricalHyperParameterRange]
$creadList :: ReadS [DefaultCategoricalHyperParameterRange]
readsPrec :: Int -> ReadS DefaultCategoricalHyperParameterRange
$creadsPrec :: Int -> ReadS DefaultCategoricalHyperParameterRange
Prelude.Read, Int -> DefaultCategoricalHyperParameterRange -> ShowS
[DefaultCategoricalHyperParameterRange] -> ShowS
DefaultCategoricalHyperParameterRange -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DefaultCategoricalHyperParameterRange] -> ShowS
$cshowList :: [DefaultCategoricalHyperParameterRange] -> ShowS
show :: DefaultCategoricalHyperParameterRange -> String
$cshow :: DefaultCategoricalHyperParameterRange -> String
showsPrec :: Int -> DefaultCategoricalHyperParameterRange -> ShowS
$cshowsPrec :: Int -> DefaultCategoricalHyperParameterRange -> ShowS
Prelude.Show, forall x.
Rep DefaultCategoricalHyperParameterRange x
-> DefaultCategoricalHyperParameterRange
forall x.
DefaultCategoricalHyperParameterRange
-> Rep DefaultCategoricalHyperParameterRange x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep DefaultCategoricalHyperParameterRange x
-> DefaultCategoricalHyperParameterRange
$cfrom :: forall x.
DefaultCategoricalHyperParameterRange
-> Rep DefaultCategoricalHyperParameterRange x
Prelude.Generic)

-- |
-- Create a value of 'DefaultCategoricalHyperParameterRange' 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', 'defaultCategoricalHyperParameterRange_isTunable' - Whether the hyperparameter is tunable.
--
-- 'name', 'defaultCategoricalHyperParameterRange_name' - The name of the hyperparameter.
--
-- 'values', 'defaultCategoricalHyperParameterRange_values' - A list of the categories for the hyperparameter.
newDefaultCategoricalHyperParameterRange ::
  DefaultCategoricalHyperParameterRange
newDefaultCategoricalHyperParameterRange :: DefaultCategoricalHyperParameterRange
newDefaultCategoricalHyperParameterRange =
  DefaultCategoricalHyperParameterRange'
    { $sel:isTunable:DefaultCategoricalHyperParameterRange' :: Maybe Bool
isTunable =
        forall a. Maybe a
Prelude.Nothing,
      $sel:name:DefaultCategoricalHyperParameterRange' :: Maybe Text
name = forall a. Maybe a
Prelude.Nothing,
      $sel:values:DefaultCategoricalHyperParameterRange' :: Maybe [Text]
values = forall a. Maybe a
Prelude.Nothing
    }

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

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

-- | A list of the categories for the hyperparameter.
defaultCategoricalHyperParameterRange_values :: Lens.Lens' DefaultCategoricalHyperParameterRange (Prelude.Maybe [Prelude.Text])
defaultCategoricalHyperParameterRange_values :: Lens' DefaultCategoricalHyperParameterRange (Maybe [Text])
defaultCategoricalHyperParameterRange_values = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DefaultCategoricalHyperParameterRange' {Maybe [Text]
values :: Maybe [Text]
$sel:values:DefaultCategoricalHyperParameterRange' :: DefaultCategoricalHyperParameterRange -> Maybe [Text]
values} -> Maybe [Text]
values) (\s :: DefaultCategoricalHyperParameterRange
s@DefaultCategoricalHyperParameterRange' {} Maybe [Text]
a -> DefaultCategoricalHyperParameterRange
s {$sel:values:DefaultCategoricalHyperParameterRange' :: Maybe [Text]
values = Maybe [Text]
a} :: DefaultCategoricalHyperParameterRange) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance
  Data.FromJSON
    DefaultCategoricalHyperParameterRange
  where
  parseJSON :: Value -> Parser DefaultCategoricalHyperParameterRange
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"DefaultCategoricalHyperParameterRange"
      ( \Object
x ->
          Maybe Bool
-> Maybe Text
-> Maybe [Text]
-> DefaultCategoricalHyperParameterRange
DefaultCategoricalHyperParameterRange'
            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
"name")
            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
"values" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
      )

instance
  Prelude.Hashable
    DefaultCategoricalHyperParameterRange
  where
  hashWithSalt :: Int -> DefaultCategoricalHyperParameterRange -> Int
hashWithSalt
    Int
_salt
    DefaultCategoricalHyperParameterRange' {Maybe Bool
Maybe [Text]
Maybe Text
values :: Maybe [Text]
name :: Maybe Text
isTunable :: Maybe Bool
$sel:values:DefaultCategoricalHyperParameterRange' :: DefaultCategoricalHyperParameterRange -> Maybe [Text]
$sel:name:DefaultCategoricalHyperParameterRange' :: DefaultCategoricalHyperParameterRange -> Maybe Text
$sel:isTunable:DefaultCategoricalHyperParameterRange' :: DefaultCategoricalHyperParameterRange -> 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 Text
name
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Text]
values

instance
  Prelude.NFData
    DefaultCategoricalHyperParameterRange
  where
  rnf :: DefaultCategoricalHyperParameterRange -> ()
rnf DefaultCategoricalHyperParameterRange' {Maybe Bool
Maybe [Text]
Maybe Text
values :: Maybe [Text]
name :: Maybe Text
isTunable :: Maybe Bool
$sel:values:DefaultCategoricalHyperParameterRange' :: DefaultCategoricalHyperParameterRange -> Maybe [Text]
$sel:name:DefaultCategoricalHyperParameterRange' :: DefaultCategoricalHyperParameterRange -> Maybe Text
$sel:isTunable:DefaultCategoricalHyperParameterRange' :: DefaultCategoricalHyperParameterRange -> 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 Text
name
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Text]
values