Ben Letham 287fb2f6de Move built-in country holidays to a function (R) 6 years ago
..
fbprophet 287fb2f6de Move built-in country holidays to a function (R) 6 years ago
scripts 95fa4460a9 Fix bug about holiday year different from input year and others (#670) 6 years ago
stan a38aaa38c6 Stan fix for pystan 2.16 7 years ago
LICENSE 9977a97266 Copy of LICENSE in python repo 8 years ago
MANIFEST.in ad095ac690 Add versions to build dependencies 6 years ago
README 371e8a3bf4 Version bump 7 years ago
pyproject.toml ad095ac690 Add versions to build dependencies 6 years ago
requirements.txt 817f0306a4 Modification of holiday features (#644) 6 years ago
setup.py 9beb1cb7e7 Version bumps before submitting new packages 7 years ago

README

Prophet: Automatic Forecasting Procedure
========================================

Prophet is a procedure for forecasting time series data based on an additive model where non-linear trends are fit with yearly, weekly, and daily seasonality, plus holiday effects. It works best with time series that have strong seasonal effects and several seasons of historical data. Prophet is robust to missing data and shifts in the trend, and typically handles outliers well.

Prophet is `open source software `_ released by Facebook's `Core Data Science team `_.

Full documentation and examples available at the homepage: https://facebook.github.io/prophet/

Important links
---------------

- HTML documentation: https://facebook.github.io/prophet/docs/quick_start.html
- Issue tracker: https://github.com/facebook/prophet/issues
- Source code repository: https://github.com/facebook/prophet
- Implementation of Prophet in R: https://cran.r-project.org/package=prophet


Other forecasting packages
--------------------------

- Rob Hyndman's `forecast package `_
- `Statsmodels `_


Installation
------------

::

$ pip install fbprophet


Note: Installation requires PyStan, which has its `own installation instructions `_. On Windows, PyStan requires a compiler so you'll need to `follow the instructions`_. The key step is installing a recent `C++ compiler `_.

Example usage
-------------

::

>>> from fbprophet import Prophet
>>> m = Prophet()
>>> m.fit(df) # df is a pandas.DataFrame with 'y' and 'ds' columns
>>> future = m.make_future_dataframe(periods=365)
>>> m.predict(future)