Skip to content

EvaluationParameters

Source code in docs_src/capo_forecast/types/evaluation_parameters.py
class EvaluationParameters(TypedDict, closed=True):
    number_of_backtest_windows: NotRequired["capo_forecast.types.integer.Integer"]
    """<p>The number of times to split the input data. The default is 1. Valid values are 1 through 5.</p>"""
    back_test_window_offset: NotRequired["capo_forecast.types.integer.Integer"]
    """<p>The point from the end of the dataset where you want to split the data for model training and testing (evaluation). Specify the value as the number of data points. The default is the value of the forecast horizon. <code>BackTestWindowOffset</code> can be used to mimic a past virtual forecast start date. This value must be greater than or equal to the forecast horizon and less than half of the TARGET_TIME_SERIES dataset length.</p> <p> <code>ForecastHorizon</code> <= <code>BackTestWindowOffset</code> < 1/2 * TARGET_TIME_SERIES dataset length</p>"""

back_test_window_offset instance-attribute

back_test_window_offset: NotRequired[Integer]

The point from the end of the dataset where you want to split the data for model training and testing (evaluation). Specify the value as the number of data points. The default is the value of the forecast horizon. BackTestWindowOffset can be used to mimic a past virtual forecast start date. This value must be greater than or equal to the forecast horizon and less than half of the TARGET_TIME_SERIES dataset length.

ForecastHorizon <= BackTestWindowOffset < 1/2 * TARGET_TIME_SERIES dataset length

number_of_backtest_windows instance-attribute

number_of_backtest_windows: NotRequired[Integer]

The number of times to split the input data. The default is 1. Valid values are 1 through 5.