{-# 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.DriftCheckBias
-- 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.DriftCheckBias 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.FileSource
import Amazonka.SageMaker.Types.MetricsSource

-- | Represents the drift check bias baselines that can be used when the
-- model monitor is set using the model package.
--
-- /See:/ 'newDriftCheckBias' smart constructor.
data DriftCheckBias = DriftCheckBias'
  { -- | The bias config file for a model.
    DriftCheckBias -> Maybe FileSource
configFile :: Prelude.Maybe FileSource,
    -- | The post-training constraints.
    DriftCheckBias -> Maybe MetricsSource
postTrainingConstraints :: Prelude.Maybe MetricsSource,
    -- | The pre-training constraints.
    DriftCheckBias -> Maybe MetricsSource
preTrainingConstraints :: Prelude.Maybe MetricsSource
  }
  deriving (DriftCheckBias -> DriftCheckBias -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DriftCheckBias -> DriftCheckBias -> Bool
$c/= :: DriftCheckBias -> DriftCheckBias -> Bool
== :: DriftCheckBias -> DriftCheckBias -> Bool
$c== :: DriftCheckBias -> DriftCheckBias -> Bool
Prelude.Eq, ReadPrec [DriftCheckBias]
ReadPrec DriftCheckBias
Int -> ReadS DriftCheckBias
ReadS [DriftCheckBias]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DriftCheckBias]
$creadListPrec :: ReadPrec [DriftCheckBias]
readPrec :: ReadPrec DriftCheckBias
$creadPrec :: ReadPrec DriftCheckBias
readList :: ReadS [DriftCheckBias]
$creadList :: ReadS [DriftCheckBias]
readsPrec :: Int -> ReadS DriftCheckBias
$creadsPrec :: Int -> ReadS DriftCheckBias
Prelude.Read, Int -> DriftCheckBias -> ShowS
[DriftCheckBias] -> ShowS
DriftCheckBias -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DriftCheckBias] -> ShowS
$cshowList :: [DriftCheckBias] -> ShowS
show :: DriftCheckBias -> String
$cshow :: DriftCheckBias -> String
showsPrec :: Int -> DriftCheckBias -> ShowS
$cshowsPrec :: Int -> DriftCheckBias -> ShowS
Prelude.Show, forall x. Rep DriftCheckBias x -> DriftCheckBias
forall x. DriftCheckBias -> Rep DriftCheckBias x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DriftCheckBias x -> DriftCheckBias
$cfrom :: forall x. DriftCheckBias -> Rep DriftCheckBias x
Prelude.Generic)

-- |
-- Create a value of 'DriftCheckBias' 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:
--
-- 'configFile', 'driftCheckBias_configFile' - The bias config file for a model.
--
-- 'postTrainingConstraints', 'driftCheckBias_postTrainingConstraints' - The post-training constraints.
--
-- 'preTrainingConstraints', 'driftCheckBias_preTrainingConstraints' - The pre-training constraints.
newDriftCheckBias ::
  DriftCheckBias
newDriftCheckBias :: DriftCheckBias
newDriftCheckBias =
  DriftCheckBias'
    { $sel:configFile:DriftCheckBias' :: Maybe FileSource
configFile = forall a. Maybe a
Prelude.Nothing,
      $sel:postTrainingConstraints:DriftCheckBias' :: Maybe MetricsSource
postTrainingConstraints = forall a. Maybe a
Prelude.Nothing,
      $sel:preTrainingConstraints:DriftCheckBias' :: Maybe MetricsSource
preTrainingConstraints = forall a. Maybe a
Prelude.Nothing
    }

-- | The bias config file for a model.
driftCheckBias_configFile :: Lens.Lens' DriftCheckBias (Prelude.Maybe FileSource)
driftCheckBias_configFile :: Lens' DriftCheckBias (Maybe FileSource)
driftCheckBias_configFile = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DriftCheckBias' {Maybe FileSource
configFile :: Maybe FileSource
$sel:configFile:DriftCheckBias' :: DriftCheckBias -> Maybe FileSource
configFile} -> Maybe FileSource
configFile) (\s :: DriftCheckBias
s@DriftCheckBias' {} Maybe FileSource
a -> DriftCheckBias
s {$sel:configFile:DriftCheckBias' :: Maybe FileSource
configFile = Maybe FileSource
a} :: DriftCheckBias)

-- | The post-training constraints.
driftCheckBias_postTrainingConstraints :: Lens.Lens' DriftCheckBias (Prelude.Maybe MetricsSource)
driftCheckBias_postTrainingConstraints :: Lens' DriftCheckBias (Maybe MetricsSource)
driftCheckBias_postTrainingConstraints = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DriftCheckBias' {Maybe MetricsSource
postTrainingConstraints :: Maybe MetricsSource
$sel:postTrainingConstraints:DriftCheckBias' :: DriftCheckBias -> Maybe MetricsSource
postTrainingConstraints} -> Maybe MetricsSource
postTrainingConstraints) (\s :: DriftCheckBias
s@DriftCheckBias' {} Maybe MetricsSource
a -> DriftCheckBias
s {$sel:postTrainingConstraints:DriftCheckBias' :: Maybe MetricsSource
postTrainingConstraints = Maybe MetricsSource
a} :: DriftCheckBias)

-- | The pre-training constraints.
driftCheckBias_preTrainingConstraints :: Lens.Lens' DriftCheckBias (Prelude.Maybe MetricsSource)
driftCheckBias_preTrainingConstraints :: Lens' DriftCheckBias (Maybe MetricsSource)
driftCheckBias_preTrainingConstraints = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DriftCheckBias' {Maybe MetricsSource
preTrainingConstraints :: Maybe MetricsSource
$sel:preTrainingConstraints:DriftCheckBias' :: DriftCheckBias -> Maybe MetricsSource
preTrainingConstraints} -> Maybe MetricsSource
preTrainingConstraints) (\s :: DriftCheckBias
s@DriftCheckBias' {} Maybe MetricsSource
a -> DriftCheckBias
s {$sel:preTrainingConstraints:DriftCheckBias' :: Maybe MetricsSource
preTrainingConstraints = Maybe MetricsSource
a} :: DriftCheckBias)

instance Data.FromJSON DriftCheckBias where
  parseJSON :: Value -> Parser DriftCheckBias
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"DriftCheckBias"
      ( \Object
x ->
          Maybe FileSource
-> Maybe MetricsSource -> Maybe MetricsSource -> DriftCheckBias
DriftCheckBias'
            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
"ConfigFile")
            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
"PostTrainingConstraints")
            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
"PreTrainingConstraints")
      )

instance Prelude.Hashable DriftCheckBias where
  hashWithSalt :: Int -> DriftCheckBias -> Int
hashWithSalt Int
_salt DriftCheckBias' {Maybe FileSource
Maybe MetricsSource
preTrainingConstraints :: Maybe MetricsSource
postTrainingConstraints :: Maybe MetricsSource
configFile :: Maybe FileSource
$sel:preTrainingConstraints:DriftCheckBias' :: DriftCheckBias -> Maybe MetricsSource
$sel:postTrainingConstraints:DriftCheckBias' :: DriftCheckBias -> Maybe MetricsSource
$sel:configFile:DriftCheckBias' :: DriftCheckBias -> Maybe FileSource
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe FileSource
configFile
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe MetricsSource
postTrainingConstraints
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe MetricsSource
preTrainingConstraints

instance Prelude.NFData DriftCheckBias where
  rnf :: DriftCheckBias -> ()
rnf DriftCheckBias' {Maybe FileSource
Maybe MetricsSource
preTrainingConstraints :: Maybe MetricsSource
postTrainingConstraints :: Maybe MetricsSource
configFile :: Maybe FileSource
$sel:preTrainingConstraints:DriftCheckBias' :: DriftCheckBias -> Maybe MetricsSource
$sel:postTrainingConstraints:DriftCheckBias' :: DriftCheckBias -> Maybe MetricsSource
$sel:configFile:DriftCheckBias' :: DriftCheckBias -> Maybe FileSource
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe FileSource
configFile
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe MetricsSource
postTrainingConstraints
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe MetricsSource
preTrainingConstraints

instance Data.ToJSON DriftCheckBias where
  toJSON :: DriftCheckBias -> Value
toJSON DriftCheckBias' {Maybe FileSource
Maybe MetricsSource
preTrainingConstraints :: Maybe MetricsSource
postTrainingConstraints :: Maybe MetricsSource
configFile :: Maybe FileSource
$sel:preTrainingConstraints:DriftCheckBias' :: DriftCheckBias -> Maybe MetricsSource
$sel:postTrainingConstraints:DriftCheckBias' :: DriftCheckBias -> Maybe MetricsSource
$sel:configFile:DriftCheckBias' :: DriftCheckBias -> Maybe FileSource
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"ConfigFile" 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 FileSource
configFile,
            (Key
"PostTrainingConstraints" 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 MetricsSource
postTrainingConstraints,
            (Key
"PreTrainingConstraints" 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 MetricsSource
preTrainingConstraints
          ]
      )