Merge pull request #72 from Anooyman/main

Add RAG README.md
This commit is contained in:
xzw 2024-03-16 18:39:22 +08:00 committed by GitHub
commit 031b8ebc0b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 103 additions and 6 deletions

View File

@ -15,6 +15,8 @@
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Issues][issues-shield]][issues-url]
[![OpenXLab_App][OpenXLab_App-image]][OpenXLab_App-url]
[![OpenXLab_Model][OpenXLab_Model-image]][OpenXLab_Model-url]
[![MIT License][license-shield]][license-url]
[![Stargazers][stars-shield]][stars-url]
@ -22,21 +24,20 @@
<h3 align="center">EmoLLM</h3>
<p align="center">
<div align="center">
简体中文| <a href="README_EN.md" >English</a>
<br />
<br />
<a href="https://github.com/aJupyter/EmoLLM"><strong>探索本项目的文档 »</strong></a>
<br />
<br />
<a href="https://github.com/aJupyter/EmoLLM/tree/main/demo">查看Demo</a>
<a href="https://openxlab.org.cn/apps/detail/Farewell1/EmoLLMV2.0">体验EmoLLM 2.0</a>
·
<a href="https://github.com/aJupyter/EmoLLM/issues">报告Bug</a>
·
<a href="https://github.com/aJupyter/EmoLLM/issues">提出新特性</a>
</p>
</div>
</p>
<!-- 本篇README.md面向开发者 -->
@ -224,6 +225,19 @@ git clone https://github.com/SmartFlowAI/EmoLLM.git
该项目签署了 MIT 授权许可,详情请参阅 [LICENSE](https://github.com/SmartFlowAI/EmoLLM/blob/main/LICENSE)
### 引用
如果本项目对您的工作有所帮助,请使用以下格式引用:
```bibtex
@misc{EmoLLM,
title={EmoLLM},
author={EmoLLM},
url={https://github.com/SmartFlowAI/EmoLLM/},
year={2024}
}
```
### 特别鸣谢
- [Sanbu](https://github.com/sanbuphy)
@ -258,6 +272,12 @@ git clone https://github.com/SmartFlowAI/EmoLLM.git
[license-shield]: https://img.shields.io/github/license/SmartflowAI/EmoLLM.svg?style=flat-square
[license-url]: https://github.com/SmartFlowAI/EmoLLM/blob/main/LICENSE
[OpenXLab_App-image]: https://cdn-static.openxlab.org.cn/app-center/openxlab_app.svg
[OpenXLab_Model-image]: https://cdn-static.openxlab.org.cn/header/openxlab_models.svg
[OpenXLab_App-url]: https://openxlab.org.cn/apps/detail/Farewell1/EmoLLMV2.0
[OpenXLab_Model-url]: https://openxlab.org.cn/models/detail/ajupyter/EmoLLM_internlm2_7b_full
## 交流群
- 如果失效请移步Issue区

View File

@ -0,0 +1,76 @@
# EmoLLM RAG
## **模块目的**
根据用户的问题,检索对应信息以增强回答的专业性, 使EmoLLM的回答更加专业可靠。检索内容包括但不限于以下几点
- 心理学相关理论
- 心理学方法论
- 经典案例
- 客户背景知识
## **数据集**
- 经过清洗的QA对: 每一个QA对作为一个样本进行 embedding
- 经过筛选的TXT文本
- 直接对TXT文本生成embedding (基于token长度进行切分)
- 过滤目录等无关信息后对TXT文本生成embedding (基于token长度进行切分)
- 过滤目录等无关信息后, 对TXT进行语意切分生成embedding
- 按照目录结构对TXT进行拆分构架层级关系生成embedding
数据集合构建的详情,请参考 [qa_generation_README](https://github.com/SmartFlowAI/EmoLLM/blob/ccfa75c493c4685e84073dfbc53c50c09a2988e3/scripts/qa_generation/README.md)
## **相关组件**
### [BCEmbedding](https://github.com/netease-youdao/BCEmbedding?tab=readme-ov-file)
- [bce-embedding-base_v1](https://hf-mirror.com/maidalun1020/bce-embedding-base_v1): embedding 模型,用于构建 vector DB
- [bce-reranker-base_v1](https://hf-mirror.com/maidalun1020/bce-reranker-base_v1): rerank 模型,用于对检索回来的文章段落重排
### [Langchain](https://python.langchain.com/docs/get_started)
LangChain 是一个开源框架用于构建基于大型语言模型LLM的应用程序。LangChain 提供各种工具和抽象,以提高模型生成的信息的定制性、准确性和相关性。
### [FAISS](https://faiss.ai/)
Faiss是一个用于高效相似性搜索和密集向量聚类的库。它包含的算法可以搜索任意大小的向量集。由于langchain已经整合过FAISS因此本项目中不在基于原生文档开发[FAISS in Langchain](https://python.langchain.com/docs/integrations/vectorstores/faiss)
### [RAGAS](https://github.com/explodinggradients/ragas)
RAG的经典评估框架通过以下三个方面进行评估:
- Faithfulness: 给出的答案应该是以给定上下文为基础生成的。
- Answer Relevance: 生成的答案应该可以解决提出的实际问题。
- Context Relevance: 检索回来的信息应该是高度集中的,尽量少的包含不相关信息。
后续增加了更多的评判指标例如context recall 等
## **方案细节**
### RAG具体流程
- 根据数据集构建vector DB
- 对用户输入的问题进行embedding
- 基于embedding结果在向量数据库中进行检索
- 对召回数据重排序
- 依据用户问题和召回数据生成最后的结果
**Noted**: 当用户选择使用RAG时才会进行上述流程
### 后续增强
- 将RAGAS评判结果加入到生成流程中。例如当生成结果无法解决用户问题时需要重新生成
- 增加web检索以处理vector DB中无法检索到对应信息的问题
- 增加多路检索以增加召回率。即根据用户输入生成多个类似的query进行检索

View File

@ -218,7 +218,8 @@ def main():
user_avator = "assets/user.png"
robot_avator = "assets/robot.jpeg"
st.title("EmoLLM-温柔御姐艾薇aiwei")
# st.title("EmoLLM-温柔御姐艾薇aiwei")
st.title("EmoLLM-艾薇aiweiAI心理咨询")
generation_config = prepare_generation_config()
@ -264,4 +265,4 @@ def main():
if __name__ == "__main__":
main()
main()