Skip to content

Commit

Permalink
[DOC] forecasting extension template - add insample capability tags (#…
Browse files Browse the repository at this point in the history
…5272)

This adds the insample capability tags in the long forecasting extension
template.
  • Loading branch information
fkiraly committed Sep 24, 2023
1 parent 1bcb150 commit 93e7cf5
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions extension_templates/forecasting.py
Expand Up @@ -136,11 +136,21 @@ class MyForecaster(BaseForecaster):
# valid values: boolean True (yes), False (no)
# if False, raises exception if y or X passed contain missing data (nans)
#
# capability:insample = can forecaster make in-sample forecasts?
"capability:insample": True,
# valid values: boolean True (yes), False (no)
# if False, exception raised if any forecast method called with in-sample fh
#
# capability:pred_int = does forecaster implement probabilistic forecasts?
"capability:pred_int": False,
# valid values: boolean True (yes), False (no)
# if False, exception raised if proba methods are called (predict_interval etc)
#
# capability:pred_int:insample = can forecaster make in-sample proba forecasts?
"capability:pred_int:insample": True,
# valid values: boolean True (yes), False (no)
# only needs to be set if capability:pred_int is True
# if False, exception raised if proba methods are called with in-sample fh
#
# dependency tags: python version and soft dependencies
# -----------------------------------------------------
Expand Down

0 comments on commit 93e7cf5

Please sign in to comment.