Metadata-Version: 2.1
Name: skforecast
Version: 0.4.3
Summary: Forecasting time series with scikitlearn regressors. It also works with any regressor compatible with the scikit-learn API (pipelines, CatBoost, LightGBM, XGBoost, Ranger...).
Home-page: https://github.com/JoaquinAmatRodrigo/skforecast
Author: Joaquin Amat Rodrigo
Author-email: j.amatrodrigo@gmail.com
License: UNKNOWN
Description: [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/Naereen/StrapDown.js/graphs/commit-activity)
        ![Lifecycle](https://img.shields.io/badge/lifecycle-maturing-blue)
        ![Python](https://img.shields.io/badge/python-3.7%20%7C%203.8%20%7C%203.9-blue)
        ![Licence](https://img.shields.io/badge/Licence-MIT-green)
        [![Downloads](https://static.pepy.tech/personalized-badge/skforecast?period=total&units=international_system&left_color=grey&right_color=blue&left_text=Downloads)](https://pepy.tech/project/skforecast)
        ![PyPI](https://img.shields.io/pypi/v/skforecast)
        
        
        # skforecast
        
        <p><img src="./images/logo_skforecast_no_background.png" alt="logo-skforecast" title="logo-skforecast" width="200" align="right"></p>
        
        **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
        
        ```bash
        pip install skforecast
        ```
        
        Specific version:
        
        ```bash
        pip install skforecast==0.4.1
        ```
        
        Latest (unstable):
        
        ```bash
        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
         
         ```bash
        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
        + statsmodels>=0.12, <=0.13
        
        # 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
        
        
        # Documentation
        
        The documentation for the latest release is at [skforecast docs
        ](https://joaquinamatrodrigo.github.io/skforecast/).
        
        Recent improvements are highlighted in the [release notes](https://joaquinamatrodrigo.github.io/skforecast/latest/releases/releases.html).
        
        + [Introduction to time series and forecasting](https://joaquinamatrodrigo.github.io/skforecast/latest/introduction-forecasting/introduction-forecasting.html)
        
        + [Multi-step forecasting](https://joaquinamatrodrigo.github.io/skforecast/latest/autoregresive-forecaster.html)
        
        + [Backtesting (validation) of forecasting models](https://joaquinamatrodrigo.github.io/skforecast/latest/backtesting.html)
        
        + [Grid search of forecasting models](https://joaquinamatrodrigo.github.io/skforecast/latest/grid-search-forecaster.html)
        
        + [Using forecaster in production](https://joaquinamatrodrigo.github.io/skforecast/latest/forecaster-in-production.html)
        
        
        # Examples and tutorials 
        
        **English**
        
        + [**Skforecast: time series forecasting with Python and Scikit-learn**](https://www.cienciadedatos.net/documentos/py27-time-series-forecasting-python-scikitlearn.html)
        
        + [**Forecasting electricity demand with Python**](https://www.cienciadedatos.net/documentos/py29-forecasting-electricity-power-demand-python.html)
        
        + [**Forecasting time series with gradient boosting: Skforecast, XGBoost, LightGBM and CatBoost**](https://www.cienciadedatos.net/documentos/py39-forecasting-time-series-with-skforecast-xgboost-lightgbm-catboost.html)
        
        + [**Forecasting web traffic with machine learning and Python**](https://www.cienciadedatos.net/documentos/py37-forecasting-web-traffic-machine-learning.html)
        
        **Español**
        
        + [**Skforecast: forecasting series temporales con Python y Scikit-learn**](https://www.cienciadedatos.net/documentos/py27-forecasting-series-temporales-python-scikitlearn.html)
        
        + [**Forecasting de la demanda eléctrica**](https://www.cienciadedatos.net/documentos/py29-forecasting-demanda-energia-electrica-python.html)
        
        + [**Forecasting de las visitas a una página web**](https://www.cienciadedatos.net/documentos/py37-forecasting-visitas-web-machine-learning.html)
        
        + [**Forecasting series temporales con gradient boosting: Skforecast, XGBoost, LightGBM y CatBoost**](https://www.cienciadedatos.net/documentos/py39-forecasting-series-temporales-con-skforecast-xgboost-lightgbm-catboost.html)
        
        
        # 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](https://www.paypalobjects.com/en_US/ES/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/donate/?hosted_button_id=D2JZSWRLTZDL6)
        
        
        # Licence
        
        **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.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: MIT License
Description-Content-Type: text/markdown
