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

-- |
-- Create a value of 'DriftCheckExplainability' 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', 'driftCheckExplainability_configFile' - The explainability config file for the model.
--
-- 'constraints', 'driftCheckExplainability_constraints' - The drift check explainability constraints.
newDriftCheckExplainability ::
  DriftCheckExplainability
newDriftCheckExplainability :: DriftCheckExplainability
newDriftCheckExplainability =
  DriftCheckExplainability'
    { $sel:configFile:DriftCheckExplainability' :: Maybe FileSource
configFile =
        forall a. Maybe a
Prelude.Nothing,
      $sel:constraints:DriftCheckExplainability' :: Maybe MetricsSource
constraints = forall a. Maybe a
Prelude.Nothing
    }

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

-- | The drift check explainability constraints.
driftCheckExplainability_constraints :: Lens.Lens' DriftCheckExplainability (Prelude.Maybe MetricsSource)
driftCheckExplainability_constraints :: Lens' DriftCheckExplainability (Maybe MetricsSource)
driftCheckExplainability_constraints = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DriftCheckExplainability' {Maybe MetricsSource
constraints :: Maybe MetricsSource
$sel:constraints:DriftCheckExplainability' :: DriftCheckExplainability -> Maybe MetricsSource
constraints} -> Maybe MetricsSource
constraints) (\s :: DriftCheckExplainability
s@DriftCheckExplainability' {} Maybe MetricsSource
a -> DriftCheckExplainability
s {$sel:constraints:DriftCheckExplainability' :: Maybe MetricsSource
constraints = Maybe MetricsSource
a} :: DriftCheckExplainability)

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

instance Prelude.Hashable DriftCheckExplainability where
  hashWithSalt :: Int -> DriftCheckExplainability -> Int
hashWithSalt Int
_salt DriftCheckExplainability' {Maybe FileSource
Maybe MetricsSource
constraints :: Maybe MetricsSource
configFile :: Maybe FileSource
$sel:constraints:DriftCheckExplainability' :: DriftCheckExplainability -> Maybe MetricsSource
$sel:configFile:DriftCheckExplainability' :: DriftCheckExplainability -> 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
constraints

instance Prelude.NFData DriftCheckExplainability where
  rnf :: DriftCheckExplainability -> ()
rnf DriftCheckExplainability' {Maybe FileSource
Maybe MetricsSource
constraints :: Maybe MetricsSource
configFile :: Maybe FileSource
$sel:constraints:DriftCheckExplainability' :: DriftCheckExplainability -> Maybe MetricsSource
$sel:configFile:DriftCheckExplainability' :: DriftCheckExplainability -> 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
constraints

instance Data.ToJSON DriftCheckExplainability where
  toJSON :: DriftCheckExplainability -> Value
toJSON DriftCheckExplainability' {Maybe FileSource
Maybe MetricsSource
constraints :: Maybe MetricsSource
configFile :: Maybe FileSource
$sel:constraints:DriftCheckExplainability' :: DriftCheckExplainability -> Maybe MetricsSource
$sel:configFile:DriftCheckExplainability' :: DriftCheckExplainability -> 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
"Constraints" 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
constraints
          ]
      )