Docs /Templates/ sinapsis-sktime

NaiveForecasterSKTimeWrapper

sinapsis-sktimeSKTimedynamicinferencemodelsprediction

Python template · sinapsis_sktime.templates.sktime_forecasters

Overview

This template specifically handles sktime series forecasting tasks.

The goal is to train a model and predict future values of the input time series.

Attributes: WrapperEntry (WrapperEntryConfig): Configuration for dynamic template generation TASK_TYPE (str): The type of task (forecasting) CATEGORY (str): The category of the template AttributesBaseModel: Reference to the attributes' model class

NaiveForecaster — inherited documentation

Forecast based on naive assumptions about past trends continuing.

NaiveForecaster is a forecaster that makes forecasts using simple strategies. Two out of three strategies are robust against NaNs. The NaiveForecaster can also be used for multivariate data and it then applies internally the ColumnEnsembleForecaster, so each column is forecasted with the same strategy.

Internally, this forecaster does the following:

- obtains the so-called "last window", a 1D array that denotes the most recent time window that the forecaster is allowed to use - reshapes the last window into a 2D array according to the given seasonal periodicity (prepended with NaN values to make it fit); - make a prediction for each column, using the given strategy:

- "last": last non-NaN row - "mean": np.nanmean over rows

- tile the predictions using the seasonal periodicity

To compute prediction quantiles, we first estimate the standard error of prediction residuals under the assumption of uncorrelated residuals. The forecast variance is then computed by multiplying the residual variance by a constant. This constant is a small-sample bias adjustment and each method (mean, last, drift) have different formulas for computing the constant. These formulas can be found in the Forecasting: Principles and Practice textbook (Table 5.2) [1]_. Lastly, under the assumption that residuals follow a normal distribution, we use the forecast variance and z-scores of a normal distribution to estimate the prediction quantiles.

Parameters ---------- strategy : {"last", "mean", "drift"}, default="last" Strategy used to make forecasts:

* "last": (robust against NaN values) forecast the last value in the training series when sp is 1. When sp is not 1, last value of each season in the last window will be forecasted for each season. * "mean": (robust against NaN values) forecast the mean of last window of training series when sp is 1. When sp is not 1, mean of all values in a season from last window will be forecasted for each season. * "drift": (not robust against NaN values) forecast by fitting a line between the first and last point of the window and extrapolating it into the future.

sp : int, or None, default=1 Seasonal periodicity to use in the seasonal forecasting. None=1.

window_length : int or None, default=None Window length to use in the ``mean`` strategy. If None, entire training series will be used.

References ---------- .. [1] Hyndman, R.J., & Athanasopoulos, G. (2021) Forecasting: principles and practice, 3rd edition, OTexts: Melbourne, Australia. OTexts.com/fpp3. Accessed on 22 September 2022.

Examples -------- >>> from sktime.datasets import load_airline >>> from sktime.forecasting.naive import NaiveForecaster >>> y = load_airline() >>> forecaster = NaiveForecaster(strategy="drift") >>> forecaster.fit(y) NaiveForecaster(...) >>> y_pred = forecaster.predict(fh=[1,2,3]) >>> >>> # Example 2: Seasonal Naive strategy >>> # The airline data is monthly, so we use sp=12 (12 months per year) >>> forecaster = NaiveForecaster(strategy="last", sp=12) >>> forecaster.fit(y) NaiveForecaster(sp=12) >>> y_pred = forecaster.predict(fh=[1, 2, 3])

Capabilities

Capabilities: not set

Installation

Install the published package using pip or uv.

Terminalbash
pip install sinapsis-sktime==1.0.0
uv pip install sinapsis-sktime==1.0.0
uv add sinapsis-sktime==1.0.0

Configuration

Effective fields from the inspector schema, including nested Pydantic model fields.

metadata
sinapsis_core.template_base.base_models.TemplateMetadata | None
Optional
Default: null
root_dir
str
Optional
Default: "/sinapsis-hub/private/platform/sinapsis-hub/playground/publish"
n_steps_ahead

Number of steps ahead to forecast. Defaults to 37. naiveforecaster_init strategy typing.Union[str, typing.Any, NoneType]: default: last window_length typing.Optional[int]: default: None sp <class 'int'>: default: 1

int
Optional
Default: 37
model_save_pathRequired
str
Required
Default: null
naiveforecaster_initRequired
NaiveForecasterAttributes
Required
Default: null
sp
int
Optional
Default: 1
strategy
typing.Union[str, typing.Any, NoneType]
Optional
Default: "last"
window_length
typing.Optional[int]
Optional
Default: null

Configuration example

Generated from documented defaults. Replace any placeholders and complete required nested settings before running.

yaml
templates:
  - template_name: "NaiveForecasterSKTimeWrapper"
    class_name: "NaiveForecasterSKTimeWrapper"
    attributes:
      root_dir: "/sinapsis-hub/private/platform/sinapsis-hub/playground/publish"
      n_steps_ahead: 37
      model_save_path: "<required>"
      naiveforecaster_init:
        sp: 1
        strategy: "last"
        window_length: null

Inheritance

Immediate parent: sinapsis_sktime.templates.sktime_forecasters.SKTimeNaiveForecaster

Environment variables

Environment definitions belong to their canonical Python modules.

SINAPSIS_BUILD_DOCS · defined elsewhere