UR-2.0 提供了用户友好的安装方式,用户仅需几条命令即可完成基础环境的搭建。同时,UR-2.0 支持按需加载的模块化依赖体系,便于灵活扩展所需功能组件,避免冗余安装。

Step 1:安装前准备

使用 Conda 创建虚拟环境:
conda create -n ultrarag python=3.11
conda activate ultrarag
没有安装 Conda ?前往 安装 Miniconda
我们推荐使用 uv 来进行包管理,提供更快、更可靠的 Python 依赖管理体验:
pip install uv

Step2:安装基础环境

我们将逐步支持 PyPI 与 Conda 发行
通过 git 克隆项目到本地或服务器:
git clone https://github.com/OpenBMB/UltraRAG.git
cd UltraRAG
使用 Conda 创建虚拟环境并安装基础依赖:
uv pip install -e .

Step3:验证安装

运行以下命令测试是否安装成功:
ultrarag run examples/sayhello.yaml
若环境无误,终端将输出欢迎信息:

Step4:按需安装扩展组件

UR-2.0支持丰富的Server组件,开发者可根据实际任务灵活安装所需依赖:
# 如需使用faiss进行向量索引:
# 需要根据自己的硬件环境,手动编译安装不同版本的 FAISS
# 安装 faiss-cpu
conda install -c pytorch faiss-cpu
# 安装 faiss-gpu
conda install -c pytorch faiss-gpu

# 如需使用infinity_emb进行语料库编码和索引:
uv pip install -e ."[infinity_emb]"

# 如需使用lancedb向量数据库:
uv pip install -e ."[lancedb]"

# 如需使用vLLM服务部署模型:
uv pip install -e ."[vllm]"

# 如需使用语料库文档解析功能:
uv pip install -e ."[corpus]"

# 安装所有依赖(除faiss)
uv pip install -e ."[all]"