RAG-Retrieval

RAG-Retrieval 提供了全链路的RAG检索模型微调(train)和推理(infer)以及蒸馏(distill)代码。

对于微调，支持微调任意开源的RAG检索模型，包括向量模型（图a,bert-based,llm-based embedding）、迟交互式模型（图d,colbert）、重排序模型（图c,bert-based, llm-based reranker）。
对于推理，RAG-Retrieval专注于重排序(reranker)，开发了一个轻量级的python库rag-retrieval,提供统一的方式调用任意不同的RAG排序模型。
对于蒸馏，支持向量模型和排序模型的蒸馏，可以从较大的模型蒸馏到较小的模型（0.5b llm or bert-base)中。

社区交流

加入我们微信群聊

项目特色

简单且优雅: 拒绝复杂的封装，简单易懂的代码结构，方便修改。
支持全链路的RAG检索模型微调: 向量(bert-based,llm-based),迟交互模型(colbert),重排序模型(bert-based,llm-based)。
支持微调任意开源的RAG检索模型: 支持大部分开源的embedding和reranker模型，例如：bge(bge-embedding,bge-m3,bge-reranker),bce(bce-embedding,bce-reranker),gte(gte-embedding,gte-multilingual-reranker-base)。
支持将较大的检索模型蒸馏为较小的模型: 支持将较大的基于LLM的 reranker 和 embedding 模型蒸馏到较小的检索模型中（例如，0.5B LLM 或 BERT）。
先进算法: 对于embedding模型，支持MRL算法来缩减输出向量的维度，支持Stella 模型先进的蒸馏方法。
多卡训练策略: deepspeed,fsdp。

快速开始

安装

对于训练(all)：

conda create -n rag-retrieval python=3.8 && conda activate rag-retrieval
#为了避免自动安装的torch与本地的cuda不兼容，建议进行下一步之前先手动安装本地cuda版本兼容的torch。
pip install -r requirements.txt

对于预测(reranker):

#为了避免自动安装的torch与本地的cuda不兼容，建议进行下一步之前先手动安装本地cuda版本兼容的torch。
pip install rag-retrieval

训练

对于不同的模型类型，请进入不同的子目录。例如：对于embedding,其他同理。详细的流程可参考模型目录下的readme.

cd ./rag_retrieval/train/embedding
bash train_embedding.sh

预测

RAG-Retrieval开发了一个轻量级的python库rag-retrieval,提供统一的方式调用任意不同的RAG排序模型，具有以下的特点。

支持多种排序模型：支持常见的开源排序模型(Cross Encoder Reranker,Decoder-Only 的LLM Reranker)
长doc友好：支持两种不同的对于长doc的处理逻辑(最大长度截断，切分取最大分值)。
益于扩展：如果有新的排序模型，用户只需要继承basereranker，并且实现rank以及comput_score函数即可。

rag-retrieval包详细的使用方法和注意事项可以参考Tutorial

实验结果

reranker模型在 MTEB Reranking 任务的结果

Model	Model Size(GB)	T2Reranking	MMarcoReranking	CMedQAv1	CMedQAv2	Avg
bge-reranker-base	1.11	67.28	35.46	81.27	84.10	67.03
bce-reranker-base_v1	1.11	70.25	34.13	79.64	81.31	66.33
rag-retrieval-reranker	0.41	67.33	31.57	83.54	86.03	67.12

其中，rag-retrieval-reranker是我们使用RAG-Retrieval代码在hfl/chinese-roberta-wwm-ext模型上训练所得，训练数据使用bge-rerank模型的训练数据.

colbert模型在 MTEB Reranking 任务的结果

Model	Model Size(GB)	Dim	T2Reranking	MMarcoReranking	CMedQAv1	CMedQAv2	Avg
bge-m3-colbert	2.24	1024	66.82	26.71	75.88	76.83	61.56
rag-retrieval-colbert	0.41	1024	66.85	31.46	81.05	84.22	65.90

其中，rag-retrieval-colbert是我们使用RAG-Retrieval代码在hfl/chinese-roberta-wwm-ext模型上训练所得，训练数据使用bge-rerank模型的训练数据.

用领域内数据微调开源的BGE系列模型

Model	T2ranking
bge-v1.5-embedding	66.49
bge-v1.5-embedding finetune	67.15	+0.66
bge-m3-colbert	66.82
bge-m3-colbert finetune	67.22	+0.40
bge-reranker-base	67.28
bge-reranker-base finetune	67.57	+0.29

后面带有finetune的代表我们使用RAG-Retrieval在对应开源模型的基础上继续微调所得，训练数据使用T2-Reranking的训练集。

值得注意的是bge的三种开源模型，训练集中已经包含了T2-Reranking，并且该数据较为通用，因此使用该数据继续微调的性能提升效果不大，但是如果使用垂直领域的数据集继续微调开源模型，性能提升会更大。

Acknowledge

在开发过程中，我们借鉴或基于以下项目，衷心感谢这些团队为开源做出的贡献。

FlagEmbedding
uniem
sentence-transformers
rerankers

Star History

License

RAG-Retrieval is licensed under the MIT License.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!