Guardrails

环境要求

• Python 3.10、3.11、3.12 或 3.13
• 可用的 pip 包管理环境
• 一个 guardrails 配置目录（含 config.yml，可选 config.py、actions.py）
• 如需 Docker 部署：本地已安装 Docker（README 提供 Dockerfile）

安装与启动步骤

1. 1检查 Python 版本

   Guardrails 要求 Python 3.10~3.13，版本不符需先升级或切换虚拟环境后再安装。

   python --version

   复制

2. 2安装 nemoguardrails

   使用 pip 从 PyPI 安装官方包，无需克隆仓库；建议在虚拟环境中安装。

   pip install nemoguardrails

   复制

3. 3准备配置目录

   按标准结构创建配置文件夹：config.yml 放通用配置，config.py 放初始化代码，actions.py 放自定义 Python action。

4. 4编写 config.yml

   在配置文件中声明要使用的 LLM 模型、需要启用的 rails 以及自定义配置数据；不配置任何 rail 时会直接转发请求给 LLM。

5. 5用 Python API 调用

   通过 RailsConfig.from_path 加载配置并创建 LLMRails 实例，再用 generate 方法发起对话，输入输出格式与 Chat Completions API 类似。

   from nemoguardrails import LLMRails, RailsConfig
   
   config = RailsConfig.from_path("PATH/TO/CONFIG")
   rails = LLMRails(config)
   
   completion = rails.generate(
       messages=[{"role": "user", "content": "Hello world!"}]
   )
   print(completion)

   复制

6. 6按需关闭遥测

   库默认会收集匿名使用统计；如不希望上报，设置该环境变量即可关闭。

   export NEMO_GUARDRAILS_NO_USAGE_STATS=1

   复制

关键配置

如何确认成功

运行 rails.generate 后应返回类似 {"role": "assistant", "content": "Hi! How can I help you?"} 的回复。

常见问题

注意事项

• README 只给出 pip 安装方式，其他安装细节需查阅官方 Installation Guide。
• 标准配置目录结构为 config.yml、config.py、actions.py、rails.co 等文件组成的 config 文件夹。
• 遥测事件会尽力写入本地审计文件 ~/.config/nemoguardrails/usage_stats.json。
• 官方文档：https://docs.nvidia.com/nemo/guardrails/latest/index.html