{-# 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.ClarifyExplainerConfig
-- 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.ClarifyExplainerConfig 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.ClarifyInferenceConfig
import Amazonka.SageMaker.Types.ClarifyShapConfig

-- | The configuration parameters for the SageMaker Clarify explainer.
--
-- /See:/ 'newClarifyExplainerConfig' smart constructor.
data ClarifyExplainerConfig = ClarifyExplainerConfig'
  { -- | A JMESPath boolean expression used to filter which records to explain.
    -- Explanations are activated by default. See
    -- <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html#clarify-online-explainability-create-endpoint-enable EnableExplanations>
    -- for additional information.
    ClarifyExplainerConfig -> Maybe Text
enableExplanations :: Prelude.Maybe Prelude.Text,
    -- | The inference configuration parameter for the model container.
    ClarifyExplainerConfig -> Maybe ClarifyInferenceConfig
inferenceConfig :: Prelude.Maybe ClarifyInferenceConfig,
    -- | The configuration for SHAP analysis.
    ClarifyExplainerConfig -> ClarifyShapConfig
shapConfig :: ClarifyShapConfig
  }
  deriving (ClarifyExplainerConfig -> ClarifyExplainerConfig -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ClarifyExplainerConfig -> ClarifyExplainerConfig -> Bool
$c/= :: ClarifyExplainerConfig -> ClarifyExplainerConfig -> Bool
== :: ClarifyExplainerConfig -> ClarifyExplainerConfig -> Bool
$c== :: ClarifyExplainerConfig -> ClarifyExplainerConfig -> Bool
Prelude.Eq, ReadPrec [ClarifyExplainerConfig]
ReadPrec ClarifyExplainerConfig
Int -> ReadS ClarifyExplainerConfig
ReadS [ClarifyExplainerConfig]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ClarifyExplainerConfig]
$creadListPrec :: ReadPrec [ClarifyExplainerConfig]
readPrec :: ReadPrec ClarifyExplainerConfig
$creadPrec :: ReadPrec ClarifyExplainerConfig
readList :: ReadS [ClarifyExplainerConfig]
$creadList :: ReadS [ClarifyExplainerConfig]
readsPrec :: Int -> ReadS ClarifyExplainerConfig
$creadsPrec :: Int -> ReadS ClarifyExplainerConfig
Prelude.Read, Int -> ClarifyExplainerConfig -> ShowS
[ClarifyExplainerConfig] -> ShowS
ClarifyExplainerConfig -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ClarifyExplainerConfig] -> ShowS
$cshowList :: [ClarifyExplainerConfig] -> ShowS
show :: ClarifyExplainerConfig -> String
$cshow :: ClarifyExplainerConfig -> String
showsPrec :: Int -> ClarifyExplainerConfig -> ShowS
$cshowsPrec :: Int -> ClarifyExplainerConfig -> ShowS
Prelude.Show, forall x. Rep ClarifyExplainerConfig x -> ClarifyExplainerConfig
forall x. ClarifyExplainerConfig -> Rep ClarifyExplainerConfig x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ClarifyExplainerConfig x -> ClarifyExplainerConfig
$cfrom :: forall x. ClarifyExplainerConfig -> Rep ClarifyExplainerConfig x
Prelude.Generic)

-- |
-- Create a value of 'ClarifyExplainerConfig' 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:
--
-- 'enableExplanations', 'clarifyExplainerConfig_enableExplanations' - A JMESPath boolean expression used to filter which records to explain.
-- Explanations are activated by default. See
-- <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html#clarify-online-explainability-create-endpoint-enable EnableExplanations>
-- for additional information.
--
-- 'inferenceConfig', 'clarifyExplainerConfig_inferenceConfig' - The inference configuration parameter for the model container.
--
-- 'shapConfig', 'clarifyExplainerConfig_shapConfig' - The configuration for SHAP analysis.
newClarifyExplainerConfig ::
  -- | 'shapConfig'
  ClarifyShapConfig ->
  ClarifyExplainerConfig
newClarifyExplainerConfig :: ClarifyShapConfig -> ClarifyExplainerConfig
newClarifyExplainerConfig ClarifyShapConfig
pShapConfig_ =
  ClarifyExplainerConfig'
    { $sel:enableExplanations:ClarifyExplainerConfig' :: Maybe Text
enableExplanations =
        forall a. Maybe a
Prelude.Nothing,
      $sel:inferenceConfig:ClarifyExplainerConfig' :: Maybe ClarifyInferenceConfig
inferenceConfig = forall a. Maybe a
Prelude.Nothing,
      $sel:shapConfig:ClarifyExplainerConfig' :: ClarifyShapConfig
shapConfig = ClarifyShapConfig
pShapConfig_
    }

-- | A JMESPath boolean expression used to filter which records to explain.
-- Explanations are activated by default. See
-- <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html#clarify-online-explainability-create-endpoint-enable EnableExplanations>
-- for additional information.
clarifyExplainerConfig_enableExplanations :: Lens.Lens' ClarifyExplainerConfig (Prelude.Maybe Prelude.Text)
clarifyExplainerConfig_enableExplanations :: Lens' ClarifyExplainerConfig (Maybe Text)
clarifyExplainerConfig_enableExplanations = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ClarifyExplainerConfig' {Maybe Text
enableExplanations :: Maybe Text
$sel:enableExplanations:ClarifyExplainerConfig' :: ClarifyExplainerConfig -> Maybe Text
enableExplanations} -> Maybe Text
enableExplanations) (\s :: ClarifyExplainerConfig
s@ClarifyExplainerConfig' {} Maybe Text
a -> ClarifyExplainerConfig
s {$sel:enableExplanations:ClarifyExplainerConfig' :: Maybe Text
enableExplanations = Maybe Text
a} :: ClarifyExplainerConfig)

-- | The inference configuration parameter for the model container.
clarifyExplainerConfig_inferenceConfig :: Lens.Lens' ClarifyExplainerConfig (Prelude.Maybe ClarifyInferenceConfig)
clarifyExplainerConfig_inferenceConfig :: Lens' ClarifyExplainerConfig (Maybe ClarifyInferenceConfig)
clarifyExplainerConfig_inferenceConfig = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ClarifyExplainerConfig' {Maybe ClarifyInferenceConfig
inferenceConfig :: Maybe ClarifyInferenceConfig
$sel:inferenceConfig:ClarifyExplainerConfig' :: ClarifyExplainerConfig -> Maybe ClarifyInferenceConfig
inferenceConfig} -> Maybe ClarifyInferenceConfig
inferenceConfig) (\s :: ClarifyExplainerConfig
s@ClarifyExplainerConfig' {} Maybe ClarifyInferenceConfig
a -> ClarifyExplainerConfig
s {$sel:inferenceConfig:ClarifyExplainerConfig' :: Maybe ClarifyInferenceConfig
inferenceConfig = Maybe ClarifyInferenceConfig
a} :: ClarifyExplainerConfig)

-- | The configuration for SHAP analysis.
clarifyExplainerConfig_shapConfig :: Lens.Lens' ClarifyExplainerConfig ClarifyShapConfig
clarifyExplainerConfig_shapConfig :: Lens' ClarifyExplainerConfig ClarifyShapConfig
clarifyExplainerConfig_shapConfig = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ClarifyExplainerConfig' {ClarifyShapConfig
shapConfig :: ClarifyShapConfig
$sel:shapConfig:ClarifyExplainerConfig' :: ClarifyExplainerConfig -> ClarifyShapConfig
shapConfig} -> ClarifyShapConfig
shapConfig) (\s :: ClarifyExplainerConfig
s@ClarifyExplainerConfig' {} ClarifyShapConfig
a -> ClarifyExplainerConfig
s {$sel:shapConfig:ClarifyExplainerConfig' :: ClarifyShapConfig
shapConfig = ClarifyShapConfig
a} :: ClarifyExplainerConfig)

instance Data.FromJSON ClarifyExplainerConfig where
  parseJSON :: Value -> Parser ClarifyExplainerConfig
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"ClarifyExplainerConfig"
      ( \Object
x ->
          Maybe Text
-> Maybe ClarifyInferenceConfig
-> ClarifyShapConfig
-> ClarifyExplainerConfig
ClarifyExplainerConfig'
            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
"EnableExplanations")
            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
"InferenceConfig")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"ShapConfig")
      )

instance Prelude.Hashable ClarifyExplainerConfig where
  hashWithSalt :: Int -> ClarifyExplainerConfig -> Int
hashWithSalt Int
_salt ClarifyExplainerConfig' {Maybe Text
Maybe ClarifyInferenceConfig
ClarifyShapConfig
shapConfig :: ClarifyShapConfig
inferenceConfig :: Maybe ClarifyInferenceConfig
enableExplanations :: Maybe Text
$sel:shapConfig:ClarifyExplainerConfig' :: ClarifyExplainerConfig -> ClarifyShapConfig
$sel:inferenceConfig:ClarifyExplainerConfig' :: ClarifyExplainerConfig -> Maybe ClarifyInferenceConfig
$sel:enableExplanations:ClarifyExplainerConfig' :: ClarifyExplainerConfig -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
enableExplanations
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ClarifyInferenceConfig
inferenceConfig
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` ClarifyShapConfig
shapConfig

instance Prelude.NFData ClarifyExplainerConfig where
  rnf :: ClarifyExplainerConfig -> ()
rnf ClarifyExplainerConfig' {Maybe Text
Maybe ClarifyInferenceConfig
ClarifyShapConfig
shapConfig :: ClarifyShapConfig
inferenceConfig :: Maybe ClarifyInferenceConfig
enableExplanations :: Maybe Text
$sel:shapConfig:ClarifyExplainerConfig' :: ClarifyExplainerConfig -> ClarifyShapConfig
$sel:inferenceConfig:ClarifyExplainerConfig' :: ClarifyExplainerConfig -> Maybe ClarifyInferenceConfig
$sel:enableExplanations:ClarifyExplainerConfig' :: ClarifyExplainerConfig -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
enableExplanations
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe ClarifyInferenceConfig
inferenceConfig
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf ClarifyShapConfig
shapConfig

instance Data.ToJSON ClarifyExplainerConfig where
  toJSON :: ClarifyExplainerConfig -> Value
toJSON ClarifyExplainerConfig' {Maybe Text
Maybe ClarifyInferenceConfig
ClarifyShapConfig
shapConfig :: ClarifyShapConfig
inferenceConfig :: Maybe ClarifyInferenceConfig
enableExplanations :: Maybe Text
$sel:shapConfig:ClarifyExplainerConfig' :: ClarifyExplainerConfig -> ClarifyShapConfig
$sel:inferenceConfig:ClarifyExplainerConfig' :: ClarifyExplainerConfig -> Maybe ClarifyInferenceConfig
$sel:enableExplanations:ClarifyExplainerConfig' :: ClarifyExplainerConfig -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"EnableExplanations" 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 Text
enableExplanations,
            (Key
"InferenceConfig" 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 ClarifyInferenceConfig
inferenceConfig,
            forall a. a -> Maybe a
Prelude.Just (Key
"ShapConfig" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= ClarifyShapConfig
shapConfig)
          ]
      )