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)
Safe Haskell	None

Amazonka.Forecast.Types.WindowSummary

Description

Documentation

data WindowSummary Source #

The metrics for a time range within the evaluation portion of a dataset. This object is part of the EvaluationResult object.

The TestWindowStart and TestWindowEnd parameters are determined by the BackTestWindowOffset parameter of the EvaluationParameters object.

See: newWindowSummary smart constructor.

Constructors

WindowSummary'

Fields

metrics :: Maybe Metrics
Provides metrics used to evaluate the performance of a predictor.
testWindowEnd :: Maybe POSIX
The timestamp that defines the end of the window.
evaluationType :: Maybe EvaluationType
The type of evaluation.
- SUMMARY - The average metrics across all windows.
- COMPUTED - The metrics for the specified window.
testWindowStart :: Maybe POSIX
The timestamp that defines the start of the window.
itemCount :: Maybe Int
The number of data points within the window.

Instances

Instances details

Eq WindowSummary Source #
Instance details Defined in Amazonka.Forecast.Types.WindowSummary Methods (==) :: WindowSummary -> WindowSummary -> Bool # (/=) :: WindowSummary -> WindowSummary -> Bool #
Read WindowSummary Source #
Instance details Defined in Amazonka.Forecast.Types.WindowSummary Methods readsPrec :: Int -> ReadS WindowSummary # readList :: ReadS [WindowSummary] # readPrec :: ReadPrec WindowSummary # readListPrec :: ReadPrec [WindowSummary] #
Show WindowSummary Source #
Instance details Defined in Amazonka.Forecast.Types.WindowSummary Methods showsPrec :: Int -> WindowSummary -> ShowS # show :: WindowSummary -> String # showList :: [WindowSummary] -> ShowS #
Generic WindowSummary Source #
Instance details Defined in Amazonka.Forecast.Types.WindowSummary Associated Types type Rep WindowSummary :: Type -> Type # Methods from :: WindowSummary -> Rep WindowSummary x # to :: Rep WindowSummary x -> WindowSummary #
NFData WindowSummary Source #
Instance details Defined in Amazonka.Forecast.Types.WindowSummary Methods rnf :: WindowSummary -> () #
Hashable WindowSummary Source #
Instance details Defined in Amazonka.Forecast.Types.WindowSummary Methods hashWithSalt :: Int -> WindowSummary -> Int # hash :: WindowSummary -> Int #
FromJSON WindowSummary Source #
Instance details Defined in Amazonka.Forecast.Types.WindowSummary Methods parseJSON :: Value -> Parser WindowSummary # parseJSONList :: Value -> Parser [WindowSummary] #
type Rep WindowSummary Source #
Instance details Defined in Amazonka.Forecast.Types.WindowSummary type Rep WindowSummary = D1 ('MetaData "WindowSummary" "Amazonka.Forecast.Types.WindowSummary" "libZSservicesZSamazonka-forecastZSamazonka-forecast" 'False) (C1 ('MetaCons "WindowSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "metrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Metrics)) :: S1 ('MetaSel ('Just "testWindowEnd") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "evaluationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EvaluationType)) :: (S1 ('MetaSel ('Just "testWindowStart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "itemCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))

newWindowSummary :: WindowSummary Source #

Create a value of WindowSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:metrics:WindowSummary', windowSummary_metrics - Provides metrics used to evaluate the performance of a predictor.

$sel:testWindowEnd:WindowSummary', windowSummary_testWindowEnd - The timestamp that defines the end of the window.

$sel:evaluationType:WindowSummary', windowSummary_evaluationType - The type of evaluation.

SUMMARY - The average metrics across all windows.
COMPUTED - The metrics for the specified window.

$sel:testWindowStart:WindowSummary', windowSummary_testWindowStart - The timestamp that defines the start of the window.

$sel:itemCount:WindowSummary', windowSummary_itemCount - The number of data points within the window.

windowSummary_metrics :: Lens' WindowSummary (Maybe Metrics) Source #

Provides metrics used to evaluate the performance of a predictor.

windowSummary_testWindowEnd :: Lens' WindowSummary (Maybe UTCTime) Source #

The timestamp that defines the end of the window.

windowSummary_evaluationType :: Lens' WindowSummary (Maybe EvaluationType) Source #

The type of evaluation.

SUMMARY - The average metrics across all windows.
COMPUTED - The metrics for the specified window.

windowSummary_testWindowStart :: Lens' WindowSummary (Maybe UTCTime) Source #

The timestamp that defines the start of the window.

windowSummary_itemCount :: Lens' WindowSummary (Maybe Int) Source #

The number of data points within the window.