Update README.md

README.md

@@ -20,35 +20,79 @@ configs:
   data_files:
     - split: test
       path: "NER/test.json"
+task_categories:
+- text-classification
+- question-answering
+- zero-shot-classification
+- conversational
+language:
+- en
 ---
 
-# Adapt Large Language Models to Domains
+# Adapt (Large) Language Models to Domains
+This repo contains the evaluation datasets for our paper [Adapting Large Language Models via Reading Comprehension](https://huggingface.co/papers/2309.09530).
 
-This repo contains the evaluation datasets for our paper [Adapting Large Language Models via Reading Comprehension](https://huggingface.co/papers/2309.09530)
+We explore **continued pre-training on domain-specific corpora** for large language models. While this approach enriches LLMs with domain knowledge, it significantly hurts their prompting ability for question answering. Inspired by human learning via reading comprehension, we propose a simple method to **transform large-scale pre-training corpora into reading comprehension texts**, consistently improving prompting performance across tasks in biomedicine, finance, and law domains. **Our 7B model competes with much larger domain-specific models like BloombergGPT-50B**. 
 
-We explore **continued pre-training on domain-specific corpora** for large language models. While this approach enriches LLMs with domain knowledge, it significantly hurts their prompting ability for question answering. Inspired by human learning via reading comprehension, we propose a simple method to **transform large-scale pre-training corpora into reading comprehension texts**, consistently improving prompting performance across tasks in **biomedicine, finance, and law domains**. Our 7B model competes with much larger domain-specific models like BloombergGPT-50B. Moreover, our domain-specific reading comprehension texts enhance model performance even on general benchmarks, indicating potential for developing a general LLM across more domains.
+### 🤗 We are currently working hard on developing models across different domains, scales and architectures! Please stay tuned! 🤗
 
-## GitHub repo: 
-https://github.com/microsoft/LMOps
+**************************** **Updates** ****************************
+* 12/8: Released our [chat models](https://huggingface.co/AdaptLLM/finance-chat) developed from LLaMA-2-Chat-7B.
+* 9/18: Released our [paper](https://huggingface.co/papers/2309.09530), [code](https://github.com/microsoft/LMOps), [data](https://huggingface.co/datasets/AdaptLLM/finance-tasks), and [base models](https://huggingface.co/AdaptLLM/finance-LLM) developed from LLaMA-1-7B.
 
-## Domain-specific LLMs:
-Our models of different domains are now available in Huggingface: [Biomedicine-LLM](https://huggingface.co/AdaptLLM/medicine-LLM), [Finance-LLM](https://huggingface.co/AdaptLLM/finance-LLM) and [Law-LLM](https://huggingface.co/AdaptLLM/law-LLM), the performances of our AdaptLLM compared to other domain-specific LLMs are:
+
+## Domain-Specific LLaMA-1
+In our paper, we develop three domain-specific models from LLaMA-1-7B, which are also available in Huggingface: [Biomedicine-LLM](https://huggingface.co/AdaptLLM/medicine-LLM), [Finance-LLM](https://huggingface.co/AdaptLLM/finance-LLM) and [Law-LLM](https://huggingface.co/AdaptLLM/law-LLM), the performances of our AdaptLLM compared to other domain-specific LLMs are:
 
 <p align='center'>
-    <img src="./comparison.png" width="700">
+    <img src="https://cdn-uploads.huggingface.co/production/uploads/650801ced5578ef7e20b33d4/6efPwitFgy-pLTzvccdcP.png" width="700">
 </p>
 
-## Domain-specific Tasks:
+## Domain-Specific LLaMA-2-Chat
+Our method is also effective for aligned models! LLaMA-2-Chat requires a [specific data format](https://huggingface.co/blog/llama2#how-to-prompt-llama-2), and our **reading comprehension can perfectly fit the data format** by transforming the reading comprehension into a multi-turn conversation. We have also open-sourced chat models in different domains: [Biomedicine-Chat](https://huggingface.co/AdaptLLM/medicine-chat), [Finance-Chat](https://huggingface.co/AdaptLLM/finance-chat) and [Law-Chat](https://huggingface.co/AdaptLLM/law-chat)
+
+For example, to chat with the finance model:
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
+
+model = AutoModelForCausalLM.from_pretrained("AdaptLLM/finance-chat")
+tokenizer = AutoTokenizer.from_pretrained("AdaptLLM/finance-chat", use_fast=False)
+
+# Put your input here:
+user_input = '''Use this fact to answer the question: Title of each class Trading Symbol(s) Name of each exchange on which registered
+Common Stock, Par Value $.01 Per Share MMM New York Stock Exchange
+MMM Chicago Stock Exchange, Inc.
+1.500% Notes due 2026 MMM26 New York Stock Exchange
+1.750% Notes due 2030 MMM30 New York Stock Exchange
+1.500% Notes due 2031 MMM31 New York Stock Exchange
+
+Which debt securities are registered to trade on a national securities exchange under 3M's name as of Q2 of 2023?'''
+
+# We use the prompt template of LLaMA-2-Chat demo
+prompt = f"<s>[INST] <<SYS>>\nYou are a helpful, respectful and honest assistant. Always answer as helpfully as possible, while being safe. Your answers should not include any harmful, unethical, racist, sexist, toxic, dangerous, or illegal content. Please ensure that your responses are socially unbiased and positive in nature.\n\nIf a question does not make any sense, or is not factually coherent, explain why instead of answering something not correct. If you don't know the answer to a question, please don't share false information.\n<</SYS>>\n\n{user_input} [/INST]"
+
+inputs = tokenizer(prompt, return_tensors="pt", add_special_tokens=False).input_ids.to(model.device)
+outputs = model.generate(input_ids=inputs, max_length=4096)[0]
+
+answer_start = int(inputs.shape[-1])
+pred = tokenizer.decode(outputs[answer_start:], skip_special_tokens=True)
+
+print(f'### User Input:\n{user_input}\n\n### Assistant Output:\n{pred}')
+```
+
+## Domain-Specific Tasks
 To easily reproduce our results, we have uploaded the filled-in zero/few-shot input instructions and output completions of each domain-specific task: [biomedicine-tasks](https://huggingface.co/datasets/AdaptLLM/medicine-tasks), [finance-tasks](https://huggingface.co/datasets/AdaptLLM/finance-tasks), and [law-tasks](https://huggingface.co/datasets/AdaptLLM/law-tasks).
 
+**Note:** those filled-in instructions are specifically tailored for models before alignment and do NOT fit for the specific data format required for chat models.
 
-## Citation:
+## Citation
+If you find our work helpful, please cite us:
 ```bibtex
 @article{adaptllm,
-  author       = {Daixuan Cheng and Shaohan Huang and Furu Wei},
   title        = {Adapting Large Language Models via Reading Comprehension},
+  author       = {Daixuan Cheng and Shaohan Huang and Furu Wei},
   journal      = {CoRR},
   volume       = {abs/2309.09530},
   year         = {2023}
 }
-```
+```