nprophet-env: Neural Prophet Environment Connection Utilities

In AlbertoAlmuinha/neuralprophet: 'Neural Prophet' Algorithm

Description

These functions are used for testing and establishing a python environment connection with neuralprophet.

Usage

is_nprophet_activated()

activate_nprophet()

get_python_env()

check_nprophet_dependencies()

detect_default_nprophet_env()

Details

• is_nprophet_activated(): Determines if a Neural Prophet Environment has been activated during library(neuralprophet).

  • If TRUE, then you should be good to go.

  • If FALSE, then a connection between neuralprophet and your neuralprophet Python has not been activated.

• activate_nprophet(): Attempts to activate a connection between neuralprophet and an associated NeuralProphet Python Environment using reticulate::use_condaenv(required = TRUE).

  • It first looks for the system environment variable, 'NPROPHET_PYTHON', for a path to the python executable

  • It next looks for a Conda Environment named 'nprophet' (this is what most users will have)

• get_python_env(): Returns the configuration for the python environment that is being discovered using reticulate::py_discover_config().

• check_nprophet_dependencies(): Checks whether Neural Prophet required python dependencies are present in the currently activated Python Environment.

• detect_default_nprophet_env(): Detects if an 'nprophet' python environment is available.

  • Returns a tibble containing the

  • Returns NULL if an 'nprophet' environment is not detected

See Also

• install_nprophet() - Used to install the python environment needed to run neuralprophet.

Examples

# Returns TRUE if NeuralProphet connection established on package load
is_nprophet_activated()

#

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