Update README.md
Browse files
README.md
CHANGED
@@ -1,3 +1,287 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
---
|
2 |
-
|
3 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
<div align="center">
|
2 |
+
|
3 |
+
# EmoLLM-心理健康大模型
|
4 |
+
|
5 |
+
</div>
|
6 |
+
|
7 |
+
<p align="center">
|
8 |
+
<a href="https://github.com/aJupyter/EmoLLM/">
|
9 |
+
<img src="https://github.com/SmartFlowAI/EmoLLM/raw/main/assets/logo.jpeg" alt="Logo" width="30%">
|
10 |
+
</a>
|
11 |
+
|
12 |
+
<div align="center">
|
13 |
+
|
14 |
+
<!-- PROJECT SHIELDS -->
|
15 |
+
[![Contributors][contributors-shield]][contributors-url]
|
16 |
+
[![Forks][forks-shield]][forks-url]
|
17 |
+
[![Issues][issues-shield]][issues-url]
|
18 |
+
[![OpenXLab_App][OpenXLab_App-image]][OpenXLab_App-url]
|
19 |
+
[![OpenXLab_Model][OpenXLab_Model-image]][OpenXLab_Model-url]
|
20 |
+
[![MIT License][license-shield]][license-url]
|
21 |
+
[![Stargazers][stars-shield]][stars-url]
|
22 |
+
|
23 |
+
</div>
|
24 |
+
|
25 |
+
<h3 align="center">EmoLLM</h3>
|
26 |
+
|
27 |
+
<div align="center">
|
28 |
+
简体中文| <a href="README_EN.md" >English</a>
|
29 |
+
<br />
|
30 |
+
<br />
|
31 |
+
<a href="https://github.com/aJupyter/EmoLLM"><strong>探索本项目的文档 »</strong></a>
|
32 |
+
<br />
|
33 |
+
<br />
|
34 |
+
<a href="https://openxlab.org.cn/apps/detail/Farewell1/EmoLLMV2.0">体验EmoLLM 2.0</a>
|
35 |
+
·
|
36 |
+
<a href="https://github.com/aJupyter/EmoLLM/issues">报告Bug</a>
|
37 |
+
·
|
38 |
+
<a href="https://github.com/aJupyter/EmoLLM/issues">提出新特性</a>
|
39 |
+
</div>
|
40 |
+
|
41 |
+
|
42 |
+
<!-- 本篇README.md面向开发者 -->
|
43 |
+
|
44 |
+
**EmoLLM** 是一系列能够支持 **理解用户-支持用户-帮助用户** 心理健康辅导链路的心理健康大模型,由 `LLM`指令微调而来,欢迎大家star~⭐⭐。目前已经开源的 `LLM` 微调配置如下:
|
45 |
+
|
46 |
+
<div align="center">
|
47 |
+
|
48 |
+
| 模型 | 类型 |
|
49 |
+
| :-------------------: | :------: |
|
50 |
+
| InternLM2_7B_chat | QLORA |
|
51 |
+
| InternLM2_7B_chat | 全量微调 |
|
52 |
+
| InternLM2_1_8B_chat | 全量微调 |
|
53 |
+
| InternLM2_20B_chat | LORA |
|
54 |
+
| Qwen_7b_chat | QLORA |
|
55 |
+
| Qwen1_5-0_5B-Chat | 全量微调 |
|
56 |
+
| Baichuan2_13B_chat | QLORA |
|
57 |
+
| ChatGLM3_6B | LORA |
|
58 |
+
| DeepSeek MoE_16B_chat | QLORA |
|
59 |
+
| Mixtral 8x7B_instruct | QLORA |
|
60 |
+
| …… | …… |
|
61 |
+
|
62 |
+
</div>
|
63 |
+
|
64 |
+
欢迎大家为本项目做出贡献~
|
65 |
+
|
66 |
---
|
67 |
+
|
68 |
+
心理健康大模型(Mental Health Grand Model)是一个综合性的概念,它旨在全面理解和促进个体、群体乃至整个社会的心理健康状态。这个模型通常包含以下几个关键组成部分:
|
69 |
+
|
70 |
+
- 认知因素:涉及个体的思维模式、信念系统、认知偏差以及解决问题的能力。认知因素对心理健康有重要影响,因为它们影响个体如何解释和应对生活中的事件。
|
71 |
+
- 情感因素:包括情绪调节、情感表达和情感体验。情感健康是心理健康的重要组成部分,涉及个体如何管理和表达自己的情感,以及如何从负面情绪中恢复。
|
72 |
+
- 行为因素:涉及个体的行为模式、习惯和应对策略。这包括应对压力的技巧、社交技能以及自我效能感,即个体对自己能力的信心。
|
73 |
+
- 社会环境:包括家庭、工作、社区和文化背景等外部因素,这些因素对个体的心理健康有着直接和间接的影响。
|
74 |
+
- 生理健康:身体健康与心理健康紧密相关。良好的身体健康可以促进心理健康,反之亦然。
|
75 |
+
- 心理韧性:指个体在面对逆境时的恢复力和适应能力。心理韧性强的人更能够从挑战中恢复,并从中学习和成长。
|
76 |
+
- 预防和干预措施:心理健康大模型还包括预防心理问题和促进心理健康的策略,如心理教育、心理咨询、心理治疗和社会支持系统。
|
77 |
+
- 评估和诊断工具:为了有效促进心理健康,需要有科学的工具来评估个体的心理状态,以及诊断可能存在的心理问题。
|
78 |
+
|
79 |
+
### 🎇最近更新
|
80 |
+
|
81 |
+
- 【2024.3.12】在百度飞浆平台发布[艾薇](https://aistudio.baidu.com/community/app/63335)
|
82 |
+
- 【2024.3.11】 **EmoLLM V2.0 相比 EmoLLM V1.0 全面提升,已超越 Role-playing ChatGPT 在心理咨询任务上的能力!**[点击体验EmoLLM V2.0](https://openxlab.org.cn/apps/detail/Farewell1/EmoLLMV2.0),更新[数据集统计及详细信息](./datasets/)、[路线图](./assets/Roadmap_ZH.png)
|
83 |
+
- 【2024.3.9】 新增并发功能加速 [QA 对生成](./scripts/qa_generation/)、[RAG pipeline](./rag/)
|
84 |
+
- 【2024.3.3】 [基于InternLM2-7B-chat全量微调版本EmoLLM V2.0开源](https://openxlab.org.cn/models/detail/ajupyter/EmoLLM_internlm2_7b_full),需要两块A100*80G,更新专业评估,详见[evaluate](./evaluate/),更新基于PaddleOCR的PDF转txt工具脚本,详见[scripts](./scripts/)
|
85 |
+
- 【2024.2.29】更新客观评估计算,详见[evaluate](./evaluate/),更新一系列数据集,详见[datasets](./datasets/)
|
86 |
+
- 【2024.2.27】更新英文readme和一系列数据集(舔狗和单轮对话)
|
87 |
+
- 【2024.2.23】推出基于InternLM2_7B_chat_qlora的 `温柔御姐心理医生艾薇`,[点击获取模型权重](https://openxlab.org.cn/models/detail/ajupyter/EmoLLM_aiwei),[配置文件](xtuner_config/aiwei-internlm2_chat_7b_qlora.py),[在线体验链接](https://openxlab.org.cn/apps/detail/ajupyter/EmoLLM-aiwei)
|
88 |
+
- 【2024.2.23】更新[若干微调配置](/xtuner_config/),新增 [data_pro.json](/datasets/data_pro.json)(数量更多、场景更全、更丰富)和 [aiwei.json](/datasets/aiwei.json)(温柔御姐角色扮演专用,带有Emoji表情),即将推出 `温柔御姐心理医生艾薇`
|
89 |
+
- 【2024.2.18】 [基于Qwen1_5-0_5B-Chat全量微调版本开源](https://www.modelscope.cn/models/aJupyter/EmoLLM_Qwen1_5-0_5B-Chat_full_sft/summary),算力有限的道友可以玩起来~
|
90 |
+
|
91 |
+
<details>
|
92 |
+
<summary>查看更多</summary>
|
93 |
+
|
94 |
+
- 【2024.2.6】 EmoLLM在[**Openxlab** ](https://openxlab.org.cn/models/detail/jujimeizuo/EmoLLM_Model) 平台下载量高达18.7k,欢迎大家体验!
|
95 |
+
|
96 |
+
<p align="center">
|
97 |
+
<img src="https://github.com/aJupyter/EmoLLM/assets/62385492/7e931682-c54d-4ded-bc67-79130c68d744" alt="模型下载量">
|
98 |
+
</p>
|
99 |
+
|
100 |
+
- 【2024.2.5】 项目荣获公众号**NLP工程化**推文宣传[推文链接](https://mp.weixin.qq.com/s/78lrRl2tlXEKUfElnkVx4A),为博主推广一波,欢迎大家关注!!🥳🥳
|
101 |
+
|
102 |
+
<p align="center">
|
103 |
+
<img src="https://github.com/aJupyter/EmoLLM/assets/62385492/47868d6a-2e91-4aa9-a630-e594c14295b4" alt="公众号二维码">
|
104 |
+
</p>
|
105 |
+
|
106 |
+
- 【2024.2.3】 [项目宣传视频](https://www.bilibili.com/video/BV1N7421N76X/)完成 😊
|
107 |
+
- 【2024.1.27】 完善数据构建文档、微调指南、部署指南、Readme等相关文档 👏
|
108 |
+
- 【2024.1.25】 EmoLLM V1.0 已部署上线 https://openxlab.org.cn/apps/detail/jujimeizuo/EmoLLM 😀
|
109 |
+
|
110 |
+
</details>
|
111 |
+
|
112 |
+
### 🎯路线图
|
113 |
+
|
114 |
+
<p align="center">
|
115 |
+
<a href="https://github.com/aJupyter/EmoLLM/">
|
116 |
+
<img src="https://github.com/SmartFlowAI/EmoLLM/raw/main/assets/Roadmap_ZH.png" alt="Roadmap_ZH">
|
117 |
+
</a>
|
118 |
+
|
119 |
+
## 目录
|
120 |
+
|
121 |
+
- [EmoLLM-心理健康大模型](#emollm-心理健康大模型)
|
122 |
+
- [🎇最近更新](#最近更新)
|
123 |
+
- [🎯路线图](#路线图)
|
124 |
+
- [目录](#目录)
|
125 |
+
- [开发前的配置要求](#开发前的配置要求)
|
126 |
+
- [**使用指南**](#使用指南)
|
127 |
+
- [数据构建](#数据构建)
|
128 |
+
- [微调指南](#微调指南)
|
129 |
+
- [部署指南](#部署指南)
|
130 |
+
- [RAG(检索增强生成)Pipeline](#rag检索增强生成pipeline)
|
131 |
+
- [使用到的框架](#使用到的框架)
|
132 |
+
- [如何参与本项目](#如何参与本项目)
|
133 |
+
- [作者(排名不分先后)](#作者排名不分先后)
|
134 |
+
- [版权说明](#版权说明)
|
135 |
+
- [特别鸣谢](#特别鸣谢)
|
136 |
+
- [Star History](#star-history)
|
137 |
+
- [🌟 Contributors](#-contributors)
|
138 |
+
- [交流群](#交流群)
|
139 |
+
|
140 |
+
###### 开发前的配置要求
|
141 |
+
|
142 |
+
- 硬件:A100 40G(仅针对InternLM2_7B_chat+qlora微调+deepspeed zero2优化)
|
143 |
+
|
144 |
+
###### **使用指南**
|
145 |
+
|
146 |
+
1. Clone the repo
|
147 |
+
|
148 |
+
```sh
|
149 |
+
git clone https://github.com/SmartFlowAI/EmoLLM.git
|
150 |
+
```
|
151 |
+
|
152 |
+
2. 依次阅读或者选择感兴趣的部分阅读:
|
153 |
+
- [数据构建](#数据构建)
|
154 |
+
- [微调指南](#微调指南)
|
155 |
+
- [部署指南](#部署指南)
|
156 |
+
- [RAG](#rag检索增强生成pipeline)
|
157 |
+
- 查看更多详情
|
158 |
+
|
159 |
+
### 数据构建
|
160 |
+
|
161 |
+
- 请阅读[数据构建指南](generate_data/tutorial.md)查阅
|
162 |
+
|
163 |
+
- 微调用到的数据集见[datasets](datasets/data.json)
|
164 |
+
|
165 |
+
### 微调指南
|
166 |
+
|
167 |
+
详见[微调指南](xtuner_config/README.md)
|
168 |
+
|
169 |
+
### 部署指南
|
170 |
+
|
171 |
+
- Demo部署:详见[部署指南](demo/README.md)
|
172 |
+
- 基于[LMDeploy](https://github.com/InternLM/lmdeploy/)的量化部署:详见[deploy](./deploy/lmdeploy.md)
|
173 |
+
|
174 |
+
### RAG(检索增强生成)Pipeline
|
175 |
+
|
176 |
+
- 详见[RAG](./rag/)
|
177 |
+
|
178 |
+
<details>
|
179 |
+
<summary>更多详情</summary>
|
180 |
+
|
181 |
+
### 使用到的框架
|
182 |
+
|
183 |
+
- [Xtuner](https://github.com/InternLM/xtuner):用于微调
|
184 |
+
- [Transformers](https://github.com/huggingface/transformers)
|
185 |
+
- [Pytorch](https://pytorch.org/)
|
186 |
+
- [LMDeploy](https://github.com/InternLM/lmdeploy/):用于量化部署
|
187 |
+
- [Stremlit](https://streamlit.io/):用于构建Demo
|
188 |
+
- [DeepSpeed](https://github.com/microsoft/DeepSpeed):并行训练
|
189 |
+
- …
|
190 |
+
|
191 |
+
#### 如何参与本项目
|
192 |
+
|
193 |
+
贡献使开源社区成为一个学习、激励和创造的绝佳场所。你所作的任何贡献都是**非常感谢**的。
|
194 |
+
|
195 |
+
1. Fork the Project
|
196 |
+
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
|
197 |
+
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
|
198 |
+
4. Push to the Branch (`git push origin feature/AmazingFeature`)
|
199 |
+
5. Open a Pull Request
|
200 |
+
|
201 |
+
</details>
|
202 |
+
|
203 |
+
### 作者(排名不分先后)
|
204 |
+
|
205 |
+
| 用户名 | 学校/组织 | 备注 | 贡献 |
|
206 |
+
| :----------: | :--------------------: | :-------------------: | :----------: |
|
207 |
+
| [aJupyter](https://github.com/aJupyter) | 南开大学在读硕士 | DataWhale成员 | 项目发起人 |
|
208 |
+
| [jujimeizuo](https://github.com/jujimeizuo) | 江南大学在读硕士 | | |
|
209 |
+
| [Smiling-Weeping-zhr](https://github.com/Smiling-Weeping-zhr) | 哈尔滨工业大学(威海)在读本科生 | | |
|
210 |
+
| [8baby8](https://github.com/8baby8) | 飞桨领航团区域主管 | 文心大模型核心开发者 | |
|
211 |
+
| [zxazys](https://github.com/zxazys) | 南开大学在读硕士 | | |
|
212 |
+
| [MING-ZCH](https://github.com/MING-ZCH) | 华中科技大学在读本科生 | | |
|
213 |
+
| [JasonLLLLLLLLLLL](https://github.com/JasonLLLLLLLLLLL) | swufe | | |
|
214 |
+
| [MrCatAI](https://github.com/MrCatAI) | AI搬用工 | | |
|
215 |
+
| [ZeyuBa](https://github.com/ZeyuBa) | 自动化所在读硕士 | | |
|
216 |
+
| [aiyinyuedejustin](https://github.com/aiyinyuedejustin) | 宾夕法尼亚大学在读硕士 | | |
|
217 |
+
| [Nobody-ML](https://github.com/Nobody-ML) | 中国石油大学(华东)在读本科生 | | |
|
218 |
+
| [chg0901](https://github.com/chg0901) | [MiniSora](https://github.com/mini-sora/minisora/) |MiniSora主要维护|数据清洗、文档翻译|
|
219 |
+
| [Mxoder](https://github.com/Mxoder) | 北京航空航天大学在读本科生 | | |
|
220 |
+
| [Anooyman](https://github.com/Anooyman) | 南京理工大学硕士 | | |
|
221 |
+
| [Vicky-3021](https://github.com/Vicky-3021) | 西安电子科技大学硕士(研0) | | |
|
222 |
+
| [SantiagoTOP](https://github.com/santiagoTOP) | 太原理工大学在读硕士 | | |
|
223 |
+
|
224 |
+
### 版权说明
|
225 |
+
|
226 |
+
该项目签署了 MIT 授权许可,详情请参阅 [LICENSE](https://github.com/SmartFlowAI/EmoLLM/blob/main/LICENSE)
|
227 |
+
|
228 |
+
|
229 |
+
### 引用
|
230 |
+
如果本项目对您的工作有所帮助,请使用以下格式引用:
|
231 |
+
|
232 |
+
```bibtex
|
233 |
+
@misc{EmoLLM,
|
234 |
+
title={EmoLLM},
|
235 |
+
author={EmoLLM},
|
236 |
+
url={https://github.com/SmartFlowAI/EmoLLM/},
|
237 |
+
year={2024}
|
238 |
+
}
|
239 |
+
```
|
240 |
+
|
241 |
+
### 特别鸣谢
|
242 |
+
|
243 |
+
- [Sanbu](https://github.com/sanbuphy)
|
244 |
+
- [上海人工智能实验室](https://www.shlab.org.cn/)
|
245 |
+
- [闻星大佬(小助手)](https://github.com/vansin)
|
246 |
+
- [扫地升(公众号宣传)](https://mp.weixin.qq.com/s/78lrRl2tlXEKUfElnkVx4A)
|
247 |
+
- 阿布(北大心理学硕士)
|
248 |
+
|
249 |
+
<!-- links -->
|
250 |
+
|
251 |
+
<!-- [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555 -->
|
252 |
+
|
253 |
+
<!-- [linkedin-url]: https://linkedin.com/in/aJupyter -->
|
254 |
+
|
255 |
+
## Star History
|
256 |
+
|
257 |
+
[![Star History Chart](https://api.star-history.com/svg?repos=SmartFlowAI/EmoLLM&type=Date)](https://star-history.com/#SmartFlowAI/EmoLLM&Date)
|
258 |
+
|
259 |
+
## 🌟 Contributors
|
260 |
+
|
261 |
+
[![EmoLLM contributors](https://contrib.rocks/image?repo=SmartFlowAI/EmoLLM&max=50)](https://github.com/SmartFlowAI/EmoLLM/graphs/contributors)
|
262 |
+
|
263 |
+
[your-project-path]: SmartflowAI/EmoLLM
|
264 |
+
[contributors-shield]: https://img.shields.io/github/contributors/SmartflowAI/EmoLLM.svg?style=flat-square
|
265 |
+
[contributors-url]: https://github.com/SmartflowAI/EmoLLM/graphs/contributors
|
266 |
+
[forks-shield]: https://img.shields.io/github/forks/SmartflowAI/EmoLLM.svg?style=flat-square
|
267 |
+
[forks-url]: https://github.com/SmartflowAI/EmoLLM/network/members
|
268 |
+
[stars-shield]: https://img.shields.io/github/stars/SmartflowAI/EmoLLM.svg?style=flat-square
|
269 |
+
[stars-url]: https://github.com/SmartflowAI/EmoLLM/stargazers
|
270 |
+
[issues-shield]: https://img.shields.io/github/issues/SmartflowAI/EmoLLM.svg?style=flat-square
|
271 |
+
[issues-url]: https://img.shields.io/github/issues/SmartflowAI/EmoLLM.svg
|
272 |
+
[license-shield]: https://img.shields.io/github/license/SmartflowAI/EmoLLM.svg?style=flat-square
|
273 |
+
[license-url]: https://github.com/SmartFlowAI/EmoLLM/blob/main/LICENSE
|
274 |
+
|
275 |
+
[OpenXLab_App-image]: https://cdn-static.openxlab.org.cn/app-center/openxlab_app.svg
|
276 |
+
[OpenXLab_Model-image]: https://cdn-static.openxlab.org.cn/header/openxlab_models.svg
|
277 |
+
[OpenXLab_App-url]: https://openxlab.org.cn/apps/detail/Farewell1/EmoLLMV2.0
|
278 |
+
[OpenXLab_Model-url]: https://openxlab.org.cn/models/detail/ajupyter/EmoLLM_internlm2_7b_full
|
279 |
+
|
280 |
+
|
281 |
+
## 交流群
|
282 |
+
|
283 |
+
- 如果失效,请移步Issue区
|
284 |
+
|
285 |
+
<p align="center">
|
286 |
+
<img width="30%" src="https://github.com/SmartFlowAI/EmoLLM/assets/62385492/55ecd0aa-4832-4269-ad57-4c26f9aa286b" alt="EmoLLM官方交流群">
|
287 |
+
</p>
|