Install Guild AI
- Install Guild AI
- Install TensorFlow
- Install optional libraries
- Verify your installation
- Next steps
Guild AI has the following requirements:
- Max OS or Linux
- Python 2.7 or Python 3
Guild is installed from PyPI using
pip. Refer to pip Installation to ensure you have it
Install Guild AI
To install Guild AI, run the following command:
pip install guildai
If you need to run
install with administrative privileges, run:
sudo pip install guildai
Alternatively, install to the user install directory using the
pip install --user guildai
If you want the latest pre-release version of Guild AI, use the
pip install --pre guildai
From source code
This step is an alternative to installing Guild AI with pip described above. Install Guild AI from source code if you want a specific version from GitHub (e.g. an early release or development branch) or if you want to contribute to the project.
Additional required tools for installing from source code:
To install Guild from source, clone the repository by running:
git clone https://github.com/guildai/guildai.git
Change to the
guild directory and install the required pip packages:
cd guild pip install -r requirements.txt
Build Guild by running:
python setup.py build
Verify Guild by running:
If see the message
NOT INSTALLED (No module named 'tensorflow')
that’s okay - you’ll install TensorFlow in the steps below. If you see
other errors, please open an issue on GitHub and we’ll help!
You can run the
GUILD_SOURCE_DIR is the location of your cloned
Guild AI source repository) or modify your environment to make
available on your PATH using one of these methods:
GUILD_SOURCE_DIR/guild/scriptsdirectory to your
PATHenvironment variable, OR
- Create a symlink to
GUILD_SOURCE_DIR/guild/scripts/guildthat is available on your PATH
Guild requires TensorFlow but does not install it for
you. 1 You can use
pip to install TensorFlow by running:
pip install tensorflow
If your system has a GPU, install the GPU enabled package by running:
pip install tensorflow-gpu
For alternative installation methods, refer to Installing TensorFlow.
Install optional libraries
If you system has a GPU or other accelerator supported by TensorFlow, you will need to install and configure support for your hardware.
CUDA and cuDNN
If you have an NVIDIA GPU and and want to use the GPU enabled TensorFlow package, you must install the NVIDIA CUDA and cuDNN libraries for your system. Refer to the links below for help installing the libraries.
NVIDIA System Management Interface
Guild uses NVIDIA System Management Interface (
nvidia‑smi) on GPU
accelerated systems to collect GPU metrics. This tool is optional and
Guild will run without it. However, to collect GPU stats on systems
with one or more GPUs, ensure that
nvidia‑smi is installed.
NVIDIA System Management Interface is typically installed with NVIDIA GPU drivers. Refer to NVIDIA System Management Interface for more information.
Verify your installation
Verify that Guild is installed properly by running the
If there are problems with your installation, Guild will display the details and exit with an error. Refer to Troubleshooting for assistance.
Congratulations, you’ve installed Guild AI! We’ve outlined some next steps for you below.
Guild AI introduction
Start here to learn about projects, models and operations, runs, end-to-end workflow, automated testing and packaging.Guild AI introduction
Discover Guild AI packages
Guild AI provides a catalog of packages with support for state-of-the-art TensorFlow models and supporting utilities.Discover Guild packages
Browse the docs
If you're interested in a complete picture of Guild AI, start by browsing its comprehensives documentation.Browse the docs
TensorFlow is a rapidly evolving software library and is provided as both CPU and GPU supported packages. Guild leaves the specific package and version of TensorFlow up to the user. ↩