Include cmdstanr installation instructions for R (#1905)

* update installation instructions for R

* force rstantools 2.0.0

* remove mc-stan repo, do not install Suggests

* install suggested packages manually
This commit is contained in:
Cuong Duong 2021-05-12 01:39:20 +10:00 committed by GitHub
parent 14fa36b4d5
commit 949a07b500
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 69 additions and 6 deletions

View file

@ -24,12 +24,31 @@ Prophet is [open source software](https://code.facebook.com/projects/) released
Prophet is a [CRAN package](https://cran.r-project.org/package=prophet) so you can use `install.packages`.
```R
```r
install.packages('prophet')
```
After installation, you can [get started!](https://facebook.github.io/prophet/docs/quick_start.html#r-api)
#### Experimental backend - cmdstanr
You can also choose an experimental alternative stan backend called `cmdstanr`. Once you've installed `prophet`,
follow these instructions to use `cmdstanr` instead of `rstan` as the backend:
```r
# R
# We recommend running this is a fresh R session or restarting your current session
install.packages(c("cmdstanr", "posterior"), repos = c("https://mc-stan.org/r-packages/", getOption("repos")))
# If you haven't installed cmdstan before, run:
cmdstanr::install_cmdstan()
# Otherwise, you can point cmdstanr to your cmdstan path:
cmdstanr::set_cmdstan_path(path = <your existing cmdstan>)
# Set the R_STAN_BACKEND environment variable
Sys.setenv(R_STAN_BACKEND = "CMDSTANR")
```
### Windows
On Windows, R requires a compiler so you'll need to [follow the instructions](https://github.com/stan-dev/rstan/wiki/RStan-Getting-Started) provided by `rstan`. The key step is installing [Rtools](http://cran.r-project.org/bin/windows/Rtools/) before attempting to install the package.
@ -50,9 +69,11 @@ pip install prophet
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 prophet.
#### Experimental backend - cmdstanpy
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
# bash
$ CMDSTAN=/tmp/cmdstan-2.22.1 STAN_BACKEND=CMDSTANPY pip install prophet
```
@ -61,7 +82,7 @@ Note that the `CMDSTAN` variable is directly related to `cmdstanpy` module and c
It is also possible to install Prophet with two backends:
```
```bash
# bash
$ CMDSTAN=/tmp/cmdstan-2.22.1 STAN_BACKEND=PYSTAN,CMDSTANPY pip install prophet
```

View file

@ -14,15 +14,36 @@ Prophet has two implementations: [R](#installation-in-r) and [Python](#installat
<a href="#r"></a>
## Installation in R
Prophet is a [CRAN package](https://cran.r-project.org/package=prophet) so you can use `install.packages`.
```
```r
# R
> install.packages('prophet')
install.packages('prophet')
```
After installation, you can [get started!](quick_start.html#r-api)
#### Experimental backend - cmdstanr
You can also choose an experimental alternative stan backend called `cmdstanr`. Once you've installed `prophet`,
follow these instructions to use `cmdstanr` instead of `rstan` as the backend:
```r
# R
# We recommend running this is a fresh R session or restarting your current session
install.packages(c("cmdstanr", "posterior"), repos = c("https://mc-stan.org/r-packages/", getOption("repos")))
# If you haven't installed cmdstan before, run:
cmdstanr::install_cmdstan()
# Otherwise, you can point cmdstanr to your cmdstan path:
cmdstanr::set_cmdstan_path(path = <your existing cmdstan>)
# Set the R_STAN_BACKEND environment variable
Sys.setenv(R_STAN_BACKEND = "CMDSTANR")
```
### Windows
On Windows, R requires a compiler so you'll need to [follow the instructions](https://github.com/stan-dev/rstan/wiki/Installing-RStan-on-Windows) provided by `rstan`. The key step is installing [Rtools](http://cran.r-project.org/bin/windows/Rtools/) before attempting to install the package.
@ -35,9 +56,10 @@ If you have custom Stan compiler settings, install from source rather than the C
Prophet is on PyPI, so you can use pip to install it:
```
```bash
# bash
# Install pystan with pip before using pip to install prophet
# pystan>=3.0 is currently not supported
$ pip install pystan==2.19.1.1
$
$ pip install prophet
@ -45,8 +67,28 @@ $ pip install prophet
The major dependency that Prophet has is `pystan`. PyStan has its own [installation instructions](https://pystan.readthedocs.io/en/latest/installation.html). Install pystan with pip before using pip to install prophet.
If you upgrade the version of PyStan installed on your system, you may need to reinstall prophet ([see here](https://github.com/facebook/prophet/issues/324)).
After installation, you can [get started!](quick_start.html#python-api)
#### Experimental backend - cmdstanpy
You can also choose a (more experimental) alternative stan backend called cmdstanpy. It requires the CmdStan command line interface and you will have to specify the environment variable STAN_BACKEND pointing to it, for example:
```bash
# bash
$ CMDSTAN=/tmp/cmdstan-2.22.1 STAN_BACKEND=CMDSTANPY pip install prophet
```
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
# bash
$ CMDSTAN=/tmp/cmdstan-2.22.1 STAN_BACKEND=PYSTAN,CMDSTANPY pip install prophet
```
### Windows
On Windows, PyStan requires a compiler so you'll need to [follow the instructions](http://pystan.readthedocs.io/en/latest/windows.html). The easiest way to install Prophet in Windows is in Anaconda.