UltraRAG

环境要求

• Python 环境（用于安装 UltraRAG 及其依赖）
• uv 0.12.0（README 推荐用于管理环境与依赖）
• Docker（可选，用于容器方式部署）
• 可访问 PyPI 与 Docker Hub 的网络

安装与启动步骤

1. 1安装 uv

   README 强烈推荐用 uv 管理 Python 环境与依赖，可大幅提升安装速度。已安装可跳过。

   pip install uv==0.12.0

   复制

2. 2源码安装全部依赖

   在项目源码根目录执行，[all] 为全量安装，包含所有功能组件。

   uv pip install -e ".[all]"

   复制

3. 3按需安装组件（可选）

   若不需要全部功能，可改为按需安装，README 以 retriever 为例。

   uv pip install -e ".[retriever]"

   复制

4. 4拉取 Docker 镜像

   不想配置本地 Python 环境时改用容器部署，按需选择 CPU 基础版、GPU 基础版或 GPU 完整版。

   docker pull hdxin2002/ultrarag:v0.3.0-base-cpu
   docker pull hdxin2002/ultrarag:v0.3.0-base-gpu
   docker pull hdxin2002/ultrarag:v0.3.0

   复制

5. 5验证安装

   运行官方提供的示例流水线，检查环境是否正常。

   ultrarag run examples/experiments/sayhello.yaml

   复制

6. 6查阅快速开始文档

   官网文档提供从入门到进阶的完整教程示例，可按需查阅学习。

如何确认成功

执行 ultrarag run examples/experiments/sayhello.yaml，若终端输出 “Hello, UltraRAG v3!” 即表示安装成功。

常见问题

注意事项

• README 推荐使用 uv==0.12.0 管理环境与依赖，可显著提升安装速度。
• [all] 表示全量安装，[retriever] 只是按需安装的示例写法。
• Docker 镜像分基础版（CPU/GPU）与完整版（GPU），部署前按硬件条件选择。
• README 节选中未给出 git clone 命令，拉取源码的步骤请参考官方文档。