Docs /Templates/ sinapsis-sktime

StatsForecastGARCHSKTimeWrapper

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

StatsForecastGARCH — inherited documentation

StatsForecast GARCH estimator.

Direct interface to ``statsforecast.models.GARCH``.

This implements the Generalized Autoregressive Conditional Heteroskedasticity (GARCH) model.

Constructs a GARCH(p, q) model.

Parameters ---------- p: int (default 1) AR parameter - number of auto-regressive lags. q: int (default 1) GARCH heteroskedasticity lag parameter - number of lags for variance term.

Examples -------- >>> from sktime.datasets import load_airline >>> from sktime.forecasting.arch import StatsForecastGARCH >>> y = load_airline() >>> forecaster = StatsForecastGARCH(p=2,q=1) >>> forecaster.fit(y) StatsForecastGARCH(...) >>> 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. statsforecastgarch_init p <class 'int'>: default: 1 q <class 'int'>: default: 1

int
Optional
Default: 37
model_save_pathRequired
str
Required
Default: null
statsforecastgarch_initRequired
StatsForecastGARCHAttributes
Required
Default: null
p
int
Optional
Default: 1
q
int
Optional
Default: 1

Configuration example

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

yaml
templates:
  - template_name: "StatsForecastGARCHSKTimeWrapper"
    class_name: "StatsForecastGARCHSKTimeWrapper"
    attributes:
      root_dir: "/sinapsis-hub/private/platform/sinapsis-hub/playground/publish"
      n_steps_ahead: 37
      model_save_path: "<required>"
      statsforecastgarch_init:
        p: 1
        q: 1

Inheritance

Immediate parent: sinapsis_sktime.templates.sktime_forecasters.SKTimeArchForecaster

Environment variables

Environment definitions belong to their canonical Python modules.

SINAPSIS_BUILD_DOCS · defined elsewhere