Update README.md

README.md

@@ -1,3 +1,167 @@
 ---
+pipeline_tag: text-generation
+language: multilingual
 license: apache-2.0
+tags:
+- "Multitask Language Understanding"
+- "Multilingual"
+widget:
+- text: "In traditional Western medicine, which vitamin is commonly recommended to prevent scurvy? A) Vitamin A B) Vitamin B12 C) Vitamin C D) Vitamin D"
+  example_title: "English"
+- text: "在中医理论中，以下哪种药材不是治疗风湿病的常用药物？ A) 独活 B) 秦艽 C) 甘草 D) 珍珠粉"
+  example_title: "Chinese"
+- text: "السؤال:** ما هو العلاج الطبيعي الذي يستخدم تقليديًا في الطب العربي لتحسين الهضم؟ A) الزنجبيل B) النعناع C) القرفة D) الحلبة"
+  example_title: "Arabic"
+- text: "आयुर्वेद में, किस औषधि का उपयोग आमतौर पर जुकाम के इलाज के लिए किया जाता है? A) नीम B) तुलसी C) गिलोय D) अश्वगंधा"
+  example_title: "Hindi"
+- text: "En la medicina tradicional española, ¿qué alimento se considera beneficioso para la salud del hígado? A) Aceite de oliva B) Tomate C) Foie gras (hígado de ganso) D) Ajo"
+  example_title: "Spanish"
+- text: "Dans la tradition médicinale française, quel produit est réputé pour ses bienfaits sur la digestion ? A) Le vin rouge B) Le fromage C) Le foie gras D) Les herbes de Provence"
+  example_title: "French"
 ---
+# Multilingual Medicine: Model, Dataset, Benchmark, Code
+
+Covering English, Chinese, French, Hindi, Spanish, Hindi, Arabic So far
+
+
+<p align="center">
+   👨🏻‍💻<a href="https://github.com/FreedomIntelligence/Apollo" target="_blank">Github</a> •📃 <a href="https://arxiv.org/abs/2403.03640" target="_blank">Paper</a> • 🌐 <a href="https://apollo.llmzoo.com/" target="_blank">Demo</a> • 🤗 <a href="https://huggingface.co/datasets/FreedomIntelligence/ApolloCorpus" target="_blank">ApolloCorpus</a> • 🤗 <a href="https://huggingface.co/datasets/FreedomIntelligence/XMedbench" target="_blank">XMedBench</a> 
+   <br>  <a href="./README_zh.md"> 中文 </a> | <a href="./README.md"> English
+</p>
+
+![Apollo](assets/apollo_medium_final.png)
+
+## 🌈 Update
+
+* **[2024.03.07]** [Paper](https://arxiv.org/abs/2403.03640) released.
+* **[2024.02.12]** <a href="https://huggingface.co/datasets/FreedomIntelligence/ApolloCorpus" target="_blank">ApolloCorpus</a> and  <a href="https://huggingface.co/datasets/FreedomIntelligence/XMedbench" target="_blank">XMedBench</a>  is published！🎉
+* **[2024.01.23]** Apollo repo is published！🎉
+
+
+## Results
+   <a href="https://huggingface.co/FreedomIntelligence/Apollo-0.5B" target="_blank">Apollo-0.5B</a> • 🤗 <a href="https://huggingface.co/FreedomIntelligence/Apollo-1.8B" target="_blank">Apollo-1.8B</a> • 🤗 <a href="https://huggingface.co/FreedomIntelligence/Apollo-2B" target="_blank">Apollo-2B</a>  • 🤗 <a href="https://huggingface.co/FreedomIntelligence/Apollo-6B" target="_blank">Apollo-6B</a> • 🤗 <a href="https://huggingface.co/FreedomIntelligence/Apollo-7B" target="_blank">Apollo-7B</a>
+   
+   
+   ![Apollo](assets/result.png)
+      
+   
+  
+
+
+## Dataset & Evaluation
+
+- Dataset
+  🤗 <a href="https://huggingface.co/datasets/FreedomIntelligence/ApolloCorpus" target="_blank">ApolloCorpus</a>
+  
+  <details><summary>Click to expand</summary>
+
+    ![Apollo](assets/dataset.png)
+
+    - [Zip File](https://huggingface.co/datasets/FreedomIntelligence/ApolloCorpus/blob/main/ApolloCorpus.zip)
+    - [Data category](https://huggingface.co/datasets/FreedomIntelligence/ApolloCorpus/tree/main/train)
+       - Pretrain:
+         - data item:
+            - json_name: {data_source}_{language}_{data_type}.json
+            - data_type: medicalBook, medicalGuideline, medicalPaper, medicalWeb(from online forum), medicalWiki
+            - language: en(English), zh(chinese), es(spanish), fr(french), hi(Hindi)
+            - data_type: qa(generated qa from text)
+            - data_type==text: list of string
+              ```
+              [
+                "string1",
+                "string2",
+                ...
+              ]
+              ```
+            - data_type==qa: list of qa pairs(list of string)
+              ```
+              [
+                [
+                  "q1",
+                  "a1",
+                  "q2",
+                  "a2",
+                  ...
+                ],
+                ...
+              ]
+              ```
+      - SFT:
+          - json_name: {data_source}_{language}.json
+          - data_type: code, general, math, medicalExam, medicalPatient
+          - data item: list of qa pairs(list of string)
+            ```
+              [
+                [
+                  "q1",
+                  "a1",
+                  "q2",
+                  "a2",
+                  ...
+                ],
+                ...
+              ]
+              ```
+
+
+   </details>
+
+
+   
+- Evaluation
+  🤗 <a href="https://huggingface.co/datasets/FreedomIntelligence/XMedbench" target="_blank">XMedBench</a>
+
+  <details><summary>Click to expand</summary>
+      
+     - EN:
+       - [MedQA-USMLE](https://huggingface.co/datasets/GBaker/MedQA-USMLE-4-options) 
+       - [MedMCQA](https://huggingface.co/datasets/medmcqa/viewer/default/test)
+       - [PubMedQA](https://huggingface.co/datasets/pubmed_qa): Because the results fluctuated too much, they were not used in the paper.
+       - [MMLU-Medical](https://huggingface.co/datasets/cais/mmlu)
+         - Clinical knowledge, Medical genetics, Anatomy, Professional medicine, College biology, College medicine
+     - ZH:
+       - [MedQA-MCMLE](https://huggingface.co/datasets/bigbio/med_qa/viewer/med_qa_zh_4options_bigbio_qa/test)
+       - [CMB-single](https://huggingface.co/datasets/FreedomIntelligence/CMB): Not used in the paper
+         - Randomly sample 2,000 multiple-choice questions with single answer.
+       - [CMMLU-Medical](https://huggingface.co/datasets/haonan-li/cmmlu)
+         - Anatomy, Clinical_knowledge, College_medicine, Genetics, Nutrition, Traditional_chinese_medicine, Virology
+       - [CExam](https://github.com/williamliujl/CMExam): Not used in the paper
+         - Randomly sample 2,000 multiple-choice questions
+
+
+     - ES: [Head_qa](https://huggingface.co/datasets/head_qa)
+     - FR: [Frenchmedmcqa](https://github.com/qanastek/FrenchMedMCQA)
+     - HI: [MMLU_HI](https://huggingface.co/datasets/FreedomIntelligence/MMLU_Arabic)
+        - Clinical knowledge, Medical genetics, Anatomy, Professional medicine, College biology, College medicine
+     - AR: [MMLU_Ara](https://huggingface.co/datasets/FreedomIntelligence/MMLU_Hindi)
+        - Clinical knowledge, Medical genetics, Anatomy, Professional medicine, College biology, College medicine
+
+
+   </details>
+
+
+## Results reproduction
+   <details><summary>Click to expand</summary>
+   
+   **Waiting for Update**
+      
+
+   
+   </details>
+
+
+
+
+##  Citation
+Please use the following citation if you intend to use our dataset for training or evaluation:
+
+```
+@misc{wang2024apollo,
+   title={Apollo: Lightweight Multilingual Medical LLMs towards Democratizing Medical AI to 6B People},
+   author={Xidong Wang and Nuo Chen and Junyin Chen and Yan Hu and Yidong Wang and Xiangbo Wu and Anningzhe Gao and Xiang Wan and Haizhou Li and Benyou Wang},
+   year={2024},
+   eprint={2403.03640},
+   archivePrefix={arXiv},
+   primaryClass={cs.CL}
+}
+```