Create README.md

README.md

@@ -0,0 +1,110 @@
+---
+model-index:
+- name: llama-3.1-tulu-2-dpo-8b
+  results: []
+datasets:
+- allenai/tulu-v2-sft-mixture
+- argilla/ultrafeedback-binarized-preferences-cleaned
+language:
+- en
+base_model: allenai/llama-3.1-tulu-2-8b
+license: apache-2.0
+---
+
+
+<img src="https://huggingface.co/datasets/allenai/blog-images/resolve/main/tulu-v2/Tulu%20V2%20banner.png" alt="TuluV2 banner" width="800" style="margin-left:'auto' margin-right:'auto' display:'block'"/>
+
+
+# Model Card for Llama 3.1 Tulu V2+DPO 8B
+
+Tulu is a series of language models that are trained to act as helpful assistants. 
+Llama 3.1 Tulu V2 8B is a fine-tuned version of Llama 3 that was trained on a mix of publicly available, synthetic and human datasets.
+It was then further trained using [DPO]((https://arxiv.org/abs/2305.18290) on the [UltraFeedback](https://huggingface.co/datasets/argilla/ultrafeedback-binarized-preferences-cleaned) dataset.
+
+For more details on the training mixture, read the paper: [Camels in a Changing Climate: Enhancing LM Adaptation with Tulu 2
+](https://arxiv.org/abs/2311.10702).
+
+**Built with Meta Llama 3.1!**
+Note that Llama 3.1 is released under the Meta Llama 3 community license, included here under `llama_3_license.txt`.
+
+## Model description
+
+- **Model type:** A model trained on a mix of publicly available, synthetic and human-created datasets.
+- **Language(s) (NLP):** Primarily English
+- **License:** Apache 2.0
+- **Finetuned from model:** [meta-llama/Meta-Llama-3.1-8B](https://huggingface.co/meta-llama/Meta-Llama-3.1-8B)
+
+### Model Sources
+
+- **Repository:** https://github.com/allenai/open-instruct
+- **Model Family:** Other models and the dataset are found in the [Tulu V2 collection](https://huggingface.co/collections/allenai/tulu-v2-suite-6551b56e743e6349aab45101).
+
+## Performance
+
+| Model | MMLU 5-shot | GSM8k 8-shot cot | BBH 3-shot cot | TydiQA 1-shot Gold Passage | Codex HumanEval Pass@10 |AlpacaEval 1 | AlpacaEval 2 LC | TruthfulQA %Info+True | IFEval loose acc | XSTest safe but ref. | XSTest unsafe but follow | Average |
+|-|-|-|-|-|-|-|-|-|-|-|-|-|
+| [Llama 3 8b base](https://huggingface.co/meta-llama/Meta-Llama-3-8B)        | 0.649    | 0.565    | 0.653    | 66.80    | 0.664    | -        | -        | 0.299    | 0.146    | 0.200     | 0.390     | 54.36     |
+| [Llama 3 8b instruct](https://huggingface.co/meta-llama/Meta-Llama-3-8B-Instruct)    | 0.626    | 0.770    | 0.606    | 59.04    | 0.799    | 94.65    | 23.12    | 0.682    | 0.741    | 0.028     | 0.115     | 70.36     |
+| [Llama 3 Tulu 2 8b](https://huggingface.co/allenai/llama-3-tulu-2-8b)      | 0.606    | 0.610    | 0.592    | 56.24    | 0.685    | 79.40    | 10.16    | 0.503    | 0.468    | 0.092     | 0.165     | 59.39     |
+| **[Llama 3 Tulu 2+DPO 8b](https://huggingface.co/allenai/llama-3-tulu-2-dpo-8b)  (this model)**     | 0.609    | 0.650    | 0.584    | 21.18    | 0.688    | 93.02    | 13.94    | 0.698    | 0.518    | 0.092     | 0.165     | 59.61     |
+| [Llama 3 70b base](https://huggingface.co/meta-llama/Meta-Llama-3-70B)       | 0.790    | 0.840    | 0.801    | 73.35    | 0.745    | -        | -        | 0.469    | 0.163    | 0.256     | 0.330     | 65.60     |
+| [Llama 3 70b instruct](https://huggingface.co/meta-llama/Meta-Llama-3-70B-Instruct)   | 0.786    | 0.930    | 0.801    | 59.21    | 0.908    | 96.71    | 39.99    | 0.701    | 0.828    | 0.060     | 0.140     | 79.22     |
+| [Llama 3 Tulu 2 70b](https://huggingface.co/allenai/llama-3-tulu-2-70b) | 0.752    | 0.845    | 0.779    | 69.798   | 0.861    | 86.007   | 17.51    | 0.646    | 0.591    | 0.108     | 0.130     | 73.01     |
+| [Llama 3 Tulu 2+DPO 70b](https://huggingface.co/allenai/llama-3-tulu-2-dpo-70b) | 0.754    | 0.860    | 0.785    | 23.443   | 0.878    | 96.65    | 27.34    | 0.780    | 0.643    | 0.080     | 0.140     | 71.60     |
+
+We also release reward models based off Llama 3 8b and 70b respectively:
+- [Llama 3 Tulu 2 8b UltraFeedback RM](https://huggingface.co/allenai/llama-3-tulu-2-8b-uf-mean-rm)
+- [Llama 3 Tulu 2 70b UltraFeedback RM](https://huggingface.co/allenai/llama-3-tulu-2-70b-uf-mean-rm)
+
+## Input Format
+
+The model is trained to use the following format (note the newlines):
+```
+<|user|>
+Your message here!
+<|assistant|>
+```
+
+For best results, format all inputs in this manner. **Make sure to include a newline after `<|assistant|>`, this can affect generation quality quite a bit.**
+
+
+## Intended uses & limitations
+
+The model was initially fine-tuned on the [Tulu V2 mix dataset](https://huggingface.co/datasets/allenai/tulu-v2-sft-mixture), which contains a diverse range of human created instructions and synthetic dialogues generated primarily by other LLMs. 
+We then further aligned the model with a [Jax DPO trainer](https://github.com/hamishivi/EasyLM/blob/main/EasyLM/models/llama/llama_train_dpo.py) built on [EasyLM](https://github.com/young-geng/EasyLM) on the [openbmb/UltraFeedback](https://huggingface.co/datasets/openbmb/UltraFeedback) dataset, which contains 64k prompts and model completions that are ranked by GPT-4. 
+
+
+## Bias, Risks, and Limitations
+
+
+The Tulu models have not been aligned to generate safe completions within the RLHF phase or deployed with in-the-loop filtering of responses like ChatGPT, so the model can produce problematic outputs (especially when prompted to do so). 
+It is also unknown what the size and composition of the corpus was used to train the base Llama 3 models, however it is likely to have included a mix of Web data and technical sources like books and code. See the [Falcon 180B model card](https://huggingface.co/tiiuae/falcon-180B#training-data) for an example of this.
+
+
+### DPO Training hyperparameters
+
+The following hyperparameters were used during DPO training:
+- learning_rate: 5e-7
+- total_train_batch_size: 32
+- optimizer: Adam with betas=(0.9,0.999) and epsilon=1e-08
+- lr_scheduler_type: linear
+- lr_scheduler_warmup_ratio: 0.1
+- num_epochs: 3.0
+
+
+## Citation
+
+If you find Tulu 2 is useful in your work, please cite it with:
+
+```
+@misc{ivison2023camels,
+      title={Camels in a Changing Climate: Enhancing LM Adaptation with Tulu 2}, 
+      author={Hamish Ivison and Yizhong Wang and Valentina Pyatkin and Nathan Lambert and Matthew Peters and Pradeep Dasigi and Joel Jang and David Wadden and Noah A. Smith and Iz Beltagy and Hannaneh Hajishirzi},
+      year={2023},
+      eprint={2311.10702},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL}
+}
+```
+
+*Model card adapted from [Zephyr Beta](https://huggingface.co/HuggingFaceH4/zephyr-7b-beta/blob/main/README.md)*