| | | | --- | --- | | Package | | | Meta | | | Testing | | |Donation | | |Community | |Affiliation |

Table of Contents

• :information_source: About The Project
• :books: Documentation
• :computer: Installation & Dependencies
• :sparkles: What is new in skforecast 0.13?
• :crystal_ball: Forecasters
• :mortar_board: Examples and tutorials
• :handshake: How to contribute
• :memo: Citation
• :moneywithwings: Donating
• :scroll: License

About The Project

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

Why use skforecast?

The fields of statistics and machine learning have developed many excellent regression algorithms that can be useful for forecasting, but applying them effectively to time series analysis can still be a challenge. To address this issue, the skforecast library provides a comprehensive set of tools for training, validation and prediction in a variety of scenarios commonly encountered when working with time series. The library is built using the widely used scikit-learn API, making it easy to integrate into existing workflows. With skforecast, users have access to a wide range of functionalities such as feature engineering, model selection, hyperparameter tuning and many others. This allows users to focus on the essential aspects of their projects and leave the intricacies of time series analysis to skforecast. In addition, skforecast is developed according to the following priorities:

• Fast and robust prototyping. :zap:
• Validation and backtesting methods to have a realistic assessment of model performance. :mag:
• Models must be deployed in production. :hammer:
• Models must be interpretable. :crystal_ball:

Share Your Thoughts with Us

Thank you for choosing skforecast! We value your suggestions, bug reports and recommendations as they help us identify areas for improvement and ensure that skforecast meets the needs of the community. Please consider sharing your experiences, reporting bugs, making suggestions or even contributing to the codebase on GitHub. Together, let's make time series forecasting more accessible and accurate for everyone.

Documentation

For detailed information on how to use and leverage the full potential of skforecast please refer to the comprehensive documentation available at:

https://skforecast.org :books:

| Documentation | | |:----------------------------------------|:----| | :book: Introduction to forecasting | Basics of forecasting concepts and methodologies | | :rocket: Quick start | Get started quickly with skforecast | | :hammerandwrench: User guides | Detailed guides on skforecast features and functionalities | | :mortarboard: Examples and tutorials | Learn through practical examples and tutorials to master skforecast | | :question: FAQ and tips | Find answers and tips about forecasting | | :books: API Reference | Comprehensive reference for skforecast functions and classes | | :blacknib: Authors | Meet the authors and contributors of skforecast |

Installation & Dependencies

To install the basic version of skforecast with its core dependencies, run:

bash pip install skforecast

If you want to learn more about the installation process, dependencies and optional features, please refer to the Installation Guide.

What is new in skforecast 0.13?

Visit the release notes to view all notable changes.

• [ ] New features.
• [ ] Bug fixes and performance improvements.

Forecasters

A Forecaster object in the skforecast library is a comprehensive container that provides essential functionality and methods for training a forecasting model and generating predictions for future points in time.

The skforecast library offers a variety of forecaster types, each tailored to specific requirements such as single or multiple time series, direct or recursive strategies, or custom predictors. Regardless of the specific forecaster type, all instances share the same API.

| Forecaster | Single series | Multiple series | Recursive strategy | Direct strategy | Probabilistic prediction | Time series differentiation | Exogenous features | Custom features | |:-----------|:-------------:|:---------------:|:------------------:|:---------------:|:------------------------:|:---------------------------:|:------------------:|:---------------:| |ForecasterAutoreg|:heavycheckmark:||:heavycheckmark:||:heavycheckmark:|:heavycheckmark:|:heavycheckmark:|| |ForecasterAutoregCustom|:heavycheckmark:||:heavycheckmark:||:heavycheckmark:|:heavycheckmark:|:heavycheckmark:|:heavycheckmark:|:heavycheckmark:| |ForecasterAutoregDirect|:heavycheckmark:|||:heavycheckmark:|:heavycheckmark:||:heavycheckmark:|| |ForecasterMultiSeries||:heavycheckmark:|:heavycheckmark:||:heavycheckmark:|:heavycheckmark:|:heavycheckmark:|| |ForecasterMultiSeriesCustom||:heavycheckmark:|:heavycheckmark:||:heavycheckmark:|:heavycheckmark:|:heavycheckmark:|:heavycheckmark:| |ForecasterMultiVariate||:heavycheckmark:||:heavycheckmark:|:heavycheckmark:||:heavycheckmark:|| |ForecasterRNN||:heavycheckmark:||:heavycheckmark:||||| |ForecasterSarimax|:heavycheckmark:||:heavycheckmark:||:heavycheckmark:|:heavycheckmark:|:heavycheckmark:||

Examples and tutorials

English

• Skforecast: time series forecasting with Machine Learning

• ARIMA and SARIMAX models

• Forecasting with gradient boosting: XGBoost, LightGBM and CatBoost

• Global Forecasting Models: Multi-series forecasting

• Probabilistic forecasting

• Forecasting with Deep Learning

• Modelling time series trend with tree based models

• Mitigating the impact of covid on forecasting models

• Forecasting time series with missing values

• Intermittent demand forecasting

• Stacking ensemble of machine learning models to improve forecasting

• Forecasting energy demand with machine learning

• Global Forecasting Models: Comparative Analysis of Single and Multi-Series Forecasting Modeling

• Forecasting web traffic with machine learning and Python

• Bitcoin price prediction with Python

Español

• Skforecast: forecasting series temporales con Machine Learning

• Modelos ARIMA y SARIMAX

• Forecasting con gradient boosting: XGBoost, LightGBM y CatBoost

• Global Forecasting Models: Multi-series forecasting

• Forecasting Probabilístico

• Forecasting con Deep Learning

• Modelar series temporales con tendencia utilizando modelos de árboles

• Predicción de demanda intermitente

• Reducir el impacto del Covid en modelos de forecasting

• Forecasting de la demanda eléctrica

• Forecasting de las visitas a una página web

• Predicción del precio de Bitcoin con Python

• Workshop predicción de series temporales con machine learning Universidad de Deusto / Deustuko Unibertsitatea

How to contribute

Primarily, skforecast development consists of adding and creating new Forecasters, new validation strategies, or improving the performance of the current code. However, there are many other ways to contribute:

• Submit a bug report or feature request on GitHub Issues.
• Contribute a Jupyter notebook to our examples.
• Write unit or integration tests for our project.
• Answer questions on our issues, Stack Overflow, and elsewhere.
• Translate our documentation into another language.
• Write a blog post, tweet, or share our project with others.

For more information on how to contribute to skforecast, see our Contribution Guide.

Visit our authors section to meet all the contributors to skforecast.

Citation

If you use skforecast for a scientific publication, we would appreciate citations to the published software.

Zenodo

Amat Rodrigo, Joaquin, & Escobar Ortiz, Javier. (2024). skforecast (v0.12.1). Zenodo. https://doi.org/10.5281/zenodo.8382788

APA: Amat Rodrigo, J., & Escobar Ortiz, J. (2024). skforecast (Version 0.12.1) [Computer software]. https://doi.org/10.5281/zenodo.8382788

BibTeX: @software{skforecast, author = {Amat Rodrigo, Joaquin and Escobar Ortiz, Javier}, title = {skforecast}, version = {0.12.1}, month = {5}, year = {2024}, license = {BSD-3-Clause}, url = {https://skforecast.org/}, doi = {10.5281/zenodo.8382788} }

View the citation file.

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!

License

BSD-3-Clause License