Skip to content

Commit d78749c

Browse files
miyoungctgasser-nv
authored andcommitted
docs: add hardware reqs (#1411)
1 parent d980703 commit d78749c

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

docs/getting-started/installation-guide.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,37 @@
11
# Installation Guide
22

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:
44

55
1. Setting up a fresh virtual environment.
66
2. Installing using `pip`.
77
3. Installing from Source Code.
88
4. Optional dependencies.
99
5. Using Docker.
1010

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
1220

1321
- Python 3.9, 3.10, or 3.11
1422

15-
## Additional dependencies
23+
### Additional Dependencies
1624

1725
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.
1826
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:
1927

20-
### Installing a C++ runtime on Linux, Mac, or Unix-based OS
28+
#### Installing a C++ runtime on Linux, Mac, or Unix-based OS
2129

2230
1. Install `gcc` and `g++` using `apt-get install gcc g++`.
2331
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*).
2432
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.
2533

26-
### Installing a C++ runtime on Windows
34+
#### Installing a C++ runtime on Windows
2735

2836
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**).
2937

0 commit comments

Comments
 (0)