StatsForecastAutoTBATS

class StatsForecastAutoTBATS(seasonal_periods: int | list[int] = 1, use_boxcox: bool | None = None, use_trend: bool | None = None, use_damped_trend: bool | None = None, use_arma_errors: bool = True, bc_lower_bound: float = 0.0, bc_upper_bound: float = 1.0)[source]

StatsForecast TBATS model.

Direct interface to statsforecast.models.AutoTBATS, from statsforecast [1] by Nixtla.

Automatically selects the best TBATS model from all feasible combinations of the parameters use_boxcox, use_trend, use_damped_trend, and use_arma_errors. Selection is made using the AIC.

Default value for use_arma_errors is True since this enables the evaluation of models with and without ARMA errors.

Parameters:

seasonal_periodsint or list of int. (default=1): Number of observations per unit of time. Ex: 24 Hourly data.
use_boxcoxbool (default=None): Whether or not to use a Box-Cox transformation. By default tries both.
use_trendbool (default=None): Whether or not to use a trend component. By default tries both.
use_damped_trendbool (default=None): Whether or not to dampen the trend component. By default tries both.
use_arma_errorsbool (default=True): Whether or not to use a ARMA errors. Default is True and this evaluates both models.
bc_lower_boundfloat (default=0.0): Lower bound for the Box-Cox transformation.
bc_upper_boundfloat (default=1.0): Upper bound for the Box-Cox transformation.

Attributes:

cutoff: Cut-off = “present time” state of forecaster.
fh: Forecasting horizon that was passed.
is_fitted: Whether fit has been called.
state: State of the estimator.

References

[1]

https://nixtlaverse.nixtla.io/statsforecast/src/core/models.html#autotbats

Examples

>>> from sktime.datasets import load_airline
>>> from sktime.forecasting.statsforecast import StatsForecastAutoTBATS
>>> y = load_airline()
>>> forecaster = StatsForecastAutoTBATS(
...     seasonal_periods=12, use_trend=True, use_arma_errors=False
... )
>>> forecaster.fit(y)
StatsForecastAutoTBATS(...)
>>> y_pred = forecaster.predict(fh=[1, 2, 3])

Methods

`check_is_fitted`([method_name])	Check if the estimator has been fitted.
`clone`()	Obtain a clone of the object with same hyper-parameters and config.
`clone_tags`(estimator[, tag_names])	Clone tags from another object as dynamic override.
`create_test_instance`([parameter_set])	Construct an instance of the class, using first test parameter set.
`create_test_instances_and_names`([parameter_set])	Create list of all test instances and a list of names for them.
`fit`(y[, X, fh])	Fit forecaster to training data.
`fit_predict`(y[, X, fh, X_pred])	Fit and forecast time series at future horizon.
`get_class_tag`(tag_name[, tag_value_default])	Get class tag value from class, with tag level inheritance from parents.
`get_class_tags`()	Get class tags from class, with tag level inheritance from parent classes.
`get_config`()	Get config flags for self.
`get_fitted_params`([deep])	Get fitted parameters.
`get_param_defaults`()	Get object's parameter defaults.
`get_param_names`([sort])	Get object's parameter names.
`get_params`([deep])	Get a dict of parameters values for this object.
`get_pretrained_params`([deep])	Get pretrained parameters of this estimator.
`get_tag`(tag_name[, tag_value_default, ...])	Get tag value from instance, with tag level inheritance and overrides.
`get_tags`()	Get tags from instance, with tag level inheritance and overrides.
`get_test_params`([parameter_set])	Return testing parameter settings for the estimator.
`is_composite`()	Check if the object is composed of other BaseObjects.
`load_from_path`(serial)	Load object from file location.
`load_from_serial`(serial)	Load object from serialized memory container.
`predict`([fh, X])	Forecast time series at future horizon.
`predict_interval`([fh, X, coverage])	Compute/return prediction interval forecasts.
`predict_proba`([fh, X, marginal])	Compute/return fully probabilistic forecasts.
`predict_quantiles`([fh, X, alpha])	Compute/return quantile forecasts.
`predict_residuals`([y, X])	Return residuals of time series forecasts.
`predict_var`([fh, X, cov])	Compute/return variance forecasts.
`pretrain`(y[, X, fh])	Pre-train forecaster on panel (global) data.
`reset`()	Reset the object to a clean post-init state.
`save`([path, serialization_format])	Save serialized self to bytes-like object or to (.zip) file.
`score`(y[, X, fh])	Scores forecast against ground truth, using MAPE (non-symmetric).
`set_config`(**config_dict)	Set config flags to given values.
`set_params`(**params)	Set the parameters of this object.
`set_random_state`([random_state, deep, ...])	Set random_state pseudo-random seed parameters for self.
`set_tags`(**tag_dict)	Set instance level tag overrides to given values.
`update`(y[, X, update_params])	Update cutoff value and, optionally, fitted parameters.
`update_predict`(y[, cv, X, update_params, ...])	Make predictions and update model iteratively over the test set.
`update_predict_single`([y, fh, X, update_params])	Update model with new data and make forecasts.