{-# 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.FraudDetector.Types.TrainingResultV2
-- 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.FraudDetector.Types.TrainingResultV2 where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.FraudDetector.Types.AggregatedVariablesImportanceMetrics
import Amazonka.FraudDetector.Types.DataValidationMetrics
import Amazonka.FraudDetector.Types.TrainingMetricsV2
import Amazonka.FraudDetector.Types.VariableImportanceMetrics
import qualified Amazonka.Prelude as Prelude

-- | The training result details.
--
-- /See:/ 'newTrainingResultV2' smart constructor.
data TrainingResultV2 = TrainingResultV2'
  { -- | The variable importance metrics of the aggregated variables.
    --
    -- Account Takeover Insights (ATI) model uses event variables from the
    -- login data you provide to continuously calculate a set of variables
    -- (aggregated variables) based on historical events. For example, your ATI
    -- model might calculate the number of times an user has logged in using
    -- the same IP address. In this case, event variables used to derive the
    -- aggregated variables are @IP address@ and @user@.
    TrainingResultV2 -> Maybe AggregatedVariablesImportanceMetrics
aggregatedVariablesImportanceMetrics :: Prelude.Maybe AggregatedVariablesImportanceMetrics,
    TrainingResultV2 -> Maybe DataValidationMetrics
dataValidationMetrics :: Prelude.Maybe DataValidationMetrics,
    -- | The training metric details.
    TrainingResultV2 -> Maybe TrainingMetricsV2
trainingMetricsV2 :: Prelude.Maybe TrainingMetricsV2,
    TrainingResultV2 -> Maybe VariableImportanceMetrics
variableImportanceMetrics :: Prelude.Maybe VariableImportanceMetrics
  }
  deriving (TrainingResultV2 -> TrainingResultV2 -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: TrainingResultV2 -> TrainingResultV2 -> Bool
$c/= :: TrainingResultV2 -> TrainingResultV2 -> Bool
== :: TrainingResultV2 -> TrainingResultV2 -> Bool
$c== :: TrainingResultV2 -> TrainingResultV2 -> Bool
Prelude.Eq, ReadPrec [TrainingResultV2]
ReadPrec TrainingResultV2
Int -> ReadS TrainingResultV2
ReadS [TrainingResultV2]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [TrainingResultV2]
$creadListPrec :: ReadPrec [TrainingResultV2]
readPrec :: ReadPrec TrainingResultV2
$creadPrec :: ReadPrec TrainingResultV2
readList :: ReadS [TrainingResultV2]
$creadList :: ReadS [TrainingResultV2]
readsPrec :: Int -> ReadS TrainingResultV2
$creadsPrec :: Int -> ReadS TrainingResultV2
Prelude.Read, Int -> TrainingResultV2 -> ShowS
[TrainingResultV2] -> ShowS
TrainingResultV2 -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [TrainingResultV2] -> ShowS
$cshowList :: [TrainingResultV2] -> ShowS
show :: TrainingResultV2 -> String
$cshow :: TrainingResultV2 -> String
showsPrec :: Int -> TrainingResultV2 -> ShowS
$cshowsPrec :: Int -> TrainingResultV2 -> ShowS
Prelude.Show, forall x. Rep TrainingResultV2 x -> TrainingResultV2
forall x. TrainingResultV2 -> Rep TrainingResultV2 x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep TrainingResultV2 x -> TrainingResultV2
$cfrom :: forall x. TrainingResultV2 -> Rep TrainingResultV2 x
Prelude.Generic)

-- |
-- Create a value of 'TrainingResultV2' 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:
--
-- 'aggregatedVariablesImportanceMetrics', 'trainingResultV2_aggregatedVariablesImportanceMetrics' - The variable importance metrics of the aggregated variables.
--
-- Account Takeover Insights (ATI) model uses event variables from the
-- login data you provide to continuously calculate a set of variables
-- (aggregated variables) based on historical events. For example, your ATI
-- model might calculate the number of times an user has logged in using
-- the same IP address. In this case, event variables used to derive the
-- aggregated variables are @IP address@ and @user@.
--
-- 'dataValidationMetrics', 'trainingResultV2_dataValidationMetrics' - Undocumented member.
--
-- 'trainingMetricsV2', 'trainingResultV2_trainingMetricsV2' - The training metric details.
--
-- 'variableImportanceMetrics', 'trainingResultV2_variableImportanceMetrics' - Undocumented member.
newTrainingResultV2 ::
  TrainingResultV2
newTrainingResultV2 :: TrainingResultV2
newTrainingResultV2 =
  TrainingResultV2'
    { $sel:aggregatedVariablesImportanceMetrics:TrainingResultV2' :: Maybe AggregatedVariablesImportanceMetrics
aggregatedVariablesImportanceMetrics =
        forall a. Maybe a
Prelude.Nothing,
      $sel:dataValidationMetrics:TrainingResultV2' :: Maybe DataValidationMetrics
dataValidationMetrics = forall a. Maybe a
Prelude.Nothing,
      $sel:trainingMetricsV2:TrainingResultV2' :: Maybe TrainingMetricsV2
trainingMetricsV2 = forall a. Maybe a
Prelude.Nothing,
      $sel:variableImportanceMetrics:TrainingResultV2' :: Maybe VariableImportanceMetrics
variableImportanceMetrics = forall a. Maybe a
Prelude.Nothing
    }

-- | The variable importance metrics of the aggregated variables.
--
-- Account Takeover Insights (ATI) model uses event variables from the
-- login data you provide to continuously calculate a set of variables
-- (aggregated variables) based on historical events. For example, your ATI
-- model might calculate the number of times an user has logged in using
-- the same IP address. In this case, event variables used to derive the
-- aggregated variables are @IP address@ and @user@.
trainingResultV2_aggregatedVariablesImportanceMetrics :: Lens.Lens' TrainingResultV2 (Prelude.Maybe AggregatedVariablesImportanceMetrics)
trainingResultV2_aggregatedVariablesImportanceMetrics :: Lens' TrainingResultV2 (Maybe AggregatedVariablesImportanceMetrics)
trainingResultV2_aggregatedVariablesImportanceMetrics = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TrainingResultV2' {Maybe AggregatedVariablesImportanceMetrics
aggregatedVariablesImportanceMetrics :: Maybe AggregatedVariablesImportanceMetrics
$sel:aggregatedVariablesImportanceMetrics:TrainingResultV2' :: TrainingResultV2 -> Maybe AggregatedVariablesImportanceMetrics
aggregatedVariablesImportanceMetrics} -> Maybe AggregatedVariablesImportanceMetrics
aggregatedVariablesImportanceMetrics) (\s :: TrainingResultV2
s@TrainingResultV2' {} Maybe AggregatedVariablesImportanceMetrics
a -> TrainingResultV2
s {$sel:aggregatedVariablesImportanceMetrics:TrainingResultV2' :: Maybe AggregatedVariablesImportanceMetrics
aggregatedVariablesImportanceMetrics = Maybe AggregatedVariablesImportanceMetrics
a} :: TrainingResultV2)

-- | Undocumented member.
trainingResultV2_dataValidationMetrics :: Lens.Lens' TrainingResultV2 (Prelude.Maybe DataValidationMetrics)
trainingResultV2_dataValidationMetrics :: Lens' TrainingResultV2 (Maybe DataValidationMetrics)
trainingResultV2_dataValidationMetrics = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TrainingResultV2' {Maybe DataValidationMetrics
dataValidationMetrics :: Maybe DataValidationMetrics
$sel:dataValidationMetrics:TrainingResultV2' :: TrainingResultV2 -> Maybe DataValidationMetrics
dataValidationMetrics} -> Maybe DataValidationMetrics
dataValidationMetrics) (\s :: TrainingResultV2
s@TrainingResultV2' {} Maybe DataValidationMetrics
a -> TrainingResultV2
s {$sel:dataValidationMetrics:TrainingResultV2' :: Maybe DataValidationMetrics
dataValidationMetrics = Maybe DataValidationMetrics
a} :: TrainingResultV2)

-- | The training metric details.
trainingResultV2_trainingMetricsV2 :: Lens.Lens' TrainingResultV2 (Prelude.Maybe TrainingMetricsV2)
trainingResultV2_trainingMetricsV2 :: Lens' TrainingResultV2 (Maybe TrainingMetricsV2)
trainingResultV2_trainingMetricsV2 = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TrainingResultV2' {Maybe TrainingMetricsV2
trainingMetricsV2 :: Maybe TrainingMetricsV2
$sel:trainingMetricsV2:TrainingResultV2' :: TrainingResultV2 -> Maybe TrainingMetricsV2
trainingMetricsV2} -> Maybe TrainingMetricsV2
trainingMetricsV2) (\s :: TrainingResultV2
s@TrainingResultV2' {} Maybe TrainingMetricsV2
a -> TrainingResultV2
s {$sel:trainingMetricsV2:TrainingResultV2' :: Maybe TrainingMetricsV2
trainingMetricsV2 = Maybe TrainingMetricsV2
a} :: TrainingResultV2)

-- | Undocumented member.
trainingResultV2_variableImportanceMetrics :: Lens.Lens' TrainingResultV2 (Prelude.Maybe VariableImportanceMetrics)
trainingResultV2_variableImportanceMetrics :: Lens' TrainingResultV2 (Maybe VariableImportanceMetrics)
trainingResultV2_variableImportanceMetrics = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TrainingResultV2' {Maybe VariableImportanceMetrics
variableImportanceMetrics :: Maybe VariableImportanceMetrics
$sel:variableImportanceMetrics:TrainingResultV2' :: TrainingResultV2 -> Maybe VariableImportanceMetrics
variableImportanceMetrics} -> Maybe VariableImportanceMetrics
variableImportanceMetrics) (\s :: TrainingResultV2
s@TrainingResultV2' {} Maybe VariableImportanceMetrics
a -> TrainingResultV2
s {$sel:variableImportanceMetrics:TrainingResultV2' :: Maybe VariableImportanceMetrics
variableImportanceMetrics = Maybe VariableImportanceMetrics
a} :: TrainingResultV2)

instance Data.FromJSON TrainingResultV2 where
  parseJSON :: Value -> Parser TrainingResultV2
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"TrainingResultV2"
      ( \Object
x ->
          Maybe AggregatedVariablesImportanceMetrics
-> Maybe DataValidationMetrics
-> Maybe TrainingMetricsV2
-> Maybe VariableImportanceMetrics
-> TrainingResultV2
TrainingResultV2'
            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
"aggregatedVariablesImportanceMetrics")
            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
"dataValidationMetrics")
            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
"trainingMetricsV2")
            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
"variableImportanceMetrics")
      )

instance Prelude.Hashable TrainingResultV2 where
  hashWithSalt :: Int -> TrainingResultV2 -> Int
hashWithSalt Int
_salt TrainingResultV2' {Maybe AggregatedVariablesImportanceMetrics
Maybe DataValidationMetrics
Maybe TrainingMetricsV2
Maybe VariableImportanceMetrics
variableImportanceMetrics :: Maybe VariableImportanceMetrics
trainingMetricsV2 :: Maybe TrainingMetricsV2
dataValidationMetrics :: Maybe DataValidationMetrics
aggregatedVariablesImportanceMetrics :: Maybe AggregatedVariablesImportanceMetrics
$sel:variableImportanceMetrics:TrainingResultV2' :: TrainingResultV2 -> Maybe VariableImportanceMetrics
$sel:trainingMetricsV2:TrainingResultV2' :: TrainingResultV2 -> Maybe TrainingMetricsV2
$sel:dataValidationMetrics:TrainingResultV2' :: TrainingResultV2 -> Maybe DataValidationMetrics
$sel:aggregatedVariablesImportanceMetrics:TrainingResultV2' :: TrainingResultV2 -> Maybe AggregatedVariablesImportanceMetrics
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe AggregatedVariablesImportanceMetrics
aggregatedVariablesImportanceMetrics
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe DataValidationMetrics
dataValidationMetrics
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe TrainingMetricsV2
trainingMetricsV2
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe VariableImportanceMetrics
variableImportanceMetrics

instance Prelude.NFData TrainingResultV2 where
  rnf :: TrainingResultV2 -> ()
rnf TrainingResultV2' {Maybe AggregatedVariablesImportanceMetrics
Maybe DataValidationMetrics
Maybe TrainingMetricsV2
Maybe VariableImportanceMetrics
variableImportanceMetrics :: Maybe VariableImportanceMetrics
trainingMetricsV2 :: Maybe TrainingMetricsV2
dataValidationMetrics :: Maybe DataValidationMetrics
aggregatedVariablesImportanceMetrics :: Maybe AggregatedVariablesImportanceMetrics
$sel:variableImportanceMetrics:TrainingResultV2' :: TrainingResultV2 -> Maybe VariableImportanceMetrics
$sel:trainingMetricsV2:TrainingResultV2' :: TrainingResultV2 -> Maybe TrainingMetricsV2
$sel:dataValidationMetrics:TrainingResultV2' :: TrainingResultV2 -> Maybe DataValidationMetrics
$sel:aggregatedVariablesImportanceMetrics:TrainingResultV2' :: TrainingResultV2 -> Maybe AggregatedVariablesImportanceMetrics
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe AggregatedVariablesImportanceMetrics
aggregatedVariablesImportanceMetrics
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe DataValidationMetrics
dataValidationMetrics
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe TrainingMetricsV2
trainingMetricsV2
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe VariableImportanceMetrics
variableImportanceMetrics