{-# 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.Forecast.Types.Metrics
-- 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.Forecast.Types.Metrics where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.Forecast.Types.ErrorMetric
import Amazonka.Forecast.Types.WeightedQuantileLoss
import qualified Amazonka.Prelude as Prelude

-- | Provides metrics that are used to evaluate the performance of a
-- predictor. This object is part of the WindowSummary object.
--
-- /See:/ 'newMetrics' smart constructor.
data Metrics = Metrics'
  { -- | The average value of all weighted quantile losses.
    Metrics -> Maybe Double
averageWeightedQuantileLoss :: Prelude.Maybe Prelude.Double,
    -- | Provides detailed error metrics for each forecast type. Metrics include
    -- root-mean square-error (RMSE), mean absolute percentage error (MAPE),
    -- mean absolute scaled error (MASE), and weighted average percentage error
    -- (WAPE).
    Metrics -> Maybe [ErrorMetric]
errorMetrics :: Prelude.Maybe [ErrorMetric],
    -- | The root-mean-square error (RMSE).
    Metrics -> Maybe Double
rmse :: Prelude.Maybe Prelude.Double,
    -- | An array of weighted quantile losses. Quantiles divide a probability
    -- distribution into regions of equal probability. The distribution in this
    -- case is the loss function.
    Metrics -> Maybe [WeightedQuantileLoss]
weightedQuantileLosses :: Prelude.Maybe [WeightedQuantileLoss]
  }
  deriving (Metrics -> Metrics -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: Metrics -> Metrics -> Bool
$c/= :: Metrics -> Metrics -> Bool
== :: Metrics -> Metrics -> Bool
$c== :: Metrics -> Metrics -> Bool
Prelude.Eq, ReadPrec [Metrics]
ReadPrec Metrics
Int -> ReadS Metrics
ReadS [Metrics]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [Metrics]
$creadListPrec :: ReadPrec [Metrics]
readPrec :: ReadPrec Metrics
$creadPrec :: ReadPrec Metrics
readList :: ReadS [Metrics]
$creadList :: ReadS [Metrics]
readsPrec :: Int -> ReadS Metrics
$creadsPrec :: Int -> ReadS Metrics
Prelude.Read, Int -> Metrics -> ShowS
[Metrics] -> ShowS
Metrics -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [Metrics] -> ShowS
$cshowList :: [Metrics] -> ShowS
show :: Metrics -> String
$cshow :: Metrics -> String
showsPrec :: Int -> Metrics -> ShowS
$cshowsPrec :: Int -> Metrics -> ShowS
Prelude.Show, forall x. Rep Metrics x -> Metrics
forall x. Metrics -> Rep Metrics x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep Metrics x -> Metrics
$cfrom :: forall x. Metrics -> Rep Metrics x
Prelude.Generic)

-- |
-- Create a value of 'Metrics' 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:
--
-- 'averageWeightedQuantileLoss', 'metrics_averageWeightedQuantileLoss' - The average value of all weighted quantile losses.
--
-- 'errorMetrics', 'metrics_errorMetrics' - Provides detailed error metrics for each forecast type. Metrics include
-- root-mean square-error (RMSE), mean absolute percentage error (MAPE),
-- mean absolute scaled error (MASE), and weighted average percentage error
-- (WAPE).
--
-- 'rmse', 'metrics_rmse' - The root-mean-square error (RMSE).
--
-- 'weightedQuantileLosses', 'metrics_weightedQuantileLosses' - An array of weighted quantile losses. Quantiles divide a probability
-- distribution into regions of equal probability. The distribution in this
-- case is the loss function.
newMetrics ::
  Metrics
newMetrics :: Metrics
newMetrics =
  Metrics'
    { $sel:averageWeightedQuantileLoss:Metrics' :: Maybe Double
averageWeightedQuantileLoss =
        forall a. Maybe a
Prelude.Nothing,
      $sel:errorMetrics:Metrics' :: Maybe [ErrorMetric]
errorMetrics = forall a. Maybe a
Prelude.Nothing,
      $sel:rmse:Metrics' :: Maybe Double
rmse = forall a. Maybe a
Prelude.Nothing,
      $sel:weightedQuantileLosses:Metrics' :: Maybe [WeightedQuantileLoss]
weightedQuantileLosses = forall a. Maybe a
Prelude.Nothing
    }

-- | The average value of all weighted quantile losses.
metrics_averageWeightedQuantileLoss :: Lens.Lens' Metrics (Prelude.Maybe Prelude.Double)
metrics_averageWeightedQuantileLoss :: Lens' Metrics (Maybe Double)
metrics_averageWeightedQuantileLoss = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Metrics' {Maybe Double
averageWeightedQuantileLoss :: Maybe Double
$sel:averageWeightedQuantileLoss:Metrics' :: Metrics -> Maybe Double
averageWeightedQuantileLoss} -> Maybe Double
averageWeightedQuantileLoss) (\s :: Metrics
s@Metrics' {} Maybe Double
a -> Metrics
s {$sel:averageWeightedQuantileLoss:Metrics' :: Maybe Double
averageWeightedQuantileLoss = Maybe Double
a} :: Metrics)

-- | Provides detailed error metrics for each forecast type. Metrics include
-- root-mean square-error (RMSE), mean absolute percentage error (MAPE),
-- mean absolute scaled error (MASE), and weighted average percentage error
-- (WAPE).
metrics_errorMetrics :: Lens.Lens' Metrics (Prelude.Maybe [ErrorMetric])
metrics_errorMetrics :: Lens' Metrics (Maybe [ErrorMetric])
metrics_errorMetrics = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Metrics' {Maybe [ErrorMetric]
errorMetrics :: Maybe [ErrorMetric]
$sel:errorMetrics:Metrics' :: Metrics -> Maybe [ErrorMetric]
errorMetrics} -> Maybe [ErrorMetric]
errorMetrics) (\s :: Metrics
s@Metrics' {} Maybe [ErrorMetric]
a -> Metrics
s {$sel:errorMetrics:Metrics' :: Maybe [ErrorMetric]
errorMetrics = Maybe [ErrorMetric]
a} :: Metrics) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The root-mean-square error (RMSE).
metrics_rmse :: Lens.Lens' Metrics (Prelude.Maybe Prelude.Double)
metrics_rmse :: Lens' Metrics (Maybe Double)
metrics_rmse = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Metrics' {Maybe Double
rmse :: Maybe Double
$sel:rmse:Metrics' :: Metrics -> Maybe Double
rmse} -> Maybe Double
rmse) (\s :: Metrics
s@Metrics' {} Maybe Double
a -> Metrics
s {$sel:rmse:Metrics' :: Maybe Double
rmse = Maybe Double
a} :: Metrics)

-- | An array of weighted quantile losses. Quantiles divide a probability
-- distribution into regions of equal probability. The distribution in this
-- case is the loss function.
metrics_weightedQuantileLosses :: Lens.Lens' Metrics (Prelude.Maybe [WeightedQuantileLoss])
metrics_weightedQuantileLosses :: Lens' Metrics (Maybe [WeightedQuantileLoss])
metrics_weightedQuantileLosses = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Metrics' {Maybe [WeightedQuantileLoss]
weightedQuantileLosses :: Maybe [WeightedQuantileLoss]
$sel:weightedQuantileLosses:Metrics' :: Metrics -> Maybe [WeightedQuantileLoss]
weightedQuantileLosses} -> Maybe [WeightedQuantileLoss]
weightedQuantileLosses) (\s :: Metrics
s@Metrics' {} Maybe [WeightedQuantileLoss]
a -> Metrics
s {$sel:weightedQuantileLosses:Metrics' :: Maybe [WeightedQuantileLoss]
weightedQuantileLosses = Maybe [WeightedQuantileLoss]
a} :: Metrics) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance Data.FromJSON Metrics where
  parseJSON :: Value -> Parser Metrics
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"Metrics"
      ( \Object
x ->
          Maybe Double
-> Maybe [ErrorMetric]
-> Maybe Double
-> Maybe [WeightedQuantileLoss]
-> Metrics
Metrics'
            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
"AverageWeightedQuantileLoss")
            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
"ErrorMetrics" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
            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
"RMSE")
            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
"WeightedQuantileLosses"
                            forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty
                        )
      )

instance Prelude.Hashable Metrics where
  hashWithSalt :: Int -> Metrics -> Int
hashWithSalt Int
_salt Metrics' {Maybe Double
Maybe [ErrorMetric]
Maybe [WeightedQuantileLoss]
weightedQuantileLosses :: Maybe [WeightedQuantileLoss]
rmse :: Maybe Double
errorMetrics :: Maybe [ErrorMetric]
averageWeightedQuantileLoss :: Maybe Double
$sel:weightedQuantileLosses:Metrics' :: Metrics -> Maybe [WeightedQuantileLoss]
$sel:rmse:Metrics' :: Metrics -> Maybe Double
$sel:errorMetrics:Metrics' :: Metrics -> Maybe [ErrorMetric]
$sel:averageWeightedQuantileLoss:Metrics' :: Metrics -> Maybe Double
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Double
averageWeightedQuantileLoss
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [ErrorMetric]
errorMetrics
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Double
rmse
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [WeightedQuantileLoss]
weightedQuantileLosses

instance Prelude.NFData Metrics where
  rnf :: Metrics -> ()
rnf Metrics' {Maybe Double
Maybe [ErrorMetric]
Maybe [WeightedQuantileLoss]
weightedQuantileLosses :: Maybe [WeightedQuantileLoss]
rmse :: Maybe Double
errorMetrics :: Maybe [ErrorMetric]
averageWeightedQuantileLoss :: Maybe Double
$sel:weightedQuantileLosses:Metrics' :: Metrics -> Maybe [WeightedQuantileLoss]
$sel:rmse:Metrics' :: Metrics -> Maybe Double
$sel:errorMetrics:Metrics' :: Metrics -> Maybe [ErrorMetric]
$sel:averageWeightedQuantileLoss:Metrics' :: Metrics -> Maybe Double
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Double
averageWeightedQuantileLoss
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [ErrorMetric]
errorMetrics
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Double
rmse
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [WeightedQuantileLoss]
weightedQuantileLosses