Skip to content

Latest commit

 

History

History
110 lines (74 loc) · 4.23 KB

installation-guide.md

File metadata and controls

110 lines (74 loc) · 4.23 KB
Raw

Installation Guide

This guide will walk you through installing NeMo Guardrails, and it will cover:

  1. Setting up a fresh virtual environment.
  2. Installing using pip.
  3. Installing from Source Code.
  4. Optional dependencies.
  5. Using Docker.

Prerequisites

Python 3.8, 3.9 or 3.10.

Additional dependencies

NeMo Guardrails uses annoy, which is a C++ library with Python bindings. To install it, you need to have a valid C++ runtime on your computer. Most systems already have installed a C++ runtime. If annoy installation fails, check the following steps:

  • For a Linux or Mac / Unix-based OS:
    • First install gcc and g++ using apt-get install gcc g++.
    • Then update the following environment variables: export CC=<path_to_clang> and export CXX=<path_to_clang++> (usually, <path_to_clang> is /usr/bin/clang).
    • In some cases, you might also need to install the python-dev package using apt-get install python-dev (or apt-get install python3-dev). Check out this thread if the error persists.
  • For Windows:
    • Install Microsoft C++ Build Tools. This should install Microsoft Visual C++ (version 14.0 or greater is required by latest version of annoy).

Setting up a virtual environment

If you want to experiment with NeMo Guardrails from scratch, we recommend using a fresh virtual environment. Otherwise, you can skip to the following subsection.

  1. First, create a folder for your project, e.g., my_assistant.
> mkdir my_assistant
> cd my_assistant
  1. Create a virtual environment.
> python3 -m venv venv
  1. Activate the virtual environment.
> source venv/bin/activate

Installation using pip

To install NeMo Guardrails using pip:

> pip install nemoguardrails

Installing from source code

NeMo Guardrails is under active development and the main branch will always contain the latest development version. To install from source, you first need to clone the repository:

git clone https://github.com/NVIDIA/NeMo-Guardrails.git

Next, you need to install the package locally:

cd NeMo-Guardrails
pip install -e .

Optional dependencies

If you want to use OpenAI, also install the openai package with the latest version supported by Nemo Guardrails as shown below. And make sure that you have the OPENAI_API_KEY environment variable set.

> pip install openai==0.28.1
> export OPENAI_API_KEY=...

Some NeMo Guardrails LLMs and features have specific installation requirements, including a more complex set of steps (e.g. AlignScore fact-checking, using Llama-2). For each feature or LLM example, check the readme files associated with it.

Extra dependencies

The nemoguardrails package also defines the following extra dependencies:

  • dev: packages required by some extra Guardrails features for developers (e.g. autoreload feature).
  • eval: packages used for the Guardrails evaluation tools.
  • openai: installs the latest openai package supported by NeMo Guardrails.
  • sdd: packages used by the sensitive data detector integrated in NeMo Guardrails.
  • all: installs all extra packages.

To keep the footprint of nemoguardrails as small as possible, these are not installed by default. To install any of the extra dependency you can use pip as well. For example, to install the dev extra dependencies, run the following command:

> pip install nemoguardrails[dev]

Using Docker

NeMo Guardrails can also be used through Docker. For details on how to build and use the Docker image check out this guide.

What's next?