Update README.md

README.md

@@ -1 +1,111 @@
-# Huatuo-Llama-Med-Chinese
+[**中文**](./README.md) | [**English**](./README_EN.md)
+
+# 华驼(HuaTuo): 基于中文医学知识的Llama微调模型
+### HuaTuo: Tuning LLaMA Model With Chinese Medical Instructions
+[![Code License](https://img.shields.io/badge/Code%20License-Apache_2.0-green.svg)](https://github.com/SCIR-HI/Huatuo-Llama-Med-Chinese/blob/main/LICENSE) 
+[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/release/python-390/)
+
+
+本项目开源了经过中文医学指令精调/指令微调(Instruct-tuning) 的LLaMA-7B模型。我们通过医学知识图谱和GPT3.5 API构建了中文医学指令数据集，并在此基础上对LLaMA进行了指令微调，提高了LLaMA在医疗领域的问答效果。
+
+
+## A Quick Start
+首先安装依赖包，python环境建议3.9+
+
+```
+pip install -r requirements.txt
+```
+### 模型下载
+LORA权重可以通过[百度网盘](https://pan.baidu.com/s/1jih-pEr6jzEa6n2u6sUMOg?pwd=jjpf)和[HuggingFace](https://huggingface.co/thinksoso/lora-llama-med)下载
+下载LORA权重并解压，解压后的格式如下：
+
+```
+lora-llama-med/
+  - adapter_config.json		# LoRA权重配置文件
+  - adapter_model.bin		# LoRA权重文件
+```
+
+### Infer
+我们在`./data/infer.json`中提供了一些测试用例，可以替换成其它的数据集，请注意保持格式一致
+
+
+运行infer脚本
+
+```
+bash ./scripts/infer.sh
+```
+
+### 数据集构建
+我们采用了公开和自建的中文医学知识库，主要参考了[cMeKG](https://github.com/king-yyf/CMeKG_tools)。
+医学知识库围绕疾病、药物、检查指标等构建，字段包括并发症，高危因素，组织学检查，临床症状，药物治疗，辅助治疗等。知识库示例如下:
+
+```
+{"中心词": "偏头痛", "相关疾病": ["妊娠合并偏头痛", "恶寒发热"], "相关症状": ["皮肤变硬", "头部及眼后部疼痛并能听到连续不断的隆隆声", "晨起头痛加重"], "所属科室": ["中西医结合科", "内科"], "发病部位": ["头部"]}
+```
+我们利用GPT3.5接口围绕医学知识库构建问答数据，设置了多种Prompt形式来充分利用知识。
+
+指令微调的训练集数据示例如下：
+
+```
+"问题：患者30岁，有胰腺假性囊肿病史，出现黄疸，怀疑胰腺假性囊肿并发了门静脉高压症，如何治疗？"
+"回答: 胰腺假性囊肿并发门静脉高压症需要密切观察病情，积极治疗原发病，进行药物干预，如利尿剂、强心剂等，注意肝功能保护和营养支持。严重病例需要考虑行肝移植。"
+```
+我们提供了模型的训练数据集，共计八千余条，需要注意的是，虽然训练集的构建融入了知识，但是仍存在错误和不完善的地方，后续我们会利用更好的策略迭代更新数据集。
+
+指令微调数据集质量仍有限，后续将进行不断迭代，同时医学知识库和数据集构建代码还在整理中，整理完成将会发布。
+
+
+### Finetune
+如果想用自己的数据集微调LLaMA，请按照`./data/llama_data.json`的格式构建自己的数据集
+运行finetune脚本
+```
+bash ./scripts/finetune.sh
+```
+
+
+
+## 训练细节
+### 计算资源需求
+我们在一张A100-SXM-80GB显卡上进行了训练，训练总轮次10轮，耗时约2h17m。batch_size=128的情况下显存占用在40G左右。预计3090/4090显卡(24GB显存)以上显卡可以较好支持，根据显存大小来调整batch_size。
+
+### 实验过程
+超参设置和实验过程可以参考wandb的链接:
+https://wandb.ai/thinksoso/llama_med/runs/a5wgcnzt/overview?workspace=user-thinksoso
+
+## 模型效果对比
+
+| 测试输入 | Llama输出  | Alpaca输出 | Huatuo华驼输出
+|:------------- |:---------------| :-------------|:-------------|
+|小张最近感觉身体不适，出现心悸、气促等症状。体检发现心脏扩大、搏动减弱。|问题：小张最近感觉身体不适，出现心悸、气促等症状。体检发现心脏扩大、搏动减弱。| 最近，小张一直感觉身体不舒服，有心烦意乱、呼吸急促等症状。体格检查显示心脏增大，肌肉无力。|**小张可能患有心肌炎，建议尽快到医院进行检查和治疗。治疗方案包括药物治疗和手术治疗。**|
+|麻风病和儿童哮喘的病因是否一致？|儿童哮喘和麻风病的病因是一致，但是儿童哮喘和麻风病的病因不一致|是的，哮喘和儿童喘息有相似的原因。| **不一致，麻风病的病因是麻风杆菌感染，而儿童哮喘的病因是喂养不良、吸烟等因素。**|
+|一位患者出现了持续性的胀痛和黄疸，经影像学检查后确诊为肝胆管结石病，应该采取哪些治疗方案？|肝胆管结石病患者应该采取哪些治疗方案？|患者应接受手术和化疗相结合的治疗。| **针对肝胆管结石病，治疗方案包括手术治疗、药物治疗和辅助治疗等。具体治疗方案需要根据患者的具体情况而定。**|
+
+## 项目参与者
+本项目由哈尔滨工业大学社会计算与信息检索研究中心健康智能组[王昊淳](https://github.com/s65b40) 、[刘驰](https://github.com/thinksoso)完成，指导教师为赵森栋副教授，秦兵教授以及刘挺教授。 
+
+
+## 致谢
+
+本项目参考了以下开源项目，在此对相关项目和研究开发人员表示感谢。
+
+- Facebook LLaMA: https://github.com/facebookresearch/llama
+- Stanford Alpaca: https://github.com/tatsu-lab/stanford_alpaca
+- alpaca-lora by @tloen: https://github.com/tloen/alpaca-lora
+- CMeKG https://github.com/king-yyf/CMeKG_tools
+
+## 免责声明
+本项目相关资源仅供学术研究之用，严禁用于商业用途。使用涉及第三方代码的部分时，请严格遵循相应的开源协议。模型生成的内容受模型计算、随机性和量化精度损失等因素影响，本项目无法对其准确性作出保证。本项目数据集绝大部分由模型生成，即使符合某些医学事实，也不能被用作实际医学诊断的依据。对于模型输出的任何内容，本项目不承担任何法律责任，亦不对因使用相关资源和输出结果而可能产生的任何损失承担责任。
+
+## Citation
+如果你使用了本项目的数据或者代码，请声明引用
+
+```
+@misc{huatuo,
+  author={Haochun Wang, Chi Liu, Sendong Zhao, Bing Qin, Ting Liu},
+  title = {HuaTuo: Tuning LLaMA Model With Chinese Medical Instructions},
+  year = {2023},
+  publisher = {GitHub},
+  journal = {GitHub repository},
+  howpublished = {\url{https://github.com/SCIR-HI/Huatuo-Llama-Med-Chinese}},
+}
+```