install_nprophet: Install Neural Prophet

In AlbertoAlmuinha/neuralprophet: 'Neural Prophet' Algorithm

Description

Installs Neural Prophet Deep Learning Time Series Forecasting Software using reticulate::py_install().

• A Python Environment will be created named nprophet.

• The neuralprophet R package will connect to the nprophet Python environment

Usage

install_nprophet(fresh_install = FALSE)

Arguments

fresh_install

Default: FALSE. If TRUE, this removes any previous “r-gluonts” environments, which can help in the case of errors. Caution: If you have added packages to this environment after a prior install, these packages will be removed.

Details

Options for Connecting to Python

• Recommended Use Pre-Configured Python Environment: Use install_nprophet() to install Neural Prophet Python Libraries into a conda environment named 'nprophet'.

• Advanced Use a Custom Python Environment: Before running library(neuralprohet), use Sys.setenv(NPROPHET_PYTHON = 'path/to/python') to set the path of your python executable in an environment that has 'pillow', 'torch', 'numpy', 'pandas', and 'neuralprophet' available as dependencies.

Package Manager Support (Python Environment)

• Conda Environments: Currently, install_nprophet() supports Conda and Miniconda Environments.

• Virtual Environments: are not currently supported with the default installation method, install_nprophet(). However, you can connect to virtual environment that you have created using Sys.setenv(NPROPHET_PYTHON = 'path/to/python') prior to running library(neuralprohet).

Examples

## Not run: 
install_nprophet()

## End(Not run)

AlbertoAlmuinha/neuralprophet documentation built on Dec. 17, 2021, 7:47 a.m.