Update README.md

Still in progress...

README.md

@@ -1,11 +1,222 @@
 ---
 license: llama2
+language:
+- en
+library_name: transformers
+pipeline_tag: text-generation
+datasets:
+- Open-Orca/OpenOrca
 ---
 
-Usage: 
+<p><h1>🐋 The Second OpenOrca Model Preview! 🐋</h1></p>
 
-1. [Install OpenChat](https://github.com/imoneoi/openchat/#installation)
 
-2. `python -m ochat.serving.openai_api_server --model-type openchat_llama2 --model Open-Orca/Llama2_GPT4_1M --engine-use-ray --worker-use-ray --max-num-batched-tokens 5120`
+![OpenOrca Logo](https://huggingface.co/datasets/Open-Orca/OpenOrca/resolve/main/OpenOrcaLogo.png "OpenOrca Logo")
 
-To use features such as tensor parallelism on consumer GPUs, API keys and logging, follow the OpenChat documentation.
+
+# OpenOrca x OpenChat - Preview2 - 13B
+
+We have used our own [OpenOrca dataset](https://huggingface.co/datasets/Open-Orca/OpenOrca) to fine-tune Llama2-13B using [OpenChat](https://huggingface.co/openchat) packing and conditional behavior cloning.
+This dataset is our attempt to reproduce the dataset generated for Microsoft Research's [Orca Paper](https://arxiv.org/abs/2306.02707).
+
+This second preview release is trained on a curated filtered subset of most of our GPT4 augmented data.
+
+This release highlights that our dataset and training methods have surpassed performance parity with the Orca paper.
+As well, this is done with ~1/3rd the compute requirement and using <20% of the dataset size from the original Orca paper.
+
+We have run extensive evaluations internally and expect this model to place number 1 on both the HuggingFaceH4 Open LLM Leaderboard and the GPT4ALL Leaderboard for 13B models.
+
+"One" of [OpenChat](https://huggingface.co/openchat) has joined our team, and we'd like to provide special thanks for their training of this model!
+We have utilized OpenChat conditional behavior cloning and [MultiPack algorithm](https://github.com/imoneoi/multipack_sampler) which achieves 99.85% bin-packing efficiency on our dataset.
+This has significantly reduced training time, with efficiency improvement of 3-10X over traditional methods.
+
+
+<img src="https://raw.githubusercontent.com/imoneoi/openchat/master/assets/logo_new.png" style="width: 40%">
+
+
+Want to visualize our full (pre-filtering) dataset? Check out our [Nomic Atlas Map](https://atlas.nomic.ai/map/c1b88b47-2d9b-47e0-9002-b80766792582/2560fd25-52fe-42f1-a58f-ff5eccc890d2).
+
+
+[<img src="https://huggingface.co/Open-Orca/OpenOrca-Preview1-13B/resolve/main/OpenOrca%20Nomic%20Atlas.png" alt="Atlas Nomic Dataset Map" width="400" height="400" />](https://atlas.nomic.ai/map/c1b88b47-2d9b-47e0-9002-b80766792582/2560fd25-52fe-42f1-a58f-ff5eccc890d2)
+
+
+We are in-process with training more models, so keep a look out on our org for releases coming soon with exciting partners.
+
+We will also give sneak-peak announcements on our Discord, which you can find here:
+
+https://AlignmentLab.ai
+
+
+# Evaluation
+
+We have evaluated **OpenOrcaxOpenChat-Preview2-13B** on hard reasoning tasks from BigBench-Hard and AGIEval as outlined in the Orca paper.
+
+Our average performance for BigBench-Hard: 0.488
+
+Average for AGIEval: 0.441
+
+In the Orca paper, they measured their score relative to Vicuna on these evals.
+We've done the same and have found our score averages to >103% of the total improvement that was shown in the Orca paper, using the same evaluation methods as outlined in the paper.
+
+So we are surpassing Orca performance with <20% of the dataset size and ~1/3rd the training budget!
+
+## BigBench-Hard Performance
+
+![OpenOrca Preview2 BigBench-Hard Performance](https://huggingface.co/Open-Orca/OpenOrcaxOpenChat-Preview2-13B/resolve/main/OO_Preview2_BigBenchHard.png "BigBench-Hard Performance")
+
+## AGIEval Performance
+
+![OpenOrca Preview2 AGIEval Performance](https://huggingface.co/Open-Orca/OpenOrcaxOpenChat-Preview2-13B/resolve/main/OO_Preview2_AGIEval.png "AGIEval Performance")
+
+## HuggingFaceH4 Open LLM Leaderboard Performance
+
+We have run our own tests using parameters matching the [HuggingFaceH4 Open LLM Leaderboard](https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard) evals.
+We find 
+
+![OpenOrca Preview2 HuggingFace Leaderboard Performance](https://huggingface.co/Open-Orca/OpenOrcaxOpenChat-Preview2-13B/resolve/main/OO_Preview2_HFLeaderboard.png "GPT4ALL Performance")
+
+## GPT4ALL Leaderboard Performance
+
+We have tested using parameters matching the GPT4ALL Benchmark Suite and report our results and placement vs their official reporting below.
+We place #1 for all open models and come within comparison of text-davinci-003, a proprietary model an order of magnitude larger.
+
+![OpenOrca Preview2 GPT4ALL Performance](https://huggingface.co/Open-Orca/OpenOrcaxOpenChat-Preview2-13B/resolve/main/OO_Preview2_AGIEval.png "GPT4ALL Performance")
+
+# Dataset
+
+We used a curated, filtered selection of most of the GPT-4 augmented data from our OpenOrca dataset, which aims to reproduce the Orca Research Paper dataset.
+Further details of our curation practices will be forthcoming with our full model release.
+
+
+# Training
+
+We trained with 8x A100-80G GPUs for 170 hours, completing 5 epochs of full fine tuning on our dataset.
+This contrasts with the 20x A100-80G GPUs for 200 hours used in the Orca paper, for only 3 epochs.
+Our compute requirement was ~1/3rd that of the original Orca.
+Commodity cost was ~$2,300.
+
+Please await our full releases for further training details.
+
+
+# Prompt Template
+
+We use our own prompt template which we call "``"
+
+
+# Serving
+
+This model is most easily served with [OpenChat's](https://github.com/imoneoi/openchat) customized vLLM OpenAI-compatible API server.
+We also illustrate setup of Oobabooga/text-generation-webui below.
+
+
+## Serving with OpenChat
+
+[Install OpenChat](https://github.com/imoneoi/openchat/#installation)
+
+After installation, run:
+
+```bash
+python -m ochat.serving.openai_api_server \
+  --model-type openchat_llama2 \
+  --model Open-Orca/OpenOrcaxOpenChat-Preview2-13B \
+  --engine-use-ray --worker-use-ray --max-num-batched-tokens 5120
+```
+
+Follow the OpenChat documentation to use features such as tensor parallelism on consumer GPUs, API keys, and logging.
+You may then connect to the OpenAI-compatible API endpoint with tools such as [BetterGPT.chat](https://bettergpt.chat).
+
+## Serving with Oobabooga / text-generation-webui
+
+The model may also be loaded via [oobabooga/text-generation-webui](https://github.com/oobabooga/text-generation-webui/) in a similar manner to other models.
+See the requirements below.
+
+### Oobabooga Key Requirements
+
+* You will first need to download the model as you normally do to the "`models/`" folder of your text-generation-webui installation.
+* To use the unquantized model presented here, select "`Transformers`"" in the webui's "`Model`" tab "`Model loader`" dropdown.
+  * You will likely want to tick "`auto-devices`". The model will require >30GB VRAM after loading in context for inference.
+  * The model was trained in bf16, so tick the "`bf16`" box for best performance.
+  * It will run safely on single GPUs with VRAM >=48GB (e.g. A6000)
+    * If using consumer GPUs, e.g. 2x RTX3090 24GB, you will likely want to enter "18,17" under tensor_split to split the model across both GPUs
+* The model will perform significantly better if you use the appropriate prompting template
+  * We will submit a PR to include our prompting template into text-generation-webui soon
+  * For now, manually enter the settings described in the following sections:
+
+### Oobabooga Chat Settings
+
+In the "`Chat settings`" tab, select the following settings:
+
+For "`User String`" ...
+```
+User:
+```
+For "`Bot string`" ...
+```
+Assistant:
+```
+For "`Context`", it is not necessary but we have found good results with ...
+```
+You are a helpful assistant. Please answer truthfully and write out your thinking step by step to be sure you get the right answer. If you make a mistake or encounter an error in your thinking, say so out loud and attempt to correct it. If you don't know or aren't sure about something, say so clearly. You will act as a professional logician, mathematician, and physicist. You will also act as the most appropriate type of expert to answer any particular question or solve the relevant problem; state which expert type your are, if so. Also think of any particular named expert that would be ideal to answer the relevant question or solve the relevant problem; name and act as them, if appropriate.
+```
+For "`Turn template`", this is absolutely essential to have. You will get poor, mixed up output without this template ...
+```
+<|user|> <|user-message|><|end_of_turn|>\n<|bot|> <|bot-message|>\n
+```
+
+When done, it should look as below:
+<img src="https://huggingface.co/Open-Orca/OpenOrcaxOpenChat-Preview2-13B/resolve/main/Images/OpenOrcaLlama2OobaboogaChatInstructionTemplate.png" style="width: 40%">
+
+You may then save this as a named template preset by clicking the "Floppy" icon and giving it an appropriate name in the popup, e.g. "`OpenOrcaxOpenChat Llama2`".
+
+### Oobabooga Text Generation Mode
+
+In the "`Text generation`" tab, select "`instruct`" as the mode:
+
+#### Mode Illustration
+It should look as below:
+<img src="https://huggingface.co/Open-Orca/OpenOrcaxOpenChat-Preview2-13B/resolve/main/Images/OpenOrcaLlama2OobaboogaInstructMode.png" style="width: 40%">
+
+
+# Citation
+
+```bibtex
+@software{OpenOrca_Preview2,
+  title = {OpenOrca_Preview2: A Llama2-13B Model Instruct-tuned on Filtered OpenOrcaV1 GPT-4 Dataset},
+  author = {Wing Lian and Bleys Goodson and Guan Wang and Eugene Pentland and Austin Cook and Chanvichet Vong` and "Teknium"},
+  year = {2023},
+  publisher = {HuggingFace},
+  journal = {HuggingFace repository},
+  howpublished = {\url{https://https://huggingface.co/Open-Orca/OpenOrca-Preview2-13B},
+}
+@software{openchat,
+  title = {{OpenChat: Advancing Open-source Language Models with Imperfect Data}},
+  author = {Wang, Guan and Cheng, Sijie and Yu, Qiying and Liu, Changling},
+  doi = {10.5281/zenodo.8105775},
+  url = {https://github.com/imoneoi/openchat},
+  version = {pre-release},
+  year = {2023},
+  month = {7},
+}
+@misc{mukherjee2023orca,
+      title={Orca: Progressive Learning from Complex Explanation Traces of GPT-4}, 
+      author={Subhabrata Mukherjee and Arindam Mitra and Ganesh Jawahar and Sahaj Agarwal and Hamid Palangi and Ahmed Awadallah},
+      year={2023},
+      eprint={2306.02707},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL}
+}
+@misc{longpre2023flan,
+      title={The Flan Collection: Designing Data and Methods for Effective Instruction Tuning}, 
+      author={Shayne Longpre and Le Hou and Tu Vu and Albert Webson and Hyung Won Chung and Yi Tay and Denny Zhou and Quoc V. Le and Barret Zoph and Jason Wei and Adam Roberts},
+      year={2023},
+      eprint={2301.13688},
+      archivePrefix={arXiv},
+      primaryClass={cs.AI}
+}
+@software{touvron2023llama,
+  title={LLaMA: Open and Efficient Foundation Language Models},
+  author={Touvron, Hugo and Lavril, Thibaut and Izacard, Gautier and Martinet, Xavier and Lachaux, Marie-Anne and Lacroix, Timoth{\'e}e and Rozi{\`e}re, Baptiste and Goyal, Naman and Hambro, Eric and Azhar, Faisal and Rodriguez, Aurelien and Joulin, Armand and Grave, Edouard and Lample, Guillaume},
+  journal={arXiv preprint arXiv:2302.13971},
+  year={2023}
+}
+```