Docs /Templates/ sinapsis-sktime

ExponentialSmoothingSKTimeWrapper

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

ExponentialSmoothing — inherited documentation

Holt-Winters exponential smoothing forecaster.

Direct interface for ``statsmodels.tsa.holtwinters``.

Default settings use simple exponential smoothing without trend and seasonality components.

Parameters ---------- trend : {"add", "mul", "additive", "multiplicative", None}, default=None Type of trend component. damped_trend : bool, default=False Should the trend component be damped. seasonal : {"add", "mul", "additive", "multiplicative", None}, default=None Type of seasonal component.Takes one of sp : int or None, default=None The number of seasonal periods to consider. initial_level : float or None, default=None The alpha value of the simple exponential smoothing, if the value is set then this value will be used as the value. initial_trend : float or None, default=None The beta value of the Holt's trend method, if the value is set then this value will be used as the value. initial_seasonal : float or None, default=None The gamma value of the holt winters seasonal method, if the value is set then this value will be used as the value. use_boxcox : {True, False, 'log', float}, default=None Should the Box-Cox transform be applied to the data first? If 'log' then apply the log. If float then use lambda equal to float. initialization_method:{'estimated','heuristic','legacy-heuristic','known',None}, default='estimated' Method for initialize the recursions. If 'known' initialization is used, then ``initial_level`` must be passed, as well as ``initial_trend`` and ``initial_seasonal`` if applicable. 'heuristic' uses a heuristic based on the data to estimate initial level, trend, and seasonal state. 'estimated' uses the same heuristic as initial guesses, but then estimates the initial states as part of the fitting process. smoothing_level : float, optional The alpha value of the simple exponential smoothing, if the value is set then this value will be used as the value. smoothing_trend : float, optional The beta value of the Holt's trend method, if the value is set then this value will be used as the value. smoothing_seasonal : float, optional The gamma value of the holt winters seasonal method, if the value is set then this value will be used as the value. damping_trend : float, optional The phi value of the damped method, if the value is set then this value will be used as the value. optimized : bool, optional Estimate model parameters by maximizing the log-likelihood. remove_bias : bool, optional Remove bias from forecast values and fitted values by enforcing that the average residual is equal to zero. start_params : array_like, optional Starting values to used when optimizing the fit. If not provided, starting values are determined using a combination of grid search and reasonable values based on the initial values of the data. See the notes for the structure of the model parameters. method : str, default "SLSQP" The minimizer used. Valid options are "L-BFGS-B" , "TNC", "SLSQP" (default), "Powell", "trust-constr", "basinhopping" (also "bh") and "least_squares" (also "ls"). basinhopping tries multiple starting values in an attempt to find a global minimizer in non-convex problems, and so is slower than the others. minimize_kwargs : dict[str, Any] A dictionary of keyword arguments passed to SciPy's minimize function if method is one of "L-BFGS-B", "TNC", "SLSQP", "Powell", or "trust-constr", or SciPy's basinhopping or least_squares functions. The valid keywords are optimizer specific. Consult SciPy's documentation for the full set of options. use_brute : bool, optional Search for good starting values using a brute force (grid) optimizer. If False, a naive set of starting values is used. random_state : int, RandomState instance or None, optional , default=None - If int, random_state is the seed used by the random number generator; If RandomState instance, random_state is the random number generator; If None, the random number generator is the RandomState instance used by np.random.

References ---------- [1] Hyndman, Rob J., and George Athanasopoulos. Forecasting: principles and practice. OTexts, 2014.

Examples -------- >>> from sktime.datasets import load_airline >>> from sktime.forecasting.exp_smoothing import ExponentialSmoothing >>> y = load_airline() >>> forecaster = ExponentialSmoothing( ... trend='add', seasonal='multiplicative', sp=12 ... ) # doctest: +SKIP >>> forecaster.fit(y) # doctest: +SKIP ExponentialSmoothing(...) >>> y_pred = forecaster.predict(fh=[1,2,3]) # doctest: +SKIP

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. exponentialsmoothing_init trend typing.Union[str, typing.Any, NoneType]: default: None damped_trend <class 'bool'>: default: False seasonal typing.Union[str,… Read full field description

Number of steps ahead to forecast. Defaults to 37. exponentialsmoothing_init trend typing.Union[str, typing.Any, NoneType]: default: None damped_trend <class 'bool'>: default: False seasonal typing.Union[str, typing.Any, NoneType]: default: None sp typing.Optional[int]: default: None initial_level typing.Optional[float]: default: None initial_trend typing.Optional[float]: default: None initial_seasonal typing.Optional[float]: default: None use_boxcox typing.Union[str, typing.Any, NoneType]: default: None initialization_method typing.Union[str, typing.Any, NoneType]: default: estimated smoothing_level typing.Optional[float]: default: None smoothing_trend typing.Optional[float]: default: None smoothing_seasonal typing.Optional[float]: default: None damping_trend typing.Optional[float]: default: None optimized <class 'bool'>: default: True remove_bias <class 'bool'>: default: False start_params <class 'NoneType'>: default: None method typing.Optional[str]: default: None minimize_kwargs <class 'NoneType'>: default: None use_brute <class 'bool'>: default: True random_state typing.Optional[int]: default: None

int
Optional
Default: 37
model_save_pathRequired
str
Required
Default: null
exponentialsmoothing_initRequired
ExponentialSmoothingAttributes
Required
Default: null
sp
typing.Optional[int]
Optional
Default: null
trend
typing.Union[str, typing.Any, NoneType]
Optional
Default: null
method
typing.Optional[str]
Optional
Default: null
seasonal
typing.Union[str, typing.Any, NoneType]
Optional
Default: null
optimized
bool
Optional
Default: true
use_brute
bool
Optional
Default: true
use_boxcox
typing.Union[str, typing.Any, NoneType]
Optional
Default: null
remove_bias
bool
Optional
Default: false
damped_trend
bool
Optional
Default: false
random_state
typing.Optional[int]
Optional
Default: null
start_params
NoneType
Optional
Default: null
damping_trend
typing.Optional[float]
Optional
Default: null
initial_level
typing.Optional[float]
Optional
Default: null
initial_trend
typing.Optional[float]
Optional
Default: null
minimize_kwargs
NoneType
Optional
Default: null
smoothing_level
typing.Optional[float]
Optional
Default: null
smoothing_trend
typing.Optional[float]
Optional
Default: null
initial_seasonal
typing.Optional[float]
Optional
Default: null
smoothing_seasonal
typing.Optional[float]
Optional
Default: null
initialization_method
typing.Union[str, typing.Any, NoneType]
Optional
Default: "estimated"

Configuration example

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

yaml
templates:
  - template_name: "ExponentialSmoothingSKTimeWrapper"
    class_name: "ExponentialSmoothingSKTimeWrapper"
    attributes:
      root_dir: "/sinapsis-hub/private/platform/sinapsis-hub/playground/publish"
      n_steps_ahead: 37
      model_save_path: "<required>"
      exponentialsmoothing_init:
        sp: null
        trend: null
        method: null
        seasonal: null
        optimized: true
        use_brute: true
        use_boxcox: null
        remove_bias: false
        damped_trend: false
        random_state: null
        start_params: null
        damping_trend: null
        initial_level: null
        initial_trend: null
        minimize_kwargs: null
        smoothing_level: null
        smoothing_trend: null
        initial_seasonal: null
        smoothing_seasonal: null
        initialization_method: "estimated"

Inheritance

Immediate parent: sinapsis_sktime.templates.sktime_forecasters.SKTimeExpSmoothingForecaster

Environment variables

Environment definitions belong to their canonical Python modules.

SINAPSIS_BUILD_DOCS · defined elsewhere