FlashRAG: 高效检索增强生成研究的模块化工具包

RayRay
FlashRAG检索增强生成Python工具包复现研究自定义组件Github开源项目

FlashRAG简介

FlashRAG是一个为检索增强生成(RAG)研究而设计的Python工具包。随着大型语言模型(LLM)的发展,RAG技术引起了广泛关注,出现了许多新颖的算法和模型来增强RAG系统的各个方面。然而,由于缺乏标准化的实现框架,以及RAG过程本身的复杂性,研究人员很难在一个一致的环境中比较和评估这些方法。为了解决这一挑战,FlashRAG应运而生。

FlashRAG的主要目标是帮助研究人员在一个统一的框架内复现现有的RAG方法,并开发自己的RAG算法。该工具包具有以下特点:

  1. 可扩展和可定制的框架:包含RAG场景所需的基本组件,如检索器、重排器、生成器和压缩器,允许灵活组装复杂的管道。

  2. 全面的基准数据集:收集了32个预处理的RAG基准数据集,用于测试和验证RAG模型的性能。

  3. 预实现的先进RAG算法:基于该框架实现了14种先进的RAG算法,并报告了结果。可以轻松地在不同设置下复现结果。

  4. 高效的预处理阶段:通过提供各种脚本(如用于检索的语料库处理、检索索引构建和文档预检索)简化了RAG工作流程的准备工作。

  5. 优化的执行:使用vLLM和FastChat等工具加速LLM推理,使用Faiss进行向量索引管理,提高了库的效率。

FlashRAG的架构

FlashRAG的整体结构包括三个层次的模块:环境模块、组件模块和管道模块。

  1. 环境模块:是工具包的基础,建立实验所需的数据集、超参数和评估指标。

  2. 组件模块:包括五个主要子组件:判断器、检索器、重排器、精炼器和生成器。

    • 判断器:使用SKR方法评估查询是否需要检索。
    • 检索器:包括稀疏检索和密集检索实现。
    • 重排器:对检索结果进行重新排序,提高相关性。
    • 精炼器:减少检索文档的噪音和token使用,提高最终响应质量。
    • 生成器:使用vLLM和FastChat等加速库实现LLM生成。
  3. 管道模块:处理用户提供的数据,实现并执行相应的RAG过程,提供最终评估输出和中间结果。

FlashRAG支持四类处理流程:

  • 顺序型:RAG过程的线性执行
  • 分支型:对单个查询并行执行多个流程,合并各流程的结果
  • 条件型:使用判断器根据判断结果将查询引导到不同的执行流程
  • 循环型:在检索和生成过程之间进行多次循环以改进结果

FlashRAG架构图

支持的RAG方法

FlashRAG实现了14种RAG方法,采用统一的设置:

  • 生成器:LLAMA3-8B-instruct,输入长度2048
  • 检索器:e5-base-v2作为嵌入模型,每个查询检索5个文档
  • 提示:一致的默认提示模板

这些方法包括:

  • 顺序型:标准RAG、LongLLMLingua、RECOMP等
  • 分支型:SuRe、REPLUG等
  • 条件型:SKR
  • 循环型:Self-RAG、FLARE、IRCoT等

研究人员可以轻松复现这些方法,也可以基于FlashRAG的框架开发新的RAG算法。

基准数据集

FlashRAG收集并处理了35个广泛用于RAG研究的数据集,预处理它们以确保一致的格式,便于使用。这些数据集涵盖了各种任务类型,如问答、多跳问答、长形式问答、多项选择等。所有数据集都可在Hugging Face上获取。

使用FlashRAG

要开始使用FlashRAG,只需从GitHub克隆并安装(需要Python 3.9+):

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

FlashRAG提供了多种使用方式:

  1. 使用现成的管道:配置config并加载相应的管道即可实现RAG过程。

  2. 构建自定义管道:继承BasicPipeline,初始化所需组件,完成run函数即可实现更复杂的RAG过程。

  3. 直接使用组件:如果只想使用某些组件嵌入到原有代码中,可以参考组件的基本介绍了解输入输出格式。

FlashRAG还提供了详细的文档,包括配置指南、复现指南、基线方法详情等,帮助用户更好地使用该工具包。

总之,FlashRAG为RAG研究提供了一个强大而灵活的工具包,可以帮助研究人员更高效地进行RAG相关实验和开发。无论是复现现有方法还是探索新的RAG算法,FlashRAG都能提供有力支持。

编辑推荐精选

openai-agents-python

openai-agents-python

OpenAI Agents SDK,助力开发者便捷使用 OpenAI 相关功能。

openai-agents-python 是 OpenAI 推出的一款强大 Python SDK,它为开发者提供了与 OpenAI 模型交互的高效工具,支持工具调用、结果处理、追踪等功能,涵盖多种应用场景,如研究助手、财务研究等,能显著提升开发效率,让开发者更轻松地利用 OpenAI 的技术优势。

Hunyuan3D-2

Hunyuan3D-2

高分辨率纹理 3D 资产生成

Hunyuan3D-2 是腾讯开发的用于 3D 资产生成的强大工具,支持从文本描述、单张图片或多视角图片生成 3D 模型,具备快速形状生成能力,可生成带纹理的高质量 3D 模型,适用于多个领域,为 3D 创作提供了高效解决方案。

3FS

3FS

一个具备存储、管理和客户端操作等多种功能的分布式文件系统相关项目。

3FS 是一个功能强大的分布式文件系统项目,涵盖了存储引擎、元数据管理、客户端工具等多个模块。它支持多种文件操作,如创建文件和目录、设置布局等,同时具备高效的事件循环、节点选择和协程池管理等特性。适用于需要大规模数据存储和管理的场景,能够提高系统的性能和可靠性,是分布式存储领域的优质解决方案。

TRELLIS

TRELLIS

用于可扩展和多功能 3D 生成的结构化 3D 潜在表示

TRELLIS 是一个专注于 3D 生成的项目,它利用结构化 3D 潜在表示技术,实现了可扩展且多功能的 3D 生成。项目提供了多种 3D 生成的方法和工具,包括文本到 3D、图像到 3D 等,并且支持多种输出格式,如 3D 高斯、辐射场和网格等。通过 TRELLIS,用户可以根据文本描述或图像输入快速生成高质量的 3D 资产,适用于游戏开发、动画制作、虚拟现实等多个领域。

ai-agents-for-beginners

ai-agents-for-beginners

10 节课教你开启构建 AI 代理所需的一切知识

AI Agents for Beginners 是一个专为初学者打造的课程项目,提供 10 节课程,涵盖构建 AI 代理的必备知识,支持多种语言,包含规划设计、工具使用、多代理等丰富内容,助您快速入门 AI 代理领域。

AEE

AEE

AI Excel全自动制表工具

AEE 在线 AI 全自动 Excel 编辑器,提供智能录入、自动公式、数据整理、图表生成等功能,高效处理 Excel 任务,提升办公效率。支持自动高亮数据、批量计算、不规则数据录入,适用于企业、教育、金融等多场景。

UI-TARS-desktop

UI-TARS-desktop

基于 UI-TARS 视觉语言模型的桌面应用,可通过自然语言控制计算机进行多模态操作。

UI-TARS-desktop 是一款功能强大的桌面应用,基于 UI-TARS(视觉语言模型)构建。它具备自然语言控制、截图与视觉识别、精确的鼠标键盘控制等功能,支持跨平台使用(Windows/MacOS),能提供实时反馈和状态显示,且数据完全本地处理,保障隐私安全。该应用集成了多种大语言模型和搜索方式,还可进行文件系统操作。适用于需要智能交互和自动化任务的场景,如信息检索、文件管理等。其提供了详细的文档,包括快速启动、部署、贡献指南和 SDK 使用说明等,方便开发者使用和扩展。

Wan2.1

Wan2.1

开源且先进的大规模视频生成模型项目

Wan2.1 是一个开源且先进的大规模视频生成模型项目,支持文本到图像、文本到视频、图像到视频等多种生成任务。它具备丰富的配置选项,可调整分辨率、扩散步数等参数,还能对提示词进行增强。使用了多种先进技术和工具,在视频和图像生成领域具有广泛应用前景,适合研究人员和开发者使用。

爱图表

爱图表

全流程 AI 驱动的数据可视化工具,助力用户轻松创作高颜值图表

爱图表(aitubiao.com)就是AI图表,是由镝数科技推出的一款创新型智能数据可视化平台,专注于为用户提供便捷的图表生成、数据分析和报告撰写服务。爱图表是中国首个在图表场景接入DeepSeek的产品。通过接入前沿的DeepSeek系列AI模型,爱图表结合强大的数据处理能力与智能化功能,致力于帮助职场人士高效处理和表达数据,提升工作效率和报告质量。

Qwen2.5-VL

Qwen2.5-VL

一款强大的视觉语言模型,支持图像和视频输入

Qwen2.5-VL 是一款强大的视觉语言模型,支持图像和视频输入,可用于多种场景,如商品特点总结、图像文字识别等。项目提供了 OpenAI API 服务、Web UI 示例等部署方式,还包含了视觉处理工具,有助于开发者快速集成和使用,提升工作效率。

下拉加载更多