{-# 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.HyperParameterRanges
-- 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.HyperParameterRanges where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.Personalize.Types.CategoricalHyperParameterRange
import Amazonka.Personalize.Types.ContinuousHyperParameterRange
import Amazonka.Personalize.Types.IntegerHyperParameterRange
import qualified Amazonka.Prelude as Prelude

-- | Specifies the hyperparameters and their ranges. Hyperparameters can be
-- categorical, continuous, or integer-valued.
--
-- /See:/ 'newHyperParameterRanges' smart constructor.
data HyperParameterRanges = HyperParameterRanges'
  { -- | The categorical hyperparameters and their ranges.
    HyperParameterRanges -> Maybe [CategoricalHyperParameterRange]
categoricalHyperParameterRanges :: Prelude.Maybe [CategoricalHyperParameterRange],
    -- | The continuous hyperparameters and their ranges.
    HyperParameterRanges -> Maybe [ContinuousHyperParameterRange]
continuousHyperParameterRanges :: Prelude.Maybe [ContinuousHyperParameterRange],
    -- | The integer-valued hyperparameters and their ranges.
    HyperParameterRanges -> Maybe [IntegerHyperParameterRange]
integerHyperParameterRanges :: Prelude.Maybe [IntegerHyperParameterRange]
  }
  deriving (HyperParameterRanges -> HyperParameterRanges -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: HyperParameterRanges -> HyperParameterRanges -> Bool
$c/= :: HyperParameterRanges -> HyperParameterRanges -> Bool
== :: HyperParameterRanges -> HyperParameterRanges -> Bool
$c== :: HyperParameterRanges -> HyperParameterRanges -> Bool
Prelude.Eq, ReadPrec [HyperParameterRanges]
ReadPrec HyperParameterRanges
Int -> ReadS HyperParameterRanges
ReadS [HyperParameterRanges]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [HyperParameterRanges]
$creadListPrec :: ReadPrec [HyperParameterRanges]
readPrec :: ReadPrec HyperParameterRanges
$creadPrec :: ReadPrec HyperParameterRanges
readList :: ReadS [HyperParameterRanges]
$creadList :: ReadS [HyperParameterRanges]
readsPrec :: Int -> ReadS HyperParameterRanges
$creadsPrec :: Int -> ReadS HyperParameterRanges
Prelude.Read, Int -> HyperParameterRanges -> ShowS
[HyperParameterRanges] -> ShowS
HyperParameterRanges -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [HyperParameterRanges] -> ShowS
$cshowList :: [HyperParameterRanges] -> ShowS
show :: HyperParameterRanges -> String
$cshow :: HyperParameterRanges -> String
showsPrec :: Int -> HyperParameterRanges -> ShowS
$cshowsPrec :: Int -> HyperParameterRanges -> ShowS
Prelude.Show, forall x. Rep HyperParameterRanges x -> HyperParameterRanges
forall x. HyperParameterRanges -> Rep HyperParameterRanges x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep HyperParameterRanges x -> HyperParameterRanges
$cfrom :: forall x. HyperParameterRanges -> Rep HyperParameterRanges x
Prelude.Generic)

-- |
-- Create a value of 'HyperParameterRanges' 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:
--
-- 'categoricalHyperParameterRanges', 'hyperParameterRanges_categoricalHyperParameterRanges' - The categorical hyperparameters and their ranges.
--
-- 'continuousHyperParameterRanges', 'hyperParameterRanges_continuousHyperParameterRanges' - The continuous hyperparameters and their ranges.
--
-- 'integerHyperParameterRanges', 'hyperParameterRanges_integerHyperParameterRanges' - The integer-valued hyperparameters and their ranges.
newHyperParameterRanges ::
  HyperParameterRanges
newHyperParameterRanges :: HyperParameterRanges
newHyperParameterRanges =
  HyperParameterRanges'
    { $sel:categoricalHyperParameterRanges:HyperParameterRanges' :: Maybe [CategoricalHyperParameterRange]
categoricalHyperParameterRanges =
        forall a. Maybe a
Prelude.Nothing,
      $sel:continuousHyperParameterRanges:HyperParameterRanges' :: Maybe [ContinuousHyperParameterRange]
continuousHyperParameterRanges = forall a. Maybe a
Prelude.Nothing,
      $sel:integerHyperParameterRanges:HyperParameterRanges' :: Maybe [IntegerHyperParameterRange]
integerHyperParameterRanges = forall a. Maybe a
Prelude.Nothing
    }

-- | The categorical hyperparameters and their ranges.
hyperParameterRanges_categoricalHyperParameterRanges :: Lens.Lens' HyperParameterRanges (Prelude.Maybe [CategoricalHyperParameterRange])
hyperParameterRanges_categoricalHyperParameterRanges :: Lens' HyperParameterRanges (Maybe [CategoricalHyperParameterRange])
hyperParameterRanges_categoricalHyperParameterRanges = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\HyperParameterRanges' {Maybe [CategoricalHyperParameterRange]
categoricalHyperParameterRanges :: Maybe [CategoricalHyperParameterRange]
$sel:categoricalHyperParameterRanges:HyperParameterRanges' :: HyperParameterRanges -> Maybe [CategoricalHyperParameterRange]
categoricalHyperParameterRanges} -> Maybe [CategoricalHyperParameterRange]
categoricalHyperParameterRanges) (\s :: HyperParameterRanges
s@HyperParameterRanges' {} Maybe [CategoricalHyperParameterRange]
a -> HyperParameterRanges
s {$sel:categoricalHyperParameterRanges:HyperParameterRanges' :: Maybe [CategoricalHyperParameterRange]
categoricalHyperParameterRanges = Maybe [CategoricalHyperParameterRange]
a} :: HyperParameterRanges) 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

-- | The continuous hyperparameters and their ranges.
hyperParameterRanges_continuousHyperParameterRanges :: Lens.Lens' HyperParameterRanges (Prelude.Maybe [ContinuousHyperParameterRange])
hyperParameterRanges_continuousHyperParameterRanges :: Lens' HyperParameterRanges (Maybe [ContinuousHyperParameterRange])
hyperParameterRanges_continuousHyperParameterRanges = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\HyperParameterRanges' {Maybe [ContinuousHyperParameterRange]
continuousHyperParameterRanges :: Maybe [ContinuousHyperParameterRange]
$sel:continuousHyperParameterRanges:HyperParameterRanges' :: HyperParameterRanges -> Maybe [ContinuousHyperParameterRange]
continuousHyperParameterRanges} -> Maybe [ContinuousHyperParameterRange]
continuousHyperParameterRanges) (\s :: HyperParameterRanges
s@HyperParameterRanges' {} Maybe [ContinuousHyperParameterRange]
a -> HyperParameterRanges
s {$sel:continuousHyperParameterRanges:HyperParameterRanges' :: Maybe [ContinuousHyperParameterRange]
continuousHyperParameterRanges = Maybe [ContinuousHyperParameterRange]
a} :: HyperParameterRanges) 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

-- | The integer-valued hyperparameters and their ranges.
hyperParameterRanges_integerHyperParameterRanges :: Lens.Lens' HyperParameterRanges (Prelude.Maybe [IntegerHyperParameterRange])
hyperParameterRanges_integerHyperParameterRanges :: Lens' HyperParameterRanges (Maybe [IntegerHyperParameterRange])
hyperParameterRanges_integerHyperParameterRanges = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\HyperParameterRanges' {Maybe [IntegerHyperParameterRange]
integerHyperParameterRanges :: Maybe [IntegerHyperParameterRange]
$sel:integerHyperParameterRanges:HyperParameterRanges' :: HyperParameterRanges -> Maybe [IntegerHyperParameterRange]
integerHyperParameterRanges} -> Maybe [IntegerHyperParameterRange]
integerHyperParameterRanges) (\s :: HyperParameterRanges
s@HyperParameterRanges' {} Maybe [IntegerHyperParameterRange]
a -> HyperParameterRanges
s {$sel:integerHyperParameterRanges:HyperParameterRanges' :: Maybe [IntegerHyperParameterRange]
integerHyperParameterRanges = Maybe [IntegerHyperParameterRange]
a} :: HyperParameterRanges) 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 HyperParameterRanges where
  parseJSON :: Value -> Parser HyperParameterRanges
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"HyperParameterRanges"
      ( \Object
x ->
          Maybe [CategoricalHyperParameterRange]
-> Maybe [ContinuousHyperParameterRange]
-> Maybe [IntegerHyperParameterRange]
-> HyperParameterRanges
HyperParameterRanges'
            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
"categoricalHyperParameterRanges"
                            forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty
                        )
            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
"continuousHyperParameterRanges"
                            forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty
                        )
            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
"integerHyperParameterRanges"
                            forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty
                        )
      )

instance Prelude.Hashable HyperParameterRanges where
  hashWithSalt :: Int -> HyperParameterRanges -> Int
hashWithSalt Int
_salt HyperParameterRanges' {Maybe [CategoricalHyperParameterRange]
Maybe [ContinuousHyperParameterRange]
Maybe [IntegerHyperParameterRange]
integerHyperParameterRanges :: Maybe [IntegerHyperParameterRange]
continuousHyperParameterRanges :: Maybe [ContinuousHyperParameterRange]
categoricalHyperParameterRanges :: Maybe [CategoricalHyperParameterRange]
$sel:integerHyperParameterRanges:HyperParameterRanges' :: HyperParameterRanges -> Maybe [IntegerHyperParameterRange]
$sel:continuousHyperParameterRanges:HyperParameterRanges' :: HyperParameterRanges -> Maybe [ContinuousHyperParameterRange]
$sel:categoricalHyperParameterRanges:HyperParameterRanges' :: HyperParameterRanges -> Maybe [CategoricalHyperParameterRange]
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [CategoricalHyperParameterRange]
categoricalHyperParameterRanges
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [ContinuousHyperParameterRange]
continuousHyperParameterRanges
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [IntegerHyperParameterRange]
integerHyperParameterRanges

instance Prelude.NFData HyperParameterRanges where
  rnf :: HyperParameterRanges -> ()
rnf HyperParameterRanges' {Maybe [CategoricalHyperParameterRange]
Maybe [ContinuousHyperParameterRange]
Maybe [IntegerHyperParameterRange]
integerHyperParameterRanges :: Maybe [IntegerHyperParameterRange]
continuousHyperParameterRanges :: Maybe [ContinuousHyperParameterRange]
categoricalHyperParameterRanges :: Maybe [CategoricalHyperParameterRange]
$sel:integerHyperParameterRanges:HyperParameterRanges' :: HyperParameterRanges -> Maybe [IntegerHyperParameterRange]
$sel:continuousHyperParameterRanges:HyperParameterRanges' :: HyperParameterRanges -> Maybe [ContinuousHyperParameterRange]
$sel:categoricalHyperParameterRanges:HyperParameterRanges' :: HyperParameterRanges -> Maybe [CategoricalHyperParameterRange]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [CategoricalHyperParameterRange]
categoricalHyperParameterRanges
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [ContinuousHyperParameterRange]
continuousHyperParameterRanges
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [IntegerHyperParameterRange]
integerHyperParameterRanges

instance Data.ToJSON HyperParameterRanges where
  toJSON :: HyperParameterRanges -> Value
toJSON HyperParameterRanges' {Maybe [CategoricalHyperParameterRange]
Maybe [ContinuousHyperParameterRange]
Maybe [IntegerHyperParameterRange]
integerHyperParameterRanges :: Maybe [IntegerHyperParameterRange]
continuousHyperParameterRanges :: Maybe [ContinuousHyperParameterRange]
categoricalHyperParameterRanges :: Maybe [CategoricalHyperParameterRange]
$sel:integerHyperParameterRanges:HyperParameterRanges' :: HyperParameterRanges -> Maybe [IntegerHyperParameterRange]
$sel:continuousHyperParameterRanges:HyperParameterRanges' :: HyperParameterRanges -> Maybe [ContinuousHyperParameterRange]
$sel:categoricalHyperParameterRanges:HyperParameterRanges' :: HyperParameterRanges -> Maybe [CategoricalHyperParameterRange]
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"categoricalHyperParameterRanges" 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 [CategoricalHyperParameterRange]
categoricalHyperParameterRanges,
            (Key
"continuousHyperParameterRanges" 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 [ContinuousHyperParameterRange]
continuousHyperParameterRanges,
            (Key
"integerHyperParameterRanges" 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 [IntegerHyperParameterRange]
integerHyperParameterRanges
          ]
      )