mirror of
https://github.com/saymrwulf/prophet.git
synced 2026-05-16 21:00:16 +00:00
f16e22731f
* Update and rename README to README.md and Unicode strings Updated Readme file and converted from rst to markdown. String contains ascii characters (converted to unicode string) Signed-off-by: Mpho Mphego mpho112@gmail.com * Deprecated import `from __future__ import unicode_literals` removed and ran isort module https://mail.python.org/pipermail/python-dev/2016-December/147009.html Included setuptool-git in the requirement.txt and updated `setup.py` Reasons for this are highlighted here -> https://github.com/msabramo/setuptools-git#usage
38 lines
1.8 KiB
Markdown
38 lines
1.8 KiB
Markdown
# 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
|
|
|
|
```shell
|
|
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
|
|
|
|
```python
|
|
>>> 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)
|
|
```
|