Update README.md

README.md

@@ -1,65 +1,81 @@
----
-license: apache-2.0
-tags:
-- openchat
-- mistral
-- C-RLFT
-datasets:
-- openchat/openchat_sharegpt4_dataset
-- kaist-ai/Feedback-Collection
-- imone/OpenOrca_FLAN
-- LDJnr/LessWrong-Amplify-Instruct
-- LDJnr/Pure-Dove
-- LDJnr/Verified-Camel
-- tiedong/goat
-- glaiveai/glaive-code-assistant
-- meta-math/MetaMathQA
-- OpenAssistant/oasst_top1_2023-08-25
-- TIGER-Lab/MathInstruct
-library_name: transformers
-pipeline_tag: text-generation
----
 
 <div align="center">
   <img src="https://raw.githubusercontent.com/imoneoi/openchat/master/assets/logo_new.png" style="width: 65%">
+  <h1>Advancing Open-source Language Models with Mixed-Quality Data</h1>
 </div>
 
-<p align="center">
-  <a href="https://github.com/imoneoi/openchat">GitHub Repo</a> •
-  <a href="https://openchat.team">Online Demo</a> •
-  <a href="https://discord.gg/pQjnXvNKHY">Discord</a> •
-  <a href="https://twitter.com/imonenext">Twitter</a> •
-  <a href="https://huggingface.co/openchat">Huggingface</a> •
-  <a href="https://arxiv.org/pdf/2309.11235.pdf">Paper</a>
+<p align="center" style="margin-top: 0px;">
+  <a href="https://openchat.team">
+    <img src="https://github.com/alpayariyak/openchat/blob/master/assets/logo_nobg.png?raw=true" alt="OpenChat Logo" style="width:20px; vertical-align: middle; display: inline-block; margin-right: 5px; margin-left: 10px; margin-top: 0px; margin-bottom: 0px;"/>
+    <span class="link-text" style=" margin-right: 5px;">OpenChat Online Demo</span>
+  </a> |
+  <a href="https://github.com/imoneoi/openchat">
+    <img src="https://camo.githubusercontent.com/4133dc1cd4511d4a292b84ce10e52e4ed92569fb2a8165381c9c47be5edc2796/68747470733a2f2f6564656e742e6769746875622e696f2f537570657254696e7949636f6e732f696d616765732f706e672f6769746875622e706e67" alt="GitHub Logo" style="width:20px; vertical-align: middle; display: inline-block; margin-right: 5px; margin-left: 5px; margin-top: 0px; margin-bottom: 0px;"/>
+    <span class="link-text" style=" margin-right: 5px;">GitHub</span>
+  </a> |
+  <a href="https://arxiv.org/pdf/2309.11235.pdf">
+    <img src="https://github.com/alpayariyak/openchat/blob/master/assets/arxiv-logomark-small-square-border.png?raw=true" alt="ArXiv Logo" style="width:20px; vertical-align: middle; display: inline-block; margin-right: 5px; margin-left: 5px; margin-top: 0px; margin-bottom: 0px;"/>
+    <span class="link-text" style="margin-right: 5px;">Paper</span>
+  </a> |
+  <a href="https://discord.gg/pQjnXvNKHY">
+    <img src="https://cloud.githubusercontent.com/assets/6291467/26705903/96c2d66e-477c-11e7-9f4e-f3c0efe96c9a.png" alt="Discord Logo" style="width:20px; vertical-align: middle; display: inline-block; margin-right: 5px; margin-left: 5px; margin-top: 0px; margin-bottom: 0px;"/>
+    <span class="link-text">Discord</span>
+  </a>
 </p>
 
-# OpenChat 3.5: First Update Released on December 10th!
-
-**🚀 15-point improvement in coding performance**
-
-**💡 Introducing a coding & generalist mode and a mathematical reasoning mode**
-
-**🧑‍⚖️ Experimental support for evaluator and feedback capabilities**
-
-**🤖 Outperforms Grok-1 in 3/4 and ChatGPT (March) in 5/8 benchmarks**
+<hr>
+<div style="background-color: white; padding: 0.7em; border-radius: 0.5em; color: black; display: flex; flex-direction: column; justify-content: center; text-align: center;">
+  <a href="https://huggingface.co/openchat/openchat_3.5" style="text-decoration: none; color: black;">
+  <span style="font-size: 0.7em;  font-family: 'Helvetica'; color:  white; vertical-align: top;  background-color:white;  border-radius: 6em; padding: 0.04em 0.4em; letter-spacing: 0.1em; font-weight: bold">3.51210</span>
+    <span style="font-size: 1.7em; font-family: 'Helvetica'; letter-spacing: 0.1em; font-weight: bold; color: black;">OPENCHAT</span><span style="font-size: 1.8em; font-family: 'Helvetica'; color: #3c72db; ">3.5</span>
+        <span style="font-size: 0.7em;  font-family: 'Helvetica'; color:  white; vertical-align: top;  background-color:red;  border-radius: 6em; padding: 0.066em 0.4em; letter-spacing: 0.1em; font-weight: bold;">1210</span>
+    <span style="font-size: 1em; font-family: 'Helvetica'; color: black;">
+    <br> 🤖 Outperforms <span style="font-weight: bold;">ChatGPT</span> (March) and <span style="font-weight: bold;">Grok-1</span>  on most benchmarks 🤖
+      <br> 🚀<span style="font-size: 1em; font-family: 'Helvetica'; color: black; font-weight: bold;">15</span>-point improvement in Coding Performance over <span style="font-size: 0.9em;
+      font-family: 'Helvetica'; color: black; font-weight: bold;">OpenChat-3.5🚀</span>
+      <br><span style="font-size: 1em; font-family: 'Helvetica'; color: #3c72db; font-weight: bold;">New Features</span>
+      <br> 💡 2 Modes: Coding + Generalist, Mathematical Reasoning 💡
+      <br> 🧑‍⚖️ Experimental support for Evaluator and Feedback capabilities 🧑‍⚖️
+    </span>
+  </a>
+</div>
 
-| Model                       | Size     | HumanEval+ pass@1 |
-|-----------------------------|----------|------------|
-| ChatGPT (December 12, 2023) | -        | 64.6       |
-| WizardCoder-Python-34B-V1.0 | 34B      | 64.6       |
-| **OpenChat 3.5 (Dec 10)**   | **7B**   | **63.4**   |
-| OpenHermes 2.5              | 7B       | 41.5       |
+<!-- <a href="https://huggingface.co/openchat/openchat_3.5">
+  <button class="common-button">Model Repo</button>
+</a>
+<a href="https://openchat.team">
+  <button class="common-button">OpenChatUI Demo</button>
+</a>
+<a href="https://huggingface.co/spaces/openchat/openchat_3.5">
+  <button class="common-button">HuggingFace Space</button>
+</a>
+<a href="https://arxiv.org/pdf/2309.11235.pdf">
+  <button class="common-button">Paper</button>
+</a>
+ -->
+</p>
 
 <div style="display: flex; justify-content: center; align-items: center">
-  <img src="https://raw.githubusercontent.com/imoneoi/openchat/master/assets/openchat.png" style="width: 45%;">
-  <img src="https://raw.githubusercontent.com/imoneoi/openchat/master/assets/openchat_grok.png" style="width: 45%;">
+  <img src="https://github.com/alpayariyak/openchat/blob/master/assets/1210bench.png?raw=true" style="width: 100%; border-radius: 1em">">
 </div>
 
-OpenChat is an innovative library of open-source language models, fine-tuned with [C-RLFT](https://arxiv.org/pdf/2309.11235.pdf) - a strategy inspired by offline reinforcement learning. Our models learn from mixed-quality data without preference labels, delivering exceptional performance on par with ChatGPT, even with a 7B model. Despite our simple approach, we are committed to developing a high-performance, commercially viable, open-source large language model, and we continue to make significant strides toward this vision.
+<div>
+<h3> Table of Contents</h3>
+</div>
 
-[![DOI](https://zenodo.org/badge/645397533.svg)](https://zenodo.org/badge/latestdoi/645397533)
 
-## Usage
+1. [Usage](#usage)
+2. [Benchmarks](#benchmarks)
+3. [Limitations](#limitations)
+4. [License](#license)
+5. [Dataset Details](#dataset-details)
+6. [Citation](#citation)
+7. [Acknowledgements](#acknowledgements)
+
+
+<div align="center">
+<h2> Usage </h2>
+</div>
 
 To use this model, we highly recommend installing the OpenChat package by following the [installation guide](https://github.com/imoneoi/openchat#installation) in our repository and using the OpenChat OpenAI-compatible API server by running the serving command from the table below. The server is optimized for high-throughput deployment using [vLLM](https://github.com/vllm-project/vllm) and can run on a consumer GPU with 24GB RAM. To enable tensor parallelism, append `--tensor-parallel-size N` to the serving command.
 
@@ -115,7 +131,7 @@ Math Correct User: 10.3 − 7988.8133=<|end_of_turn|>Math Correct Assistant:
 
 ⚠️ **Notice:** Remember to set `<|end_of_turn|>` as end of generation token.
 
-The default (GPT4 Correct) template is also available as the integrated `tokenizer.chat_template`, 
+The default (GPT4 Correct) template is also available as the integrated `tokenizer.chat_template`,
 which can be used instead of manually specifying the template:
 
 ```python
@@ -128,8 +144,9 @@ tokens = tokenizer.apply_chat_template(messages, add_generation_prompt=True)
 assert tokens == [1, 420, 6316, 28781, 3198, 3123, 1247, 28747, 22557, 32000, 420, 6316, 28781, 3198, 3123, 21631, 28747, 15359, 32000, 420, 6316, 28781, 3198, 3123, 1247, 28747, 1602, 460, 368, 3154, 28804, 32000, 420, 6316, 28781, 3198, 3123, 21631, 28747]
 ```
 
-## 🧑‍⚖️ (Experimental) Evaluator / Feedback Capabilities
-
+<div align="center">
+<h2> (Experimental) Evaluator / Feedback Capabilities </h2>
+</div>
 We've included evaluator capabilities in this release to advance open-source models as evaluators. You can use `Default Mode (GPT4 Correct)` with the following prompt (same as [Prometheus](https://huggingface.co/datasets/kaist-ai/Feedback-Collection)) to evaluate a response.
 
 ```
@@ -159,19 +176,9 @@ Score 5: {orig_score5_description}
 
 ###Feedback: 
 ```
-
-## Comparison with [X.AI Grok models](https://x.ai/)
-
-|                   | License     | # Param | Average  | MMLU | HumanEval | MATH     | GSM8k    |
-|-------------------|-------------|---------|----------|------|-----------|----------|----------|
-| OpenChat 3.5 1210 | Apache-2.0  | **7B**  | **60.1** | 65.3 | **68.9**  | **28.9** | **77.3** |
-| OpenChat 3.5      | Apache-2.0  | **7B**  | 56.4     | 64.3 | 55.5      | 28.6     | **77.3** |
-| Grok-0            | Proprietary | 33B     | 44.5     | 65.7 | 39.7      | 15.7     | 56.8     |
-| Grok-1            | Proprietary | ???B    | 55.8     | 73   | 63.2      | 23.9     | 62.9     |
-
-*: Grok results are reported by [X.AI](https://x.ai/).
-
-## <a id="benchmarks"></a> Benchmarks
+<div align="center">
+<h2> Benchmarks </h2>
+</div>
 
 | Model              | # Params | Average  | MT-Bench     | HumanEval       | BBH MC   | AGIEval  | TruthfulQA    | MMLU         | GSM8K        | BBH CoT     |
 |--------------------|----------|----------|--------------|-----------------|----------|----------|---------------|--------------|--------------|-------------|
@@ -183,9 +190,8 @@ Score 5: {orig_score5_description}
 | OpenOrca Mistral   | 7B       | 52.7     | 6.86         | 38.4            | 49.4     | 42.9     | 45.9          | 59.3         | 59.1         | 58.1        |
 | Zephyr-β^          | 7B       | 34.6     | 7.34         | 22.0            | 40.6     | 39.0     | 40.8          | 39.8         | 5.1          | 16.0        |
 | Mistral            | 7B       | -        | 6.84         | 30.5            | 39.0     | 38.0     | -             | 60.1         | 52.2         | -           |
-| Open-source SOTA** | 13B-70B  | 61.4     | 7.71         | 73.2            | 49.7     | 41.7     | 62.3          | 63.7         | 82.3         | 41.4        |
-|                    |          |          | WizardLM 70B | WizardCoder 34B | Orca 13B | Orca 13B | Platypus2 70B | WizardLM 70B | MetaMath 70B | Flan-T5 11B |
-
+<details>
+  <summary>Evaluation Details(click to expand)</summary>
 *: ChatGPT (March) results are from [GPT-4 Technical Report](https://arxiv.org/abs/2303.08774), [Chain-of-Thought Hub](https://github.com/FranxYao/chain-of-thought-hub), and our evaluation. Please note that ChatGPT is not a fixed baseline and evolves rapidly over time.
 
 ^: Zephyr-β often fails to follow few-shot CoT instructions, likely because it was aligned with only chat data but not trained on few-shot data.
@@ -193,15 +199,48 @@ Score 5: {orig_score5_description}
 **: Mistral and Open-source SOTA results are taken from reported results in instruction-tuned model papers and official repositories.
 
 All models are evaluated in chat mode (e.g. with the respective conversation template applied). All zero-shot benchmarks follow the same setting as in the AGIEval paper and Orca paper. CoT tasks use the same configuration as Chain-of-Thought Hub, HumanEval is evaluated with EvalPlus, and MT-bench is run using FastChat. To reproduce our results, follow the instructions in [our repository](https://github.com/imoneoi/openchat/#benchmarks).
+</details>
+<div>
+<h3>HumanEval+</h3>
+</div>
 
-## Limitations
+
+| Model                       | Size     | HumanEval+ pass@1 |
+|-----------------------------|----------|------------|
+| ChatGPT (December 12, 2023) | -        | 64.6       |
+| WizardCoder-Python-34B-V1.0 | 34B      | 64.6       |
+| **OpenChat 3.5 (Dec 10)**   | **7B**   | **63.4**   |
+| OpenHermes 2.5              | 7B       | 41.5       |
+
+<div>
+<h3>OpenChat-3.5-1210 vs. Grok</h3>
+</div>
+
+|                   | License     | # Param | Average  | MMLU | HumanEval | MATH     | GSM8k    |
+|-------------------|-------------|---------|----------|------|-----------|----------|----------|
+| OpenChat 3.5 1210 | Apache-2.0  | **7B**  | **60.1** | 65.3 | **68.9**  | **28.9** | **77.3** |
+| OpenChat 3.5      | Apache-2.0  | **7B**  | 56.4     | 64.3 | 55.5      | 28.6     | **77.3** |
+| Grok-0            | Proprietary | 33B     | 44.5     | 65.7 | 39.7      | 15.7     | 56.8     |
+| Grok-1            | Proprietary | ???B    | 55.8     | 73   | 63.2      | 23.9     | 62.9     |
+
+*: Grok results are reported by [X.AI](https://x.ai/).
+
+
+
+
+
+
+
+<div align="center">
+<h2> Limitations </h2>
+</div>
 
 **Foundation Model Limitations**
 Despite its advanced capabilities, OpenChat is still bound by the limitations inherent in its foundation models. These limitations may impact the model's performance in areas such as:
 
- - Complex reasoning
- - Mathematical and arithmetic tasks
- - Programming and coding challenges
+- Complex reasoning
+- Mathematical and arithmetic tasks
+- Programming and coding challenges
 
 **Hallucination of Non-existent Information**
 OpenChat may sometimes generate information that does not exist or is not accurate, also known as "hallucination". Users should be aware of this possibility and verify any critical information obtained from the model.
@@ -210,25 +249,31 @@ OpenChat may sometimes generate information that does not exist or is not accura
 OpenChat may sometimes generate harmful, hate speech, biased responses, or answer unsafe questions. It's crucial to apply additional AI safety measures in use cases that require safe and moderated responses.
 
 ## License
+<div align="center">
+<h2> License </h2>
+</div>
 
 Our OpenChat 3.5 code and models are distributed under the Apache License 2.0.
 
-## Dataset Details
+<div align="center">
+<h2> Dataset Details </h2>
+</div>
 
 OpenChat 3.5 was trained with C-RLFT on a collection of publicly available high-quality instruction data, with a custom processing pipeline. We detail some notable subsets included here:
 
- - [OpenChat ShareGPT](https://huggingface.co/datasets/openchat/openchat_sharegpt4_dataset)
- - [Open-Orca with FLAN answers](https://huggingface.co/datasets/imone/OpenOrca_FLAN)
- - [Feedback-Collection](https://huggingface.co/datasets/kaist-ai/Feedback-Collection)
- - Capybara [1](https://huggingface.co/datasets/LDJnr/Pure-Dove) [2](https://huggingface.co/datasets/LDJnr/Verified-Camel) [3](https://huggingface.co/datasets/LDJnr/LessWrong-Amplify-Instruct)
- - [GOAT](https://huggingface.co/datasets/tiedong/goat)
- - [Glaive](https://huggingface.co/datasets/glaiveai/glaive-code-assistant)
- - [MetaMathQA](https://huggingface.co/datasets/meta-math/MetaMathQA)
- - [MathInstruct](https://huggingface.co/datasets/TIGER-Lab/MathInstruct)
- - [OpenAssistant](https://huggingface.co/datasets/OpenAssistant/oasst_top1_2023-08-25)
-
-## Citation
+- [OpenChat ShareGPT](https://huggingface.co/datasets/openchat/openchat_sharegpt4_dataset)
+- [Open-Orca with FLAN answers](https://huggingface.co/datasets/imone/OpenOrca_FLAN)
+- [Feedback-Collection](https://huggingface.co/datasets/kaist-ai/Feedback-Collection)
+- Capybara [1](https://huggingface.co/datasets/LDJnr/Pure-Dove) [2](https://huggingface.co/datasets/LDJnr/Verified-Camel) [3](https://huggingface.co/datasets/LDJnr/LessWrong-Amplify-Instruct)
+- [GOAT](https://huggingface.co/datasets/tiedong/goat)
+- [Glaive](https://huggingface.co/datasets/glaiveai/glaive-code-assistant)
+- [MetaMathQA](https://huggingface.co/datasets/meta-math/MetaMathQA)
+- [MathInstruct](https://huggingface.co/datasets/TIGER-Lab/MathInstruct)
+- [OpenAssistant](https://huggingface.co/datasets/OpenAssistant/oasst_top1_2023-08-25)
 
+<div align="center">
+<h2> Citation </h2>
+</div>
 ```
 @article{wang2023openchat,
   title={OpenChat: Advancing Open-source Language Models with Mixed-Quality Data},
@@ -238,7 +283,9 @@ OpenChat 3.5 was trained with C-RLFT on a collection of publicly available high-
 }
 ```
 
-## Acknowledgements
+<div align="center">
+<h2> Acknowledgments </h2>
+</div>
 
 We extend our heartfelt gratitude to AutoMeta and caesus from Alignment Lab AI, LDJ and Teknium from Nous Research, alpin and TearGosling from Pygmalion AI for their substantial contributions to data collection and model training.