Docs /Templates/ sinapsis-sktime

StatsModelsARIMASKTimeWrapper

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

StatsModelsARIMA — inherited documentation

(S)ARIMA(X) forecaster, from statsmodels, tsa.arima module.

Direct interface for ``statsmodels.tsa.arima.model.ARIMA``.

Users should note that statsmodels contains two separate implementations of (S)ARIMA(X), the ARIMA and the SARIMAX class, in different modules: ``tsa.arima.model.ARIMA`` and ``tsa.statespace.SARIMAX``.

These are implementations of the same underlying model, (S)ARIMA(X), but with different fitting strategies, fitted parameters, and slightly differing behaviour. Users should refer to the statsmodels documentation for further details: https://www.statsmodels.org/dev/examples/notebooks/generated/statespace_sarimax_faq.html

Parameters ---------- order : tuple, optional The (p,d,q) order of the model for the autoregressive, differences, and moving average components. d is always an integer, while p and q may either be integers or lists of integers. seasonal_order : tuple, optional The (P,D,Q,s) order of the seasonal component of the model for the AR parameters, differences, MA parameters, and periodicity. Default is (0, 0, 0, 0). D and s are always integers, while P and Q may either be integers or lists of positive integers. trend : str{'n','c','t','ct'} or iterable, optional Parameter controlling the deterministic trend. Can be specified as a string where 'c' indicates a constant term, 't' indicates a linear trend in time, and 'ct' includes both. Can also be specified as an iterable defining a polynomial, as in ``numpy.poly1d``, where ``[1,1,0,1]`` would denote :math:`a + bt + ct^3`. Default is 'c' for models without integration, and no trend for models with integration. Note that all trend terms are included in the model as exogenous regressors, which differs from how trends are included in ``SARIMAX`` models. See the Notes section for a precise definition of the treatment of trend terms. enforce_stationarity : bool, optional Whether or not to require the autoregressive parameters to correspond to a stationarity process. enforce_invertibility : bool, optional Whether or not to require the moving average parameters to correspond to an invertible process. concentrate_scale : bool, optional Whether or not to concentrate the scale (variance of the error term) out of the likelihood. This reduces the number of parameters by one. This is only applicable when considering estimation by numerical maximum likelihood. trend_offset : int, optional The offset at which to start time trend values. Default is 1, so that if ``trend='t'`` the trend is equal to 1, 2, ..., nobs. Typically is only set when the model created by extending a previous dataset. dates : array_like of datetime, optional If no index is given by ``endog`` or ``exog``, an array-like object of datetime objects can be provided. freq : str, optional If no index is given by ``endog`` or ``exog``, the frequency of the time-series may be specified here as a Pandas offset or offset string. missing : str Available options are 'none', 'drop', and 'raise'. If 'none', no nan checking is done. If 'drop', any observations with nans are dropped. If 'raise', an error is raised. Default is 'none'. start_params : array_like, optional Initial guess of the solution for the loglikelihood maximization. If None, the default is given by Model.start_params. transformed : bool, optional Whether or not ``start_params`` is already transformed. Default is True. includes_fixed : bool, optional If parameters were previously fixed with the ``fix_params`` method, this argument describes whether or not ``start_params`` also includes the fixed parameters, in addition to the free parameters. Default is False. method : str, optional The method used for estimating the parameters of the model. Valid options include 'statespace', 'innovations_mle', 'hannan_rissanen', 'burg', 'innovations', and 'yule_walker'. Not all options are available for every specification (for example 'yule_walker' can only be used with AR(p) models). method_kwargs : dict, optional Arguments to pass to the fit function for the parameter estimator described by the ``method`` argument. gls : bool, optional Whether or not to use generalized least squares (GLS) to estimate regression effects. The default is False if ``method='statespace'`` and is True otherwise. gls_kwargs : dict, optional Arguments to pass to the GLS estimation fit method. Only applicable if GLS estimation is used (see ``gls`` argument for details). cov_type : str, optional The ``cov_type`` keyword governs the method for calculating the covariance matrix of parameter estimates. Can be one of:

- 'opg' for the outer product of gradient estimator - 'oim' for the observed information matrix estimator, calculated using the method of Harvey (1989) - 'approx' for the observed information matrix estimator, calculated using a numerical approximation of the Hessian matrix. - 'robust' for an approximate (quasi-maximum likelihood) covariance matrix that may be valid even in the presence of some misspecifications. Intermediate calculations use the 'oim' method. - 'robust_approx' is the same as 'robust' except that the intermediate calculations use the 'approx' method. - 'none' for no covariance matrix calculation.

Default is 'opg' unless memory conservation is used to avoid computing the loglikelihood values for each observation, in which case the default is 'oim'. cov_kwds : dict or None, optional A dictionary of arguments affecting covariance matrix computation.

**opg, oim, approx, robust, robust_approx**

- 'approx_complex_step' : bool, optional - If True, numerical approximations are computed using complex-step methods. If False, numerical approximations are computed using finite difference methods. Default is True. - 'approx_centered' : bool, optional - If True, numerical approximations computed using finite difference methods use a centered approximation. Default is False. return_params : bool, optional Whether or not to return only the array of maximizing parameters. Default is False. low_memory : bool, optional If set to True, techniques are applied to substantially reduce memory usage. If used, some features of the results object will not be available (including smoothed results and in-sample prediction), although out-of-sample forecasting is possible. Default is False.

See Also -------- ARIMA SARIMAX AutoARIMA StatsForecastAutoARIMA

Examples -------- >>> from sktime.datasets import load_airline >>> from sktime.forecasting.arima import StatsModelsARIMA >>> y = load_airline() >>> forecaster = StatsModelsARIMA(order=(0, 0, 12)) # doctest: +SKIP >>> forecaster.fit(y) # doctest: +SKIP >>> 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. statsmodelsarima_init order typing.Optional[tuple[int, int, int]]: default: (0, 0, 0) seasonal_order typing.Optional[tuple[int, int, int, int]]: default: (0, 0, 0, 0)… Read full field description

Number of steps ahead to forecast. Defaults to 37. statsmodelsarima_init order typing.Optional[tuple[int, int, int]]: default: (0, 0, 0) seasonal_order typing.Optional[tuple[int, int, int, int]]: default: (0, 0, 0, 0) trend typing.Union[str, collections.abc.Iterable, NoneType]: default: None enforce_stationarity <class 'bool'>: default: True enforce_invertibility <class 'bool'>: default: True concentrate_scale <class 'bool'>: default: False trend_offset <class 'int'>: default: 1 dates typing.Optional[numpy.ndarray]: default: None freq typing.Optional[str]: default: None missing typing.Optional[str]: default: None start_params typing.Optional[numpy.ndarray]: default: None transformed <class 'bool'>: default: True includes_fixed <class 'bool'>: default: False method typing.Optional[str]: default: None method_kwargs typing.Optional[dict]: default: None gls <class 'bool'>: default: False gls_kwargs typing.Optional[dict]: default: None cov_type <class 'str'>: default: opg cov_kwds typing.Optional[dict]: default: None return_params <class 'bool'>: default: False low_memory <class 'bool'>: default: False

int
Optional
Default: 37
model_save_pathRequired
str
Required
Default: null
statsmodelsarima_initRequired
StatsModelsARIMAAttributes
Required
Default: null
gls
bool
Optional
Default: false
freq
typing.Optional[str]
Optional
Default: null
dates
typing.Optional[numpy.ndarray]
Optional
Default: null
order
typing.Optional[tuple[int, int, int]]
Optional
Default: [0,0,0]
trend
typing.Union[str, collections.abc.Iterable, NoneType]
Optional
Default: null
method
typing.Optional[str]
Optional
Default: null
missing
typing.Optional[str]
Optional
Default: null
cov_kwds
typing.Optional[dict]
Optional
Default: null
cov_type
str
Optional
Default: "opg"
gls_kwargs
typing.Optional[dict]
Optional
Default: null
low_memory
bool
Optional
Default: false
transformed
bool
Optional
Default: true
start_params
typing.Optional[numpy.ndarray]
Optional
Default: null
trend_offset
int
Optional
Default: 1
method_kwargs
typing.Optional[dict]
Optional
Default: null
return_params
bool
Optional
Default: false
includes_fixed
bool
Optional
Default: false
seasonal_order
typing.Optional[tuple[int, int, int, int]]
Optional
Default: [0,0,0,0]
concentrate_scale
bool
Optional
Default: false
enforce_stationarity
bool
Optional
Default: true
enforce_invertibility
bool
Optional
Default: true

Configuration example

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

yaml
templates:
  - template_name: "StatsModelsARIMASKTimeWrapper"
    class_name: "StatsModelsARIMASKTimeWrapper"
    attributes:
      root_dir: "/sinapsis-hub/private/platform/sinapsis-hub/playground/publish"
      n_steps_ahead: 37
      model_save_path: "<required>"
      statsmodelsarima_init:
        gls: false
        freq: null
        dates: null
        order: [0, 0, 0]
        trend: null
        method: null
        missing: null
        cov_kwds: null
        cov_type: "opg"
        gls_kwargs: null
        low_memory: false
        transformed: true
        start_params: null
        trend_offset: 1
        method_kwargs: null
        return_params: false
        includes_fixed: false
        seasonal_order: [0, 0, 0, 0]
        concentrate_scale: false
        enforce_stationarity: true
        enforce_invertibility: true

Inheritance

Immediate parent: sinapsis_sktime.templates.sktime_forecasters.SKTimeArimaForecaster

Environment variables

Environment definitions belong to their canonical Python modules.

SINAPSIS_BUILD_DOCS · defined elsewhere