XLSTMForecaster

XLSTMForecaster

class XLSTMForecaster(input_size=1, hidden_size=64, num_layers=2, block_types=None, num_heads=1, dropout=0.1, learning_rate=0.001, batch_size=32, n_epochs=50, sequence_length=20, device=None)[source]

xLSTM Forecaster for time series prediction using Extended LSTM architecture.

Parameters:

input_sizeint, default=1

Number of input features

hidden_sizeint, default=64

Hidden state size for xLSTM blocks

num_layersint, default=2

Number of xLSTM layers

block_typeslist, default=None

List of block types (‘slstm’ or ‘mlstm’). If None, uses all ‘slstm’

num_headsint, default=1

Number of attention heads for mLSTM blocks

dropoutfloat, default=0.1

Dropout probability

learning_ratefloat, default=0.001

Learning rate for optimization

batch_sizeint, default=32

Batch size for training

n_epochsint, default=50

Number of training epochs

sequence_lengthint, default=20

Length of input sequences

devicestr, default=None

Device to use (‘cuda’ or ‘cpu’). If None, auto-detects

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.

Examples

>>> from sktime.datasets import load_airline
>>> from sktime.forecasting.xlstm import XLSTMForecaster
>>> y = load_airline()
>>> forecaster = XLSTMForecaster(
...     hidden_size=32,
...     num_layers=2,
...     n_epochs=10
... )
>>> forecaster.fit(y)
XLSTMForecaster(...)
>>> 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.