Install guildai core — install

This installs the guild executable for use by the R package. It creates an isolated python virtual environment private to the R package and installs guildai into it. Repeated calls to install_guild() result in a fresh installation.

Usage

install_guild(guildai = "guildai", python = find_python())

Arguments

guildai: Character vector of arguments passed directly to pip install. To install the release version of guildai, this can be "guildai". Special values of "release" and "dev" are also accepted.
python: Path to a python binary, used to create a private isolated venv.

Value

path to the guild executable

Details

It requires that a suitable python version is available on the system.

Note

install_guild() installs guild as an isolated VM. For guild to run a python operation, the python package guildai must be installed in the python library where it will be used, E.g., with pip install guildai or reticulate::py_install().

Examples

if (FALSE) {
## Install release version:
install_guild()

## Install release version using a specific python
# path_to_python <- reticulate::install_python() # path to python executable
install_guild("guildai", python = path_to_python)

## Install development version
install_guild(guildai = "dev", python = path_to_python)

## Install development version from URL
 install_guild(
   guildai = "https://api.github.com/repos/guildai/guildai/tarball/HEAD",
   python = path_to_python)

## Install local development version:
install_guild(c("-e", "~/guild/guildai"))
}