Update README.md

README.md

@@ -74,267 +74,95 @@ not currently in use
 
 </div>
 
-# 新闻
-
-- 2023-12-06: [SUS-Chat-34B
-  chat-ui](https://huggingface.co/spaces/SUSTech/SUS-Chat-34B)
-
-- 2023-12-05: SUS-Chat-34B在[Open LLM
-  leaderboard](https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard)排名第二，并在所有小于70B的模型中排名第一。
-
-- 2023-12-01: SUS-Chat-34B现已在HuggingFace🤗上可用。
-
-# 模型介绍
-
-![](https://hackmd.io/_uploads/HJlDtzhBa.png)
-
-**SUS-Chat-34B**模型是[南方科技大学](https://huggingface.co/SUSTech)联合[IDEA研究院CCNL团队](https://huggingface.co/IDEA-CCNL)开源的通用大模型，
-2023-12-05在Huggingface的权威榜单上[open_llm_leaderboard](https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard)取得了同级别模型最好成绩。
-
-SUS-Chat-34B是一个340亿参数规模的双语模型，基于[01-ai/Yi-34B](https://huggingface.co/01-ai/Yi-34B)预训练模型通过数百万高质量、多语言的指令数据进行了微调。
-在保持基础模型强大的语言能力的同时，SUS-Chat-34B模型通过高质量指令微调改善了模型对人类指令的响应方式，并擅长通过思维链的方式模仿人类思考过程。
-与[Yi-34B](https://huggingface.co/01-ai/Yi-34B)和[Yi-34B-chat](https://huggingface.co/01-ai/Yi-34B-Chat)相比，它不仅在几乎所有基准测试中提升了性能，而且能够更好地满足了复杂多语言任务的实际需求。
-在指令微调阶段，我们加入了大量高质量长文本和多轮对话指令数据，将文本窗口从基础模型的4K扩展到8K。
-这种扩展有助于模型更有效地遵循多轮对话中的指令，显著减少在扩展对话和长文本理解中上下文丢失的问题。为此我们也开发了更高效的训练框架，不久也将进行开源，敬请期待。
-
-SUS-Chat-34B模型具有以下亮点：
-
-1.  大规模复杂指令跟随数据：使用1.4B
-    token的高质量复杂指令数据进行训练，涵盖中英文、多轮对话、数学、推理等多种指令数据；
-2.  强大的通用任务性能：SUS-Chat-34B模型在众多主流的中英文任务上表现出色，其效果超越了相同参数规模的其他开源的指令微调模型。即使与更大参数规模的模型相比，SUS-Chat-34B模型也具有不错的竞争力；
-3.  更长的上下文窗口与出色的多轮对话能力：目前，SUS-Chat-34B原生支持8K的上下文窗口，在大量多轮指令以及单多轮混合数据中进行训练，具有出色的长文本对话信息关注与指令跟随能力。
-
-SUS-Chat-34B模型有力地证明了通过正确的指令微调，学术机构可以在不增加模型参数的情况下，通过开源的数据集和模型，获得更好的性能,
-这弥合了学术界和工业界的在大语言模型上的差距，为学术界和工业界的合作提供了新的可能性。
-
-# 模型性能
-
-为了更好地评估SUS-Chat-34B模型的性能，我们在多个基准测试中进行了评估，并开源了评估框架[TLEM](https://huggingface.co/spaces/SUSTech/tlem)，以便于其他研究人员进行复现和比较。
-
-在TLEM中，我们使用了多个基准测试，包括：MMLU, CMMLU, C-Eval, BBH,
-GSM-8K, MATH,
-专注于衡量模型的知识和思维能力，在这些指标中SUS-Chat-34B模型取得了最先进的表现，我们还额外引入了[lm-eval](https://github.com/EleutherAI/lm-evaluation-harness)测试了SUS-Chat和同类模型在winogrande,
-hellaswag, arc, truthful-qa的表现, 衡量模型的常识性推理能力和幻觉。
-
-综合上看，SUS-Chat-34B模型显著领先于同规模的模型，并取得了最先进的综合性能。
-![](assets/radar.png)
-
-以下是评测结果：
-
-<div>
-
-<table>
-<colgroup>
-<col style="width: 50%" />
-<col style="width: 50%" />
-</colgroup>
-<tbody>
-<tr class="odd">
-<td style="text-align: center;"><div width="50.0%"
-data-layout-align="center">
-<h2 id="英文能力">英文能力</h2>
-<table>
-<thead>
-<tr class="header">
-<th style="text-align: right;">Model</th>
-<th style="text-align: center;">mmlu (0-shot)</th>
-</tr>
-</thead>
-<tbody>
-<tr class="odd">
-<td style="text-align: right;">GPT-4</td>
-<td style="text-align: center;">83</td>
-</tr>
-<tr class="even">
-<td style="text-align: right;">SUS-Chat-34B</td>
-<td style="text-align: center;"><u>74.35</u></td>
-</tr>
-<tr class="odd">
-<td style="text-align: right;">Qwen-72b-Chat</td>
-<td style="text-align: center;"><strong>74.52</strong></td>
-</tr>
-<tr class="even">
-<td style="text-align: right;">Deepseek-68b-Chat</td>
-<td style="text-align: center;">69.43</td>
-</tr>
-<tr class="odd">
-<td style="text-align: right;">OrionStar-Yi-34B-Chat</td>
-<td style="text-align: center;">68.51</td>
-</tr>
-<tr class="even">
-<td style="text-align: right;">Yi-34B-Chat</td>
-<td style="text-align: center;">66.96</td>
-</tr>
-</tbody>
-</table>
-</div></td>
-<td style="text-align: center;"><div width="50.0%"
-data-layout-align="center">
-<h2 id="中文能力">中文能力</h2>
-<table>
-<colgroup>
-<col style="width: 34%" />
-<col style="width: 32%" />
-<col style="width: 32%" />
-</colgroup>
-<thead>
-<tr class="header">
-<th style="text-align: right;">Model</th>
-<th style="text-align: center;">cmmlu (0-shot)</th>
-<th style="text-align: center;">C-Eval (0-shot)<a href="#fn1"
-class="footnote-ref" id="fnref1"
-role="doc-noteref"><sup>1</sup></a></th>
-</tr>
-</thead>
-<tbody>
-<tr class="odd">
-<td style="text-align: right;">GPT-4</td>
-<td style="text-align: center;">71</td>
-<td style="text-align: center;">69.9</td>
-</tr>
-<tr class="even">
-<td style="text-align: right;">SUS-Chat-34B</td>
-<td style="text-align: center;"><strong>78.68</strong></td>
-<td style="text-align: center;"><strong>82.42</strong></td>
-</tr>
-<tr class="odd">
-<td style="text-align: right;">Qwen-72b-Chat</td>
-<td style="text-align: center;"><u>77.02</u></td>
-<td style="text-align: center;"><u>77.22</u></td>
-</tr>
-<tr class="even">
-<td style="text-align: right;">Deepseek-68b-Chat</td>
-<td style="text-align: center;">48.51</td>
-<td style="text-align: center;">59.7</td>
-</tr>
-<tr class="odd">
-<td style="text-align: right;">OrionStar-Yi-34B-Chat</td>
-<td style="text-align: center;">66.88</td>
-<td style="text-align: center;">65.13</td>
-</tr>
-<tr class="even">
-<td style="text-align: right;">Yi-34B-Chat</td>
-<td style="text-align: center;">55.16</td>
-<td style="text-align: center;">77.16</td>
-</tr>
-</tbody>
-</table>
-</div></td>
-</tr>
-</tbody>
-</table>
-<section id="footnotes" class="footnotes footnotes-end-of-document"
-role="doc-endnotes">
-<hr />
-<ol>
-<li id="fn1"><p>C-Eval 结果在验证集上得到。<a href="#fnref1"
-class="footnote-back" role="doc-backlink">↩︎</a></p></li>
-</ol>
-</section>
+# 🐷SUS-Chat: Instruction tuning done right
 
-</div>
+<p align="left">
+<a href="README_CN.md">中文</a>&nbsp ｜ &nbspEnglish&nbsp
+</p>
 
-## 数学与推理能力
+<br><br>
 
-在GSM8K（数学逻辑）的评测都是目前开源模型最强。
+<div align="center">
 
-|                 Model | gsm8k (0-shot) | MATH (0-shot) | BBH (0-shot) |
-|----------------------:|:--------------:|:-------------:|:------------:|
-|                 GPT-4 |      91.4      |     45.8      |     86.7     |
-|          SUS-Chat-34B |   **80.06**    |     28.7      |    67.62     |
-|         Qwen-72b-Chat |  <u>76.57</u>  |   **35.9**    |  **72.63**   |
-|     Deepseek-68b-Chat |     74.45      | <u>29.56</u>  | <u>69.73</u> |
-| OrionStar-Yi-34B-Chat |     54.36      |     12.8      |    62.88     |
-|           Yi-34B-Chat |     63.76      |     10.02     |    61.54     |
+<p align="center">
+<img src="https://github.com/SUSTech-IDEA/SUS-Chat/raw/main/assets/sustech.svg?sanitize=true" width="200px">
+<img src="https://github.com/SUSTech-IDEA/SUS-Chat/raw/main/assets/ccnl.png?sanitize=true" width="200px">
+</p>
 
-## 其他任务能力
+<div style="display: inline-block;">
 
-|                 Model | winogrande (5-shot) | arc (25-shot) | hellaswag (10-shot) | TruthfulQA mc1 (0-shot) | TruthfulQA mc2 (0-shot) |
-|----------------------:|:-------------------:|:-------------:|:-------------------:|:-----------------------:|:-----------------------:|
-|                 GPT-4 |          —          |     94.5      |        91.4         |          59.00          |            —            |
-|          SUS-Chat-34B |      **81.22**      | <u>81.54</u>  |        83.79        |        **40.64**        |        **57.47**        |
-|         Qwen-72b-Chat |        76.09        |   **82.10**   |    <u>86.06</u>     |          39.17          |      <u>56.37</u>       |
-|     Deepseek-68b-Chat |    <u>80.58</u>     |     81.29     |      **87.02**      |      <u>40.02</u>       |          50.64          |
-| OrionStar-Yi-34B-Chat |        77.27        |     80.19     |        84.54        |          36.47          |          53.24          |
-|           Yi-34B-Chat |        76.64        |     70.66     |        82.29        |          38.19          |          54.57          |
+<a rel="noopener nofollow" href="https://github.com/SUSTech-IDEA/SUS-Chat/issues">
+<img src="https://img.shields.io/github/issues/SUSTech-IDEA/SUS-Chat?logo=github" style="margin: 0 0;">
+</a>
 
-## 综合能力
+</div>
 
-|                 Model |  Average  |
-|----------------------:|:---------:|
-|          SUS-Chat-34B | **69.05** |
-|         Qwen-72b-Chat |   68.41   |
-|     Deepseek-68b-Chat |   62.91   |
-| OrionStar-Yi-34B-Chat |   60.21   |
-|           Yi-34B-Chat |   59.72   |
+<div style="display: inline-block;">
 
-要复现我们的结果，请启动一个VLLM服务器并参考[这里](https://sustech-tlem.static.hf.space/index.html#start-evaluating-your-model-in-3-line)。
+<a href="https://huggingface.co/SUSTech">
+<img src="https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-SUSTech-blue" style="margin: 0 0;">
+</a>
 
-# 用法
+</div>
 
-SUS-Chat-34B是标准的LLaMA模型，应该可以无缝地与LLaMA生态系统兼容，我们提供下面的例子来展示如何使用它进行多轮对话
+<div style="display: inline-block;">
 
-``` python
-# from transformers import AutoModelForCausalLM, AutoTokenizer # 🤗 Transformers, or 
-from modelscope import AutoModelForCausalLM, AutoTokenizer # 🤖 ModelScope
+<a rel="noopener nofollow" href="https://www.modelscope.cn/organization/sustc/">
+<img src="https://img.shields.io/badge/🤖ModelScope-sustc-blue" style="margin: 0 0;">
+</a>
+
+</div>
 
+<a href="https://wisemodel.cn/organization/SUSTech">
+<img src="https://img.shields.io/badge/WiseModel-SUSTech-blue"> </a>
 
-def chat_template(messages):
-    history = ""
-    for message in messages:
-        match message:
-            case {"role": "user", "content": message}:
-                history += f"### Human: {message}\n\n### Assistant: "
-            case {"role": "assistant", "content": message}:
-                history += message
-    return history
+<div style="display: inline-block;">
 
+<a rel="noopener nofollow" href="https://github.com/SUSTech-IDEA/SUS-Chat/blob/main/LICENSE">
+<img src="https://img.shields.io/badge/Code_License-Apache_2.0-lightblue" style="margin: 0 0;">
+</a>
+
+</div>
 
-# model_path = "SUSTech/SUS-Chat-34B"
-model_path = "SUSTC/SUS-Chat-34B" # ModelScope
+<div style="display: inline-block;">
 
-tokenizer = AutoTokenizer.from_pretrained(model_path, use_fast=False)
-model = AutoModelForCausalLM.from_pretrained(
-    model_path, device_map="auto", torch_dtype="auto"
-).eval()
+<a rel="noopener nofollow" href="https://github.com/01-ai/Yi/blob/main/MODEL_LICENSE_AGREEMENT.txt">
+<img src="https://img.shields.io/badge/Model_License-Model_Agreement-lightblue" style="margin: 0 0;">
+</a>
 
-messages = [{"role": "user", "content": "hi"}]
+</div>
 
-input_ids = tokenizer.encode(
-    chat_template(messages), return_tensors="pt", add_special_tokens=False
-).to("cuda")
-output_ids = model.generate(input_ids.to("cuda"), max_length=256)
-response = tokenizer.decode(
-    output_ids[0][input_ids.shape[1] :], skip_special_tokens=False
-)
+<div style="display: inline-block;">
 
-messages.append({"role": "assistant", "content": response})
+<a rel="noopener nofollow" href="mailto:[email protected]">
+<img src="https://img.shields.io/badge/✉️[email protected]" style="margin: 0 0;">
+</a>
 
-# Second round
+</div>
 
-messages.append({"role": "user", "content": "What is the capital of China?"})
+</div>
 
-input_ids = tokenizer.encode(
-    chat_template(messages), return_tensors="pt", add_special_tokens=False
-).to("cuda")
-output_ids = model.generate(input_ids.to("cuda"), max_length=256)
-response = tokenizer.decode(
-    output_ids[0][input_ids.shape[1] :], skip_special_tokens=False
-)
+# News
 
-messages.append({"role": "assistant", "content": response})
-```
+- 2023-12-09: 🔥 `Tigerbot` variant has been
+  [deleted](https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard/discussions/438),
+  `SUS-Chat-34B` is now the the top-ranked LLaMA model and the
+  top-ranked chat model.
 
-# 限制
+- 2023-12-07: SUS-Chat-34B is now available on
+  [WiseModel🧠](https://wisemodel.cn/model/SUSTech/SUS-Chat-34B).
 
-SUS-Chat只进行了监督微调，尚未进行人类偏好学习，因此在一些情况下可能会产生不合理的回复，并放大某些语言模型现有的问题,
-包括幻觉、非确定性和累积误差,
-为了实现更有利于下游任务的性能，我们建议相应地调整生成配置参数。
+- 2023-12-06: Try [SUS-Chat-34B
+  chat-ui](https://huggingface.co/spaces/SUSTech/SUS-Chat-34B).
 
-# 免责声明
+- 2023-12-05: SUS-Chat-34B is now available on
+  [ModelScope🤖](https://www.modelscope.cn/models/SUSTC/SUS-Chat-34B/summary)
 
-我们在训练过程中使用数据合规检查算法，尽力确保训练模型的合规性。由于数据复杂且语言模型使用场景多样，我们无法保证模型在所有情况下生成正确和合理的输出。请注意，模型仍然存在产生问题输出的风险。对于因滥用、误导、非法使用和相关错误信息以及相关数据安全问题而导致的任何风险和问题，我们将不承担责任。
+- 2023-12-05: SUS-Chat-34B is ranked 2nd in [Open LLM
+  leaderboard](https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard)
+  and surpassed all models under 70B.
 
-# 许可
+- 2023-12-01: SUS-Chat-34B is now available on
+  [HuggingFace🤗](https://huggingface.co/SUSTech/SUS-Chat-34B).
 
-该模型完全开发供学术研究和免费商业使用，但需要遵守来自[零一万物](https://huggingface.co/01-ai)的[许可](https://github.com/01-ai/Yi/blob/main/MODEL_LICENSE_AGREEMENT.txt)
+# Introduction