prophet/python
ziye666 817f0306a4 Modification of holiday features (#644)
* Allow both both hoidays and append holidays; match holidays in predict and fit

* Allow both both hoidays and append holidays; match holidays in predict and fit

* Add test for append_holiday features; minor fixes

* Add column name validation for append_holidays names; allow only one country
2018-08-27 13:52:34 -07:00
..
fbprophet Modification of holiday features (#644) 2018-08-27 13:52:34 -07:00
stan Stan fix for pystan 2.16 2018-05-30 14:23:37 -07:00
LICENSE Copy of LICENSE in python repo 2017-02-24 14:34:32 -08:00
MANIFEST.in Single stan model with both trends (Py) 2018-05-04 16:04:29 -07:00
README Version bump 2018-05-30 17:02:47 -07:00
requirements.txt Modification of holiday features (#644) 2018-08-27 13:52:34 -07:00
setup.py Version bumps before submitting new packages 2018-06-13 16:03:44 -07:00

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 <https://code.facebook.com/projects/>`_ released by Facebook's `Core Data Science team <https://research.fb.com/category/data-science/>`_.

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 <http://robjhyndman.com/software/forecast/>`_
- `Statsmodels <http://statsmodels.sourceforge.net/>`_


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

::

  $ pip install fbprophet


Note:  Installation requires PyStan, which has its `own installation instructions <http://pystan.readthedocs.io/en/latest/installation_beginner.html>`_.  On Windows, PyStan requires a compiler so you'll need to `follow the instructions<http://pystan.readthedocs.io/en/latest/windows.html>`_.  The key step is installing a recent `C++ compiler <http://landinghub.visualstudio.com/visual-cpp-build-tools>`_.

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)