Update README.md

README.md

@@ -9,4 +9,174 @@ tags:
 ---
 This repository contains the DISC-MedLLM, version of Baichuan-13b-base as the base model.
 
-Check [DISC-MedLLM](https://github.com/FudanDISC/DISC-MedLLM) for more information.
+Check [DISC-MedLLM](https://github.com/FudanDISC/DISC-MedLLM) for more information.
+
+# DISC-MedLLM
+
+[**Demo**](http://medllm.fudan-disc.com) | [**Tech Report**](https://arxiv.org/abs/2308.14346)
+  
+This is the repo of DISC-MedLLM, a medical domain-specific LLM designed for conversational healthcare scenarios by [Fudan-DISC](http://fudan-disc.com) lab.
+
+The following resources have been released:
+* DISC-Med-SFT Dataset (with out behavioral preference dataset)
+* Model [weights](https://huggingface.co/Flmc/DISC-MedLLM) of DISC-MedLLM
+
+You can check this [link](http://medllm.fudan-disc.com) to try our online demo.
+
+## Overview
+The DISC-MedLLM is a large-scale domain-specific model designed for conversational healthcare scenarios. It can address a variety of your needs, including medical consultations and treatment inquiries, offering you high-quality health support services.
+
+The DISC-MedLLM effectively bridges the gap between general language models and real-world medical consultations, as evidenced by experimental results.
+
+Owing to our goal-oriented strategy and the framework that integrates both LLM and Human in the loop based on real-world doctor-patient dialogues and knowledge graphs, DISC-MedLLM boasts several features:
+
+* **Knowledge-intensive and reliable**
+* **Ability of multi-turn inquiry**
+* **Alignment with human preferences**
+
+<img src="https://github.com/FudanDISC/DISC-MedLLM/blob/main/images/data_construction.png" alt="data-construction" width="85%"/>
+
+## Demo
+### Consultation
+<img src="https://github.com/FudanDISC/DISC-MedLLM/blob/main/images/consultation.gif" alt="sample1" width="60%"/>
+
+### Treatment Inquiry
+<img src="https://github.com/FudanDISC/DISC-MedLLM/blob/main/images/advice.gif" alt="sample2" width="60%"/>
+
+## Dataset
+<!-- In order to align the distribution of actual doctor responses with the intended AI doctor response distribution, our dataset is constructed from five main resources: Real-world Conversations (420k), Knowledge Graph-derived Question-Answer pairs (50k), Artificially Annotated Data aligned with human preferences (2k), MedMCQA (8k), and additional general data (34k). -->
+
+To train DISC-MedLLM, we construct a high-quality dataset called DISC-Med-SFT consisting of over 470k distinct examples derived from existing medical datasets. We adopt a goal-oriented strategy by selectively reconstructing the dataset using a few deliberately chosen sources. These data sources serve the purpose of assisting LLMs in acquiring medical domain knowledge, aligning behavioral patterns with human preferences, and capturing real-world online medical dialogue distributions.
+
+<!-- <style type="text/css">
+.tg  {border-collapse:collapse;border-spacing:0;}
+.tg td{border-color:black;border-style:solid;border-width:1px;font-family:Arial, sans-serif;font-size:14px;
+  overflow:hidden;padding:10px 5px;word-break:normal;}
+.tg th{border-color:black;border-style:solid;border-width:1px;font-family:Arial, sans-serif;font-size:14px;
+  font-weight:normal;overflow:hidden;padding:10px 5px;word-break:normal;}
+.tg .tg-9wq8{border-color:inherit;text-align:center;vertical-align:middle}
+.tg .tg-c3ow{border-color:inherit;text-align:center;vertical-align:top}
+</style> -->
+<table class="tg" style="undefined;table-layout: fixed; width: 442px">
+<colgroup>
+<col style="width: 204.428571px">
+<col style="width: 135.428571px">
+<col style="width: 102.428571px">
+</colgroup>
+<thead>
+  <tr>
+    <th class="tg-9wq8" rowspan="2"><br>Dateset</th>
+    <th class="tg-9wq8" rowspan="2"><br>Original Source</th>
+    <th class="tg-9wq8" rowspan="2"><br>Size</th>
+  </tr>
+  <tr>
+  </tr>
+</thead>
+<tbody>
+  <tr>
+    <td class="tg-9wq8" rowspan="2">Re-constructed AI Doctor-Patient Dialogue</td>
+    <td class="tg-9wq8">MedDialog</td>
+    <td class="tg-9wq8">400k</td>
+  </tr>
+  <tr>
+    <td class="tg-9wq8">cMedQA2</td>
+    <td class="tg-c3ow">20k</td>
+  </tr>
+  <tr>
+    <td class="tg-c3ow">Knowledge Graph <br>QA pairs</td>
+    <td class="tg-9wq8">CMeKG</td>
+    <td class="tg-9wq8">50k</td>
+  </tr>
+  <tr>
+    <td class="tg-c3ow">Behavior Preference<br>Dataset</td>
+    <td class="tg-9wq8">Manual selection</td>
+    <td class="tg-9wq8">2k</td>
+  </tr>
+  <tr>
+    <td class="tg-9wq8" rowspan="3">Others</td>
+    <td class="tg-c3ow">MedMCQA</td>
+    <td class="tg-c3ow">8k</td>
+  </tr>
+  <tr>
+    <td class="tg-c3ow">MOSS-SFT</td>
+    <td class="tg-c3ow">33k</td>
+  </tr>
+  <tr>
+    <td class="tg-c3ow">Alpaca-GPT4-zh</td>
+    <td class="tg-c3ow">1k</td>
+  </tr>
+</tbody>
+</table>
+
+<br>
+
+
+## Deploy
+The current version of DISC-MedLLM is derived from the [Baichuan-13B-Base](https://github.com/baichuan-inc/Baichuan-13B). You can directly download our model weights from the HuggingFace [repository](https://huggingface.co/Flmc/DISC-MedLLM), or automatically obtain them through the demo code.
+
+
+### Using through hugging face transformers
+```python
+>>> import torch
+>>> from transformers import AutoModelForCausalLM, AutoTokenizer
+>>> from transformers.generation.utils import GenerationConfig
+>>> tokenizer = AutoTokenizer.from_pretrained("Flmc/DISC-MedLLM", use_fast=False, trust_remote_code=True)
+>>> model = AutoModelForCausalLM.from_pretrained("Flmc/DISC-MedLLM", device_map="auto", torch_dtype=torch.float16, trust_remote_code=True)
+>>> model.generation_config = GenerationConfig.from_pretrained("Flmc/DISC-MedLLM")
+>>> messages = []
+>>> messages.append({"role": "user", "content": "我感觉自己颈椎非常不舒服，每天睡醒都会头痛"})
+>>> response = model.chat(tokenizer, messages)
+>>> print(response)
+```
+
+
+Additionally, since the current version uses Baichuan as the base model, you can refer to its [repo](https://github.com/baichuan-inc/Baichuan-13B) for deploying with int8, int4 quantized inference. However, using quantized deployment will result in performance degradation.
+<br>
+
+## Training
+You can fine-tuning our model using the data same as our data schema.
+Our train code is derived from [Firefly](https://github.com/yangjianxin1/Firefly) with the different data schema and dialogue format. We jsut provide the code of Full Params Fine-tuning:
+```shell
+deepspeed --num_gpus={num_gpus} ./train/train.py --train_args_file ./train/train_args/sft.json
+```
+> Please check the setup of `sft.json` before you attempt to start training.
+
+<br>If you want to fine-tuning our model with other training code, please use the following dialogue format.
+```shell
+<\b><$user_token>content<$assistant_token>content<\s><$user_token>content ...
+```
+The `user_token` and `assistant_token` we used are `195` and `196`, respectly. Which is same as Baichuan-13b-Chat.
+
+
+## Acknowledgement
+This project wouldn't have been possible without the support and contributions of various individuals, teams, and organizations. Special thanks go to these repositories:
+
+- [**MedDialog**](https://github.com/UCSD-AI4H/Medical-Dialogue-System)
+
+- [**cMeKG**](https://github.com/king-yyf/CMeKG_tools)
+
+- [**cMedQA**](https://github.com/zhangsheng93/cMedQA2)
+
+- [**Baichuan-13B**](https://github.com/baichuan-inc/Baichuan-13B)
+
+- [**FireFly**](https://github.com/yangjianxin1/Firefly)
+
+Thank you also for the work that provided important assistance to the project, but limited in length.
+
+## Delcaration
+Due to the inherent limitations of language models, we cannot assure the accuracy or reliability of information generated by this model. This model is designed exclusively for research and testing by individuals and academic groups. We urge users to critically assess any information or medical advice obtained through the model's output. Blindly trusting or following such information is strongly discouraged. We disclaim responsibility for any issues, risks, or adverse consequences resulting from the model's use.
+
+## Licenses
+The use of the source code in this repository complies with the Apache 2.0 License.
+
+## Citation
+```angular2
+@misc{bao2023discmedllm,
+      title={DISC-MedLLM: Bridging General Large Language Models and Real-World Medical Consultation}, 
+      author={Zhijie Bao and Wei Chen and Shengze Xiao and Kuang Ren and Jiaao Wu and Cheng Zhong and Jiajie Peng and Xuanjing Huang and Zhongyu Wei},
+      year={2023},
+      eprint={2308.14346},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL}
+}
+```