Skip to content

Latest commit

 

History

History
95 lines (80 loc) · 4.58 KB

README-zh.md

File metadata and controls

95 lines (80 loc) · 4.58 KB

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

| 介绍视频 | README (english) | 文档 | 检索器 | 示例 |

FlexRAG 是一个创新的开源框架,旨在简化 RAG(检索增强生成)系统的快速复现、开发和评估。它全面支持多种 RAG 场景,包括 基于文本的、多模态的以及可通过 Web 访问的 RAG 。借助从数据准备到系统评估的端到端流水线,FlexRAG 能够帮助研究人员高效地与社区共享他们的工作,并快速基于自己的算法开发演示原型。

📖 目录

✨ 框架特色

📢 最新消息

  • 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}
}

❤️ 致谢

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