🌍 README 翻译

中文说明 | 日本語

🎉 新闻

• [2025.02.27]🎯📢现在你可以使用 pip install minirag-hku 来运行我们的代码了！
• [2025.02.14]🎯📢现在 MiniRAG 支持 10 多种异构图数据库，包括 Neo4j、PostgreSQL、TiDB 等。情人节快乐！🌹🌹🌹
• [2025.02.05]🎯📢我们的团队发布了 VideoRAG，用于理解超长上下文视频。
• [2025.02.01]🎯📢现在 MiniRAG 支持 API 和 Docker 部署。更多详情请参阅 这里。

TLDR

MiniRAG 是一个极简的检索增强生成框架，它通过异构图索引和轻量级拓扑增强检索，使小型模型也能获得良好的 RAG 性能。

摘要

对高效、轻量级检索增强生成（RAG）系统的需求日益增长，这凸显了在现有 RAG 框架中部署小型语言模型（SLM）时面临的重大挑战。当前的方法由于 SLM 的语义理解和文本处理能力有限，性能会严重下降，从而阻碍了其在资源受限场景中的广泛应用。为了解决这些根本性限制，我们提出了 MiniRAG，这是一种专为极致简单性和效率而设计的新型 RAG 系统。MiniRAG 引入了两项关键技术革新：(1) 一种语义感知的异构图索引机制，将文本片段和命名实体整合到统一的结构中，从而减少对复杂语义理解的依赖；(2) 一种轻量级的拓扑增强检索方法，利用图结构进行高效的知识发现，而无需高级的语言能力。我们的大量实验表明，即使使用 SLM，MiniRAG 也能达到与基于 LLM 的方法相当的性能，同时仅需 25% 的存储空间。此外，我们还贡献了一个全面的基准数据集 LiHua-World，用于在复杂的查询条件下评估设备端轻量级 RAG 系统。

MiniRAG 框架

MiniRAG 采用了一种精简的工作流程，其核心组件是异构图索引和基于图的轻量级知识检索。这种架构解决了设备端 RAG 系统所面临的独特挑战，兼顾了效率和效果。

安装

• 从源码安装（推荐）

cd MiniRAG
pip install -e .

• 从 PyPI 安装（我们的代码基于 LightRAG，因此可以直接安装）

pip install lightrag-hku

快速开始

• 所有代码都可以在 ./reproduce 中找到。
• 下载你需要的数据集。
• 将数据集放入 ./dataset 目录。
• 注意：我们已经将 LiHua-World 数据集放在 ./dataset/LiHua-World/data/ 中，文件名为 LiHuaWorld.zip。如果你想使用其他数据集，可以将其放入 ./dataset/xxx。

然后使用以下 Bash 命令来索引数据集：

python ./reproduce/Step_0_index.py
python ./reproduce/Step_1_QA.py

或者，使用 ./main.py 中的代码来初始化 MiniRAG。

整体性能表

模型	NaiveRAG		GraphRAG		LightRAG		MiniRAG
	acc↑	err↓	acc↑	err↓	acc↑	err↓	acc↑	err↓
LiHua-World
Phi-3.5-mini-instruct	41.22%	23.20%	/	/	39.81%	25.39%	53.29%	23.35%
GLM-Edge-1.5B-Chat	42.79%	24.76%	/	/	35.74%	25.86%	52.51%	25.71%
Qwen2.5-3B-Instruct	43.73%	24.14%	/	/	39.18%	28.68%	48.75%	26.02%
MiniCPM3-4B	43.42%	17.08%	/	/	35.42%	21.94%	51.25%	21.79%
gpt-4o-mini	46.55%	19.12%	35.27%	37.77%	56.90%	20.85%	54.08%	19.44%
MultiHop-RAG
Phi-3.5-mini-instruct	42.72%	31.34%	/	/	27.03%	11.78%	49.96%	28.44%
GLM-Edge-1.5B-Chat	44.44%	24.26%	/	/	/	/	51.41%	23.44%
Qwen2.5-3B-Instruct	39.48%	31.69%	/	/	21.91%	13.73%	48.55%	33.10%
MiniCPM3-4B	39.24%	31.42%	/	/	19.48%	10.41%	47.77%	26.88%
gpt-4o-mini	53.60%	27.19%	60.92%	16.86%	64.91%	19.37%	68.43%	19.41%

表格中，“/”表示该方法难以生成有效响应。

复现

所有代码都可以在 ./reproduce 目录下找到。

代码结构

├── dataset
│   └── LiHua-World
│       ├── README.md
│       ├── README_CN.md
│       ├── data
│       │   ├── LiHuaWorld.zip
│       └── qa
│           ├── query_set.csv
│           └── query_set.json
├── minirag
│   ├── kg
│   │   ├── __init__.py
│   │   ├── neo4j_impl.py
│   │   └── oracle_impl.py
│   ├── __init__.py
│   ├── base.py
│   ├── exceptions.py
│   ├── llm.py
│   ├── minirag.py
│   ├── operate.py
│   ├── prompt.py
│   ├── storage.py
│   └── utils.py
├── reproduce
│   ├── Step_0_index.py
│   └── Step_1_QA.py
├── LICENSE
├── main.py
├── README.md
├── README_CN.md
├── requirements.txt
├── setup.py

数据集：LiHua-World

LiHua-World 是一个专门为设备端 RAG 场景设计的数据集，包含一位名为 LiHua 的虚拟用户一年的聊天记录。该数据集包括单跳、多跳和摘要三种类型的提问，每道题都配有手动标注的答案和相关文档。更多详细信息，请参阅 LiHua-World 数据集的 README。

星标历史

贡献

感谢所有贡献者！

致谢

您可以参考作为我们框架和代码库基础的相关工作， nano-graphrag 和 LightRAG。感谢他们出色的工作。

🌟引用

@article{fan2025minirag,
  title={MiniRAG：迈向极其简单的检索增强生成},
  author={Fan, Tianyu and Wang, Jingyuan and Ren, Xubin and Huang, Chao},
  journal={arXiv 预印本 arXiv:2501.06713},
  year={2025}
}

感谢您对我们工作的关注！

pip install minirag-hku

git clone https://github.com/HKUDS/MiniRAG.git
cd MiniRAG
pip install -e .

python ./reproduce/Step_0_index.py

python ./reproduce/Step_1_QA.py

from minirag import MiniRAG

# 初始化 MiniRAG
rag = MiniRAG(
    working_dir="./data_demo", # 工作目录，用于存储索引
    # 其他参数可根据需要配置
)

# 插入文档
rag.insert("您的文档内容或文件路径")

# 执行查询
response = rag.query("您的问题")
print(response)