Skip to content

Latest commit

 

History

History
91 lines (76 loc) · 5.36 KB

README-zh.md

File metadata and controls

91 lines (76 loc) · 5.36 KB

Language Code Style Imports: isort github license Read the Docs Read the Docs PyPI - Version DOI

[ English | 中文 ]

FlexRAG 是一个具备高可复现性、易上手且性能优越的检索增强生成(Retrieval Augmented Generation, RAG)框架,专为科研与原型开发而设计。它支持文本多模态以及网络 RAG,提供完整的 RAG 流水线与评估流程,开箱即用,同时具备高效的异步处理持久化缓存能力,助力快速搭建强大的 RAG 解决方案。

📖 目录

✨ 框架特色

  • 🎯高可复现性:FlexRAG 附带了伴生仓库 flexrag_examples,为各类 RAG 算法提供详尽的复现案例;同时,在 HuggingFace Hub 上统一提供的检索器,确保您在相同环境下轻松复现实验结果。
  • 低上手难度:一键下载并加载 HuggingFace Hub 上的检索器,免除了繁琐的构建流程;此外,FlexRAG 对默认配置进行了精心优化,使您在默认参数下就能获得出色性能,从而简化开发流程。
  • 🌍多样化应用场景:FlexRAG 不仅适用于文本 RAG,还支持多模态及网络 RAG,为不同数据类型提供了广泛的应用可能。
  • 🧪科研优先:为各类 RAG 任务提供统一评估流程,助您在不同数据集上轻松测试;同时,提供官方基准测试方便对比和查阅。
  • 卓越性能:利用持久化缓存和异步函数,助力高性能 RAG 开发。
  • 🔄全流程支持:从文档信息提取、切分到检索与生成,再到生成质量评估,FlexRAG 完备支持 RAG 全生命周期的各个环节。
  • 🛠️模块化灵活设计:采用轻量级模块化架构,FlexRAG 支持多种开发模式,助您快速构建专属 RAG 解决方案。

📢 最新消息

  • 2025-03-24: 中文文档上线啦!请访问 文档 查看。
  • 2025-02-25: FlexRAG 的 LocalRetriever 现在支持从 HuggingFace Hub 上加载啦!
  • 2025-01-22: 新的命令行入口 run_retriever 以及大量新的信息检索指标(如 RetrievalMAP )现已上线,请阅读文档以获取更多信息。
  • 2025-01-08: FlexRAG 现已支持 Windows 系统,您可以直接通过 pip install flexrag 来安装。
  • 2025-01-08: FlexRAG 在单跳QA数据集上的基准测试现已公开,详情请参考 benchmarks 页面。
  • 2025-01-05: FlexRAG 的文档现已上线。

🚀 框架入门

pip 安装 FlexRAG:

pip install flexrag

访问我们的文档以了解更多信息。

🏗️ FlexRAG 架构

FlexRAG 采用模块化架构设计,让您可以轻松定制和扩展框架以满足您的特定需求。下图说明了 FlexRAG 的架构:

📊 基准测试

我们利用 FlexRAG 进行了大量的基准测试,详情请参考 benchmarks 页面。

🏷️ 许可证

本仓库采用 MIT License 开源协议. 详情请参考 LICENSE 文件。

🖋️ 引用

如果您在研究中使用了 FlexRAG,请引用我们的项目:

@software{Zhang_FlexRAG_2025,
author = {Zhang, Zhuocheng and Feng, Yang and Zhang, Min},
doi = {10.5281/zenodo.14593327},
month = jan,
title = {{FlexRAG}},
url = {https://github.com/ictnlp/FlexRAG},
year = {2025}
}

❤️ 致谢

下面的开源项目对本项目有所帮助: