Update README.md

README.md

@@ -17,30 +17,53 @@ pipeline_tag: text-generation
 * **Language(s)**: English
 * **Library**: [HuggingFace Transformers](https://github.com/huggingface/transformers)
 * **License**: Fine-tuned checkpoints is licensed under the Non-Commercial Creative Commons license ([CC BY-NC-4.0](https://creativecommons.org/licenses/by-nc/4.0/))
-* **Where to send comments**: Instructions on how to provide feedback or comments on a model can be found by opening an issue in the [Hugging Face community's model repository](https://huggingface.co/upstage/Llama-2-70b-instruct-1024/discussions)
+* **Where to send comments**: Instructions on how to provide feedback or comments on a model can be found by opening an issue in the [Hugging Face community's model repository](https://huggingface.co/upstage/Llama-2-70b-instruct-v2/discussions)
 * **Contact**: For questions and comments about the model, please email [[email protected]](mailto:[email protected])
 
 ## Dataset Details
 
 ### Used Datasets
 - Orca-style dataset
+- Alpaca-Style Dataset
+
 
 ### Prompt Template
 ```
 ### System:
 {System}
-
 ### User:
 {User}
-
 ### Assistant:
 {Assistant}
 ```
+### Usage
+- Tested on A100 80GB
+- Our model can handle under 10k input tokens thanks to the `rope_scaling` option
+
+```python
+import torch
+from transformers import AutoModelForCausalLM, AutoTokenizer, TextStreamer
+tokenizer = AutoTokenizer.from_pretrained("upstage/Llama-2-70b-instruct-v2")
+model = AutoModelForCausalLM.from_pretrained(
+    "upstage/Llama-2-70b-instruct-v2",
+    device_map='auto',
+    torch_dtype=torch.float16,
+    load_in_8bit=True,
+    rope_scaling={'type': 'dynamic', 'factor': 2} # longer inputs possible
+)
+prompt = "### User:\nThomas is very healthy, but he has to go to the hospital every day. What could be the reasons?\n\n### Assistant:\n"
+inputs = tokenizer(prompt, return_tensors="pt").to(model.device)
+del inputs['token_type_ids']
+streamer = TextStreamer(tokenizer, skip_prompt=True, skip_special_tokens=True)
+output = model.generate(**inputs, streamer=streamer, use_cache=True, max_new_tokens=float('inf'))
+output_text = tokenizer.decode(output[0], skip_special_tokens=True)
+```
+
 
 ## Hardware and Software
 
 * **Hardware**: We utilized an A100x8 * 4 for training our model
-* **Training Factors**: We fine-tuned this model using a combination of the [DeepSpeed library](https://github.com/microsoft/DeepSpeed) and the [HuggingFace trainer](https://huggingface.co/docs/transformers/main_classes/trainer)
+* **Training Factors**: We fine-tuned this model using a combination of the [DeepSpeed library](https://github.com/microsoft/DeepSpeed) and the [HuggingFace trainer](https://huggingface.co/docs/transformers/main_classes/trainer) / [HuggingFace Accelerate](https://huggingface.co/docs/accelerate/index)
 
 ## Evaluation Results
 
@@ -49,14 +72,13 @@ pipeline_tag: text-generation
 We evaluated our model on four benchmark datasets, which include `ARC-Challenge`, `HellaSwag`, `MMLU`, and `TruthfulQA`.
 We used the [lm-evaluation-harness repository](https://github.com/EleutherAI/lm-evaluation-harness), specifically commit [b281b0921b636bc36ad05c0b0b0763bd6dd43463](https://github.com/EleutherAI/lm-evaluation-harness/tree/b281b0921b636bc36ad05c0b0b0763bd6dd43463).
 
-
 ### Main Results
 | Model | H4(Avg) | ARC | HellaSwag | MMLU | TruthfulQA | | MT_Bench |
 |--------------------------------------------------------------------|----------|----------|----------|------|----------|-|-------------|
 | **[Llama-2-70b-instruct-v2](https://huggingface.co/upstage/Llama-2-70b-instruct-v2)**(***Ours***, ***Local Reproduction***) | **72.7** | **71.6** | **87.7** | 69.7 | **61.6** | | **7.44063** |
 | [Llama-2-70b-instruct](https://huggingface.co/upstage/Llama-2-70b-instruct) (Ours, Open LLM Leaderboard) | 72.3 | 70.9 | 87.5 | **69.8** | 61 | | 7.24375  |
 | [llama-65b-instruct](https://huggingface.co/upstage/llama-65b-instruct) (Ours, Open LLM Leaderboard) | 69.4 | 67.6 | 86.5 | 64.9 | 58.8 | | |
-| Llama-2-70b-hf | 67.3 | 67.3 | 87.3 | 69.8 | 44.9 | | |
+| Llama-2-70b-hf | 67.3 | 67.3 | 87.3 | **69.8** | 44.9 | | |
 | [llama-30b-instruct-2048](https://huggingface.co/upstage/llama-30b-instruct-2048) (Ours, Open LLM Leaderboard) | 67.0 | 64.9 | 84.9 | 61.9 | 56.3 | | |
 | [llama-30b-instruct](https://huggingface.co/upstage/llama-30b-instruct) (Ours, Open LLM Leaderboard) | 65.2 | 62.5 | 86.2 | 59.4 | 52.8 | | |
 | llama-65b | 64.2 | 63.5 | 86.1 | 63.9 | 43.4 | | |
@@ -67,10 +89,8 @@ We used the [lm-evaluation-harness repository](https://github.com/EleutherAI/lm-
 ```
 # clone the repository
 git clone https://github.com/EleutherAI/lm-evaluation-harness.git
-
 # check out the specific commit
 git checkout b281b0921b636bc36ad05c0b0b0763bd6dd43463
-
 # change to the repository directory
 cd lm-evaluation-harness
 ```