安装指南#

本指南将引导您完成以下步骤来安装 NeMo Guardrails

  1. 设置全新的虚拟环境。

  2. 使用 pip 安装。

  3. 从源代码安装。

  4. 可选依赖项。

  5. 使用 Docker。

先决条件#

  • Python 3.9、3.10 或 3.11

其他依赖项#

NeMo Guardrails 使用 annoy，这是一个带有 Python 绑定的 C++ 库。 要安装它，您需要在计算机上安装有效的 C++ 运行时。 大多数系统已经安装了 C++ 运行时。 如果由于缺少 C++ 运行时导致 annoy 安装失败，您可以按如下方式安装 C++ 运行时

在 Linux、Mac 或基于 Unix 的操作系统上安装 C++ 运行时#

  1. 使用 apt-get install gcc g++ 安装 gcc 和 g++。

  2. 更新以下环境变量： export CC=path_to_clang 和 export CXX=path_to_clang（通常，path_to_clang 是 /usr/bin/clang）。

  3. 在某些情况下，您可能还需要使用 apt-get install python-dev（或 apt-get install python3-dev）安装 python-dev 包。 如果错误仍然存在，请查看此帖子。

在 Windows 上安装 C++ 运行时#

安装 Microsoft C++ 生成工具。 这将安装 Microsoft Visual C++（最新版本的 annoy 需要 14.0 或更高版本）。

设置虚拟环境#

要从头开始试用 NeMo Guardrails，请使用全新的虚拟环境。 否则，您可以跳到下一节。

在 Linux、Mac 或基于 Unix 的操作系统上设置虚拟环境#

  1. 为您的项目创建一个文件夹，例如 *my_assistant*。

mkdir my_assistant
cd my_assistant

  1. 创建一个虚拟环境。

python3 -m venv venv

  1. 激活虚拟环境。

source venv/bin/activate

在 Windows 上设置虚拟环境#

  1. 打开一个新的 CMD 提示符 (Windows 键 + R, **cmd.exe**)

  2. 使用命令 pip install virtualenv 安装 virtualenv

  3. 使用命令 pip --version 检查是否已安装 virtualenv。

  4. 使用命令 pip install virtualenvwrapper-win 安装 virtualenvwrapper-win。

使用 mkvirtualenv *name* 命令激活名为 *name* 的新虚拟环境。

安装 NeMo Guardrails#

使用 **pip** 安装 NeMo Guardrails

pip install nemoguardrails

从源代码安装#

NeMo Guardrails 正在积极开发中，主分支始终包含最新的开发版本。 要从源代码安装

  1. 克隆存储库

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

  2. 在本地安装软件包

    cd NeMo-Guardrails
pip install -e .

额外的依赖项#

nemoguardrails 包还定义了以下额外的依赖项

  • dev：开发人员某些额外的 Guardrails 功能所需的软件包，例如 **autoreload** 功能。

  • eval：用于 Guardrails 评估工具的软件包。

  • openai：安装 NeMo Guardrails 支持的最新 openai 包。

  • sdd：敏感数据检测器集成到 NeMo Guardrails 中使用的软件包。

  • all：安装所有额外的软件包。

为了尽可能缩小 nemoguardrails 的占用空间，默认情况下不安装这些软件包。 要安装任何额外的依赖项，您也可以使用 **pip**。 例如，要安装 dev 额外的依赖项，请运行以下命令

> pip install nemoguardrails[dev]

可选依赖项#

警告

如果在运行 pip install nemoguardrails[all] 时 pip 无法解析依赖项，您应该直接在 pip install 命令中指定其他约束。

示例命令

pip install "nemoguardrails[all]" "pandas>=1.4.0,<3"

要使用 OpenAI，只需使用 openai 额外的依赖项，以确保安装所有必需的软件包。 确保设置了 OPENAI_API_KEY 环境变量，如以下示例所示，其中 *YOUR_KEY* 是您的 OpenAI 密钥。

pip install nemoguardrails[openai]
export OPENAI_API_KEY=YOUR_KEY

某些 NeMo Guardrails LLM 和功能具有特定的安装要求，包括更复杂的一组步骤。 例如，AlignScore 事实检查，使用 Llama-2 需要两个额外的软件包。 对于每个功能或 LLM 示例，请检查与其关联的 readme 文件。

使用 Docker#

NeMo Guardrails 也可以通过 Docker 使用。 有关如何构建和使用 Docker 镜像的详细信息，请参阅 带有 Docker 的 NeMo Guardrails。

下一步是什么？#