{-# 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.PredictorBaseline
-- 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.PredictorBaseline 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.BaselineMetric
import qualified Amazonka.Prelude as Prelude

-- | Metrics you can use as a baseline for comparison purposes. Use these
-- metrics when you interpret monitoring results for an auto predictor.
--
-- /See:/ 'newPredictorBaseline' smart constructor.
data PredictorBaseline = PredictorBaseline'
  { -- | The initial
    -- <https://docs.aws.amazon.com/forecast/latest/dg/metrics.html accuracy metrics>
    -- for the predictor. Use these metrics as a baseline for comparison
    -- purposes as you use your predictor and the metrics change.
    PredictorBaseline -> Maybe [BaselineMetric]
baselineMetrics :: Prelude.Maybe [BaselineMetric]
  }
  deriving (PredictorBaseline -> PredictorBaseline -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: PredictorBaseline -> PredictorBaseline -> Bool
$c/= :: PredictorBaseline -> PredictorBaseline -> Bool
== :: PredictorBaseline -> PredictorBaseline -> Bool
$c== :: PredictorBaseline -> PredictorBaseline -> Bool
Prelude.Eq, ReadPrec [PredictorBaseline]
ReadPrec PredictorBaseline
Int -> ReadS PredictorBaseline
ReadS [PredictorBaseline]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [PredictorBaseline]
$creadListPrec :: ReadPrec [PredictorBaseline]
readPrec :: ReadPrec PredictorBaseline
$creadPrec :: ReadPrec PredictorBaseline
readList :: ReadS [PredictorBaseline]
$creadList :: ReadS [PredictorBaseline]
readsPrec :: Int -> ReadS PredictorBaseline
$creadsPrec :: Int -> ReadS PredictorBaseline
Prelude.Read, Int -> PredictorBaseline -> ShowS
[PredictorBaseline] -> ShowS
PredictorBaseline -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [PredictorBaseline] -> ShowS
$cshowList :: [PredictorBaseline] -> ShowS
show :: PredictorBaseline -> String
$cshow :: PredictorBaseline -> String
showsPrec :: Int -> PredictorBaseline -> ShowS
$cshowsPrec :: Int -> PredictorBaseline -> ShowS
Prelude.Show, forall x. Rep PredictorBaseline x -> PredictorBaseline
forall x. PredictorBaseline -> Rep PredictorBaseline x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep PredictorBaseline x -> PredictorBaseline
$cfrom :: forall x. PredictorBaseline -> Rep PredictorBaseline x
Prelude.Generic)

-- |
-- Create a value of 'PredictorBaseline' 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:
--
-- 'baselineMetrics', 'predictorBaseline_baselineMetrics' - The initial
-- <https://docs.aws.amazon.com/forecast/latest/dg/metrics.html accuracy metrics>
-- for the predictor. Use these metrics as a baseline for comparison
-- purposes as you use your predictor and the metrics change.
newPredictorBaseline ::
  PredictorBaseline
newPredictorBaseline :: PredictorBaseline
newPredictorBaseline =
  PredictorBaseline'
    { $sel:baselineMetrics:PredictorBaseline' :: Maybe [BaselineMetric]
baselineMetrics =
        forall a. Maybe a
Prelude.Nothing
    }

-- | The initial
-- <https://docs.aws.amazon.com/forecast/latest/dg/metrics.html accuracy metrics>
-- for the predictor. Use these metrics as a baseline for comparison
-- purposes as you use your predictor and the metrics change.
predictorBaseline_baselineMetrics :: Lens.Lens' PredictorBaseline (Prelude.Maybe [BaselineMetric])
predictorBaseline_baselineMetrics :: Lens' PredictorBaseline (Maybe [BaselineMetric])
predictorBaseline_baselineMetrics = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PredictorBaseline' {Maybe [BaselineMetric]
baselineMetrics :: Maybe [BaselineMetric]
$sel:baselineMetrics:PredictorBaseline' :: PredictorBaseline -> Maybe [BaselineMetric]
baselineMetrics} -> Maybe [BaselineMetric]
baselineMetrics) (\s :: PredictorBaseline
s@PredictorBaseline' {} Maybe [BaselineMetric]
a -> PredictorBaseline
s {$sel:baselineMetrics:PredictorBaseline' :: Maybe [BaselineMetric]
baselineMetrics = Maybe [BaselineMetric]
a} :: PredictorBaseline) 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 PredictorBaseline where
  parseJSON :: Value -> Parser PredictorBaseline
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"PredictorBaseline"
      ( \Object
x ->
          Maybe [BaselineMetric] -> PredictorBaseline
PredictorBaseline'
            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
"BaselineMetrics"
                            forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty
                        )
      )

instance Prelude.Hashable PredictorBaseline where
  hashWithSalt :: Int -> PredictorBaseline -> Int
hashWithSalt Int
_salt PredictorBaseline' {Maybe [BaselineMetric]
baselineMetrics :: Maybe [BaselineMetric]
$sel:baselineMetrics:PredictorBaseline' :: PredictorBaseline -> Maybe [BaselineMetric]
..} =
    Int
_salt forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [BaselineMetric]
baselineMetrics

instance Prelude.NFData PredictorBaseline where
  rnf :: PredictorBaseline -> ()
rnf PredictorBaseline' {Maybe [BaselineMetric]
baselineMetrics :: Maybe [BaselineMetric]
$sel:baselineMetrics:PredictorBaseline' :: PredictorBaseline -> Maybe [BaselineMetric]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [BaselineMetric]
baselineMetrics