{-# 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.LookoutVision.Types.ModelPerformance
-- Copyright   : (c) 2013-2021 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay <brendan.g.hay+amazonka@gmail.com>
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.LookoutVision.Types.ModelPerformance where

import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude

-- | Information about the evaluation performance of a trained model.
--
-- /See:/ 'newModelPerformance' smart constructor.
data ModelPerformance = ModelPerformance'
  { -- | The overall recall metric value for the trained model.
    ModelPerformance -> Maybe Double
recall :: Prelude.Maybe Prelude.Double,
    -- | The overall precision metric value for the trained model.
    ModelPerformance -> Maybe Double
precision :: Prelude.Maybe Prelude.Double,
    -- | The overall F1 score metric for the trained model.
    ModelPerformance -> Maybe Double
f1Score :: Prelude.Maybe Prelude.Double
  }
  deriving (ModelPerformance -> ModelPerformance -> Bool
(ModelPerformance -> ModelPerformance -> Bool)
-> (ModelPerformance -> ModelPerformance -> Bool)
-> Eq ModelPerformance
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ModelPerformance -> ModelPerformance -> Bool
$c/= :: ModelPerformance -> ModelPerformance -> Bool
== :: ModelPerformance -> ModelPerformance -> Bool
$c== :: ModelPerformance -> ModelPerformance -> Bool
Prelude.Eq, ReadPrec [ModelPerformance]
ReadPrec ModelPerformance
Int -> ReadS ModelPerformance
ReadS [ModelPerformance]
(Int -> ReadS ModelPerformance)
-> ReadS [ModelPerformance]
-> ReadPrec ModelPerformance
-> ReadPrec [ModelPerformance]
-> Read ModelPerformance
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ModelPerformance]
$creadListPrec :: ReadPrec [ModelPerformance]
readPrec :: ReadPrec ModelPerformance
$creadPrec :: ReadPrec ModelPerformance
readList :: ReadS [ModelPerformance]
$creadList :: ReadS [ModelPerformance]
readsPrec :: Int -> ReadS ModelPerformance
$creadsPrec :: Int -> ReadS ModelPerformance
Prelude.Read, Int -> ModelPerformance -> ShowS
[ModelPerformance] -> ShowS
ModelPerformance -> String
(Int -> ModelPerformance -> ShowS)
-> (ModelPerformance -> String)
-> ([ModelPerformance] -> ShowS)
-> Show ModelPerformance
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ModelPerformance] -> ShowS
$cshowList :: [ModelPerformance] -> ShowS
show :: ModelPerformance -> String
$cshow :: ModelPerformance -> String
showsPrec :: Int -> ModelPerformance -> ShowS
$cshowsPrec :: Int -> ModelPerformance -> ShowS
Prelude.Show, (forall x. ModelPerformance -> Rep ModelPerformance x)
-> (forall x. Rep ModelPerformance x -> ModelPerformance)
-> Generic ModelPerformance
forall x. Rep ModelPerformance x -> ModelPerformance
forall x. ModelPerformance -> Rep ModelPerformance x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ModelPerformance x -> ModelPerformance
$cfrom :: forall x. ModelPerformance -> Rep ModelPerformance x
Prelude.Generic)

-- |
-- Create a value of 'ModelPerformance' 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:
--
-- 'recall', 'modelPerformance_recall' - The overall recall metric value for the trained model.
--
-- 'precision', 'modelPerformance_precision' - The overall precision metric value for the trained model.
--
-- 'f1Score', 'modelPerformance_f1Score' - The overall F1 score metric for the trained model.
newModelPerformance ::
  ModelPerformance
newModelPerformance :: ModelPerformance
newModelPerformance =
  ModelPerformance' :: Maybe Double -> Maybe Double -> Maybe Double -> ModelPerformance
ModelPerformance'
    { $sel:recall:ModelPerformance' :: Maybe Double
recall = Maybe Double
forall a. Maybe a
Prelude.Nothing,
      $sel:precision:ModelPerformance' :: Maybe Double
precision = Maybe Double
forall a. Maybe a
Prelude.Nothing,
      $sel:f1Score:ModelPerformance' :: Maybe Double
f1Score = Maybe Double
forall a. Maybe a
Prelude.Nothing
    }

-- | The overall recall metric value for the trained model.
modelPerformance_recall :: Lens.Lens' ModelPerformance (Prelude.Maybe Prelude.Double)
modelPerformance_recall :: (Maybe Double -> f (Maybe Double))
-> ModelPerformance -> f ModelPerformance
modelPerformance_recall = (ModelPerformance -> Maybe Double)
-> (ModelPerformance -> Maybe Double -> ModelPerformance)
-> Lens
     ModelPerformance ModelPerformance (Maybe Double) (Maybe Double)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ModelPerformance' {Maybe Double
recall :: Maybe Double
$sel:recall:ModelPerformance' :: ModelPerformance -> Maybe Double
recall} -> Maybe Double
recall) (\s :: ModelPerformance
s@ModelPerformance' {} Maybe Double
a -> ModelPerformance
s {$sel:recall:ModelPerformance' :: Maybe Double
recall = Maybe Double
a} :: ModelPerformance)

-- | The overall precision metric value for the trained model.
modelPerformance_precision :: Lens.Lens' ModelPerformance (Prelude.Maybe Prelude.Double)
modelPerformance_precision :: (Maybe Double -> f (Maybe Double))
-> ModelPerformance -> f ModelPerformance
modelPerformance_precision = (ModelPerformance -> Maybe Double)
-> (ModelPerformance -> Maybe Double -> ModelPerformance)
-> Lens
     ModelPerformance ModelPerformance (Maybe Double) (Maybe Double)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ModelPerformance' {Maybe Double
precision :: Maybe Double
$sel:precision:ModelPerformance' :: ModelPerformance -> Maybe Double
precision} -> Maybe Double
precision) (\s :: ModelPerformance
s@ModelPerformance' {} Maybe Double
a -> ModelPerformance
s {$sel:precision:ModelPerformance' :: Maybe Double
precision = Maybe Double
a} :: ModelPerformance)

-- | The overall F1 score metric for the trained model.
modelPerformance_f1Score :: Lens.Lens' ModelPerformance (Prelude.Maybe Prelude.Double)
modelPerformance_f1Score :: (Maybe Double -> f (Maybe Double))
-> ModelPerformance -> f ModelPerformance
modelPerformance_f1Score = (ModelPerformance -> Maybe Double)
-> (ModelPerformance -> Maybe Double -> ModelPerformance)
-> Lens
     ModelPerformance ModelPerformance (Maybe Double) (Maybe Double)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ModelPerformance' {Maybe Double
f1Score :: Maybe Double
$sel:f1Score:ModelPerformance' :: ModelPerformance -> Maybe Double
f1Score} -> Maybe Double
f1Score) (\s :: ModelPerformance
s@ModelPerformance' {} Maybe Double
a -> ModelPerformance
s {$sel:f1Score:ModelPerformance' :: Maybe Double
f1Score = Maybe Double
a} :: ModelPerformance)

instance Core.FromJSON ModelPerformance where
  parseJSON :: Value -> Parser ModelPerformance
parseJSON =
    String
-> (Object -> Parser ModelPerformance)
-> Value
-> Parser ModelPerformance
forall a. String -> (Object -> Parser a) -> Value -> Parser a
Core.withObject
      String
"ModelPerformance"
      ( \Object
x ->
          Maybe Double -> Maybe Double -> Maybe Double -> ModelPerformance
ModelPerformance'
            (Maybe Double -> Maybe Double -> Maybe Double -> ModelPerformance)
-> Parser (Maybe Double)
-> Parser (Maybe Double -> Maybe Double -> ModelPerformance)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x Object -> Text -> Parser (Maybe Double)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"Recall")
            Parser (Maybe Double -> Maybe Double -> ModelPerformance)
-> Parser (Maybe Double)
-> Parser (Maybe Double -> ModelPerformance)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser (Maybe Double)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"Precision")
            Parser (Maybe Double -> ModelPerformance)
-> Parser (Maybe Double) -> Parser ModelPerformance
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser (Maybe Double)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"F1Score")
      )

instance Prelude.Hashable ModelPerformance

instance Prelude.NFData ModelPerformance