/skforecast

Time series forecasting with scikit-learn models

Primary LanguageJupyter NotebookMIT LicenseMIT

Maintenance Lifecycle Python Licence Downloads PyPI

skforecast

logo-skforecast

Time series forecasting with scikit-learn regressors.

Skforecast is a python library that eases using scikit-learn regressors as multi-step forecasters. It also works with any regressor compatible with the scikit-learn API (pipelines, CatBoost, LightGBM, XGBoost, Ranger...).

Documentation: https://joaquinamatrodrigo.github.io/skforecast/

Installation

pip install skforecast

Specific version:

pip install skforecast==0.4.3

Latest (unstable):

pip install git+https://github.com/JoaquinAmatRodrigo/skforecast#master

The most common error when importing the library is:

'cannot import name 'mean_absolute_percentage_error' from 'sklearn.metrics'.

This is because the scikit-learn installation is lower than 0.24. Try to upgrade scikit-learn with:

pip3 install -U scikit-learn

Dependencies

  • numpy>=1.20, <=1.22
  • pandas>=1.2, <=1.4
  • tqdm>=4.57.0, <=4.62
  • scikit-learn>=1.0, <=1.0.2
  • statsmodels>=0.12, <=0.13
  • optuna==2.10.0
  • scikit-optimize==0.9.0

Features

  • Create recursive autoregressive forecasters from any regressor that follows the scikit-learn API
  • Create multi-output autoregressive forecasters from any regressor that follows the scikit-learn API
  • Grid search to find optimal hyperparameters
  • Grid search to find optimal lags (predictors)
  • Include exogenous variables as predictors
  • Include custom predictors (rolling mean, rolling variance ...)
  • Multiple backtesting methods for model validation
  • Include custom metrics for model validation
  • Prediction interval estimated by bootstrapping
  • Get predictor importance

What is coming in the new release?

  • Random search and bayesian search (using optuna or skopt) for hyperparameter optimization.
  • ForecasterAutoregMultiOutput has been renamed to ForecasterAutoregDirect.
  • Bug fixes and performance improvements.
  • Modeling multiple time series simultaneously.
  • Allow different transformations for each predictor (lags and exogenous).

Try it:

pip install git+https://github.com/JoaquinAmatRodrigo/skforecast#master

Visit changelog to view all notable changes.

Documentation

The documentation for the latest release is at skforecast docs .

Recent improvements are highlighted in the release notes.

Examples and tutorials

English

Español

Donating

If you found skforecast useful, you can support us with a donation. Your contribution will help to continue developing and improving this project. Many thanks!

paypal

License

joaquinAmatRodrigo/skforecast is licensed under the MIT License, a short and simple permissive license with conditions only requiring preservation of copyright and license notices. Licensed works, modifications, and larger works may be distributed under different terms and without source code.