saymrwulf/prophet
1
0
Fork 0
mirror of https://github.com/saymrwulf/prophet.git synced 2026-07-02 03:55:36 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

CmdStan related docs (#1352)

Browse source 
* updated readme

* docs

* fixes

Co-authored-by: Ben Letham <bletham@gmail.com>
This commit is contained in:
Christopher Suchanek 2020-03-03 16:42:13 -08:00 committed by GitHub
parent 560077c8a7
commit 5842935f41
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -45,7 +45,23 @@ Prophet is on PyPI, so you can use pip to install it:
$ pip install fbprophet
```
The major dependency that Prophet has is `pystan`. PyStan has its own [installation instructions](http://pystan.readthedocs.io/en/latest/installation_beginner.html). Install pystan with pip before using pip to install fbprophet. You may also try the (more experimental) [cmdstanpy backend](https://github.com/stan-dev/cmdstanpy).
The default dependency that Prophet has is `pystan`. PyStan has its own [installation instructions](http://pystan.readthedocs.io/en/latest/installation_beginner.html). Install pystan with pip before using pip to install fbprophet.
You can also choose a (more experimental) alternative stan backend called `cmdstanpy`. It requires the [CmdStan](https://mc-stan.org/users/interfaces/cmdstan) command line interface and you will have to specify the environment variable `STAN_BACKEND` pointing to it, for example:
```
# bash
$ CMDSTAN=/tmp/cmdstan-2.22.1 STAN_BACKEND=CMDSTANPY pip install fbprophet
```
Note that the `CMDSTAN` variable is directly related to `cmdstanpy` module and can be omitted if your CmdStan binaries are in your `$PATH`.
It is also possible to install Prophet with two backends:
```
# bash
$ CMDSTAN=/tmp/cmdstan-2.22.1 STAN_BACKEND=PYSTAN,CMDSTANPY pip install fbprophet
```
After installation, you can [get started!](https://facebook.github.io/prophet/docs/quick_start.html#python-api)