|
1 | 1 | # Installation Guide |
2 | 2 |
|
3 | | -This guide walks you through the following steps to install NeMo Guardrails: |
| 3 | +This guide walks you through the following steps to install the NeMo Guardrails SDK: |
4 | 4 |
|
5 | 5 | 1. Setting up a fresh virtual environment. |
6 | 6 | 2. Installing using `pip`. |
7 | 7 | 3. Installing from Source Code. |
8 | 8 | 4. Optional dependencies. |
9 | 9 | 5. Using Docker. |
10 | 10 |
|
11 | | -## Prerequisites |
| 11 | +## Requirements |
| 12 | + |
| 13 | +Review the following requirements to install the NeMo Guardrails SDK. |
| 14 | + |
| 15 | +### Hardware Requirements |
| 16 | + |
| 17 | +The NeMo Guardrails SDK runs on CPUs. This SDK adds a layer to manage processes between your application front-end and the backend LLM and does not require any GPUs. |
| 18 | + |
| 19 | +### Software Requirements |
12 | 20 |
|
13 | 21 | - Python 3.9, 3.10, or 3.11 |
14 | 22 |
|
15 | | -## Additional dependencies |
| 23 | +### Additional Dependencies |
16 | 24 |
|
17 | 25 | NeMo Guardrails uses [annoy](https://github.com/spotify/annoy), which is a C++ library with Python bindings. To install it, you need to have a valid C++ runtime on your computer. |
18 | 26 | Most systems already have installed a C++ runtime. If the **annoy** installation fails due to a missing C++ runtime, you can install a C++ runtime as follows: |
19 | 27 |
|
20 | | -### Installing a C++ runtime on Linux, Mac, or Unix-based OS |
| 28 | +#### Installing a C++ runtime on Linux, Mac, or Unix-based OS |
21 | 29 |
|
22 | 30 | 1. Install `gcc` and `g++` using `apt-get install gcc g++`. |
23 | 31 | 2. Update the following environment variables: `export CC=`*path_to_clang* and `export CXX=`*path_to_clang* (usually, *path_to_clang* is */usr/bin/clang*). |
24 | 32 | 3. 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](https://stackoverflow.com/questions/21530577/fatal-error-python-h-no-such-file-or-directory) if the error persists. |
25 | 33 |
|
26 | | -### Installing a C++ runtime on Windows |
| 34 | +#### Installing a C++ runtime on Windows |
27 | 35 |
|
28 | 36 | Install the [Microsoft C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/). This installs Microsoft Visual C++ (version 14.0 or greater is required by the latest version of **annoy**). |
29 | 37 |
|
|
0 commit comments