Docs /Templates/ sinapsis-darts-forecasting

NaiveSeasonalWrapper

sinapsis-darts-forecastingDartsdartsdynamicforecastingmodels

Python template · sinapsis_darts_forecasting.templates.time_series_model

Overview

Base Template for Darts Time Series forecasting models.

NaiveSeasonal — inherited documentation

The base class for "local" forecasting models, handling only single univariate time series.

Local Forecasting Models (LFM) are models that can be trained on a single univariate target series only. In Darts, most models in this category tend to be simpler statistical models (such as ETS or FFT). LFMs usually train on the entire target series supplied when calling :func:`fit()` at once. They can also predict in one go with :func:`predict()` for any number of predictions `n` after the end of the training series.

All implementations must implement the `fit()` and `predict()` methods.Naive Seasonal Model

This model always predicts the value of `K` time steps ago. When `K=1`, this model predicts the last value of the training set. When `K>1`, it repeats the last `K` values of the training set.

Parameters ---------- K the number of last time steps of the training set to repeat

Examples -------- >>> from darts.datasets import AirPassengersDataset >>> from darts.models import NaiveSeasonal >>> series = AirPassengersDataset().load() # prior analysis suggested seasonality of 12 >>> model = NaiveSeasonal(K=12) >>> model.fit(series) >>> pred = model.predict(6) >>> print(pred.values()) [[417.] [391.] [419.] [461.] [472.] [535.]]

Capabilities

Capabilities: not set

Installation

Install the published package using pip or uv.

Terminalbash
pip install sinapsis-darts-forecasting==1.0.0
uv pip install sinapsis-darts-forecasting==1.0.0
uv add sinapsis-darts-forecasting==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
validation_mode
bool
Optional
Default: false
forecast_horizon
int
Optional
Default: 10
naiveseasonal_initRequired
__init__Attributes
Required
Default: null
K
int
Optional
Default: 1

Configuration example

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

yaml
templates:
  - template_name: "NaiveSeasonalWrapper"
    class_name: "NaiveSeasonalWrapper"
    attributes:
      validation_mode: false
      forecast_horizon: 10
      naiveseasonal_init:
        K: 1
View original docstring example

The source example references XGBModelWrapper, not NaiveSeasonalWrapper.

yaml
agent:
    name: my_test_agent
templates:
- template_name: InputTemplate
  class_name: InputTemplate
  attributes: {}
- template_name: XGBModelWrapper
  class_name: XGBModelWrapper
  template_input: InputTemplate
  attributes:
    forecast_horizon: 100
    xgbmodel_init:
        lags: 30
        lags_past_covariates: 30
        output_chunk_length: 100
        random_state: 42
        n_estimators: 200
        learning_rate: 0.1
        max_depth: 6
For a full list of options use the sinapsis cli: sinapsis info --all-template-names.
If you want to see all available models, please visit:
https://unit8co.github.io/darts/generated_api/darts.models.forecasting.html

Inheritance

Immediate parent: sinapsis_darts_forecasting.templates.time_series_model.TimeSeriesModel

Environment variables

Environment definitions belong to their canonical Python modules.

SINAPSIS_BUILD_DOCS · defined elsewhere