Skip to content

WindowSummary

Source code in docs_src/capo_forecast/types/window_summary.py 
14
15
16
17
18
19
20
21
22
23
24
class WindowSummary(TypedDict, closed=True):
    test_window_start: NotRequired["capo_forecast.types.timestamp.Timestamp"]
    """<p>The timestamp that defines the start of the window.</p>"""
    test_window_end: NotRequired["capo_forecast.types.timestamp.Timestamp"]
    """<p>The timestamp that defines the end of the window.</p>"""
    item_count: NotRequired["capo_forecast.types.integer.Integer"]
    """<p>The number of data points within the window.</p>"""
    evaluation_type: NotRequired["capo_forecast.types.evaluation_type.EvaluationType"]
    """<p>The type of evaluation.</p> <ul> <li> <p> <code>SUMMARY</code> - The average metrics across all windows.</p> </li> <li> <p> <code>COMPUTED</code> - The metrics for the specified window.</p> </li> </ul>"""
    metrics: NotRequired["capo_forecast.types.metrics.Metrics"]
    """<p>Provides metrics used to evaluate the performance of a predictor.</p>"""

evaluation_type instance-attribute 

evaluation_type: NotRequired[EvaluationType]

The type of evaluation.

  • SUMMARY - The average metrics across all windows.

  • COMPUTED - The metrics for the specified window.

item_count instance-attribute 

item_count: NotRequired[Integer]

The number of data points within the window.

metrics instance-attribute 

metrics: NotRequired[Metrics]

Provides metrics used to evaluate the performance of a predictor.

test_window_end instance-attribute 

test_window_end: NotRequired[Timestamp]

The timestamp that defines the end of the window.

test_window_start instance-attribute 

test_window_start: NotRequired[Timestamp]

The timestamp that defines the start of the window.