FlashRAG

环境要求

• Python 3.10+（源码克隆安装时要求）
• pip 包管理工具
• git（用于克隆仓库）
• conda（可选，用于安装 faiss）
• 可选 GPU 环境（安装 vllm 等加速组件时使用）

安装与启动步骤

1. 1pip 快速安装

   无需下载源码，直接用 pip 安装 FlashRAG 预发布版本，适合只想调用工具包的用户。

   pip install flashrag-dev --pre

   复制

2. 2克隆源码安装

   需要改代码或开发时使用；克隆后进入目录以可编辑模式安装，需 Python 3.10+。

   git clone https://github.com/RUC-NLPIR/FlashRAG.git
   cd FlashRAG
   pip install -e .

   复制

3. 3安装全部额外依赖

   README 提供了一键安装 full 依赖的方式，适用于不想逐个挑选组件的场景。

   pip install flashrag-dev[full]

   复制

4. 4按需安装可选组件

   想加速推理装 vllm，想用向量检索模型装 sentence-transformers，想用 BM25 装 pyserini。

   pip install vllm>=0.4.1
   pip install sentence-transformers
   pip install pyserini

   复制

5. 5确认安装结果

   上述安装命令执行完毕且无报错即安装成功；faiss 无法用 pip 安装，需按 README 用 conda 命令单独安装。

如何确认成功

安装命令全部执行成功且无报错，环境中已存在 flashrag-dev 包即可开始使用。

常见问题

注意事项

• README 节选中 faiss 的 conda 安装命令被截断，请到官方仓库 Installation 章节获取完整命令，不要凭猜测执行。
• pip 安装使用的是预发布版本，命令中带 --pre 参数。
• 项目采用 MIT 许可证，可自由用于研究用途。
• 本次节选未包含 Quick Start 的详细使用说明，实际跑实验请参考官方仓库文档。