Update README.md

README.md

@@ -1,3 +1,117 @@
----
-license: apache-2.0
----
+---
+license: apache-2.0
+library_name: transformers
+pipeline_tag: text-generation
+base_model: Qwen/Qwen2.5-7B
+language:
+- en
+- zh
+---
+
+
+# Xwen-72B-Chat
+
+<img src="Xwen-Cartoon.jpg" alt="Xwen-Cartoon" style="zoom:35%;" />
+
+## 1. Introduction
+
+> [!IMPORTANT]
+> If you enjoy our model, please **give it a star on our Hugging Face repo**. Your support means a lot to us. Thank you!
+
+
+Xwen is a series of open-sourced large language models (currently including **[Xwen-72B-Chat](https://huggingface.co/xwen-team/Xwen-72B-Chat)** and **[Xwen-7B-Chat](https://huggingface.co/xwen-team/Xwen-7B-Chat)**), post-trained from the pre-trained Qwen2.5 models (i.e., [Qwen2.5-72B](https://huggingface.co/Qwen/Qwen2.5-72B) and [Qwen2.5-7B](https://huggingface.co/Qwen/Qwen2.5-7B)) [1].
+
+**🏆 Top-1 chat performance!** To the best of our knowledge, at the time of Xwen models' release (February 1, 2025), **[Xwen-72B-Chat](https://huggingface.co/xwen-team/Xwen-72B-Chat) and [Xwen-7B-Chat](https://huggingface.co/xwen-team/Xwen-7B-Chat) exhibit the best chat performance among open-sourced models below 100B and 10B, respectively**, based on evaluation results from widely-used benchmarks such as Arena-Hard-Auto [2], MT-Bench [3], and AlignBench [4].
+
+**🚀 Xwen technical report is on the way!** During the training of Xwen models, we have accumulated many technical insights and lessons. To promote the democratization of technology, we are in the process of documenting these insights and lessons in a technical report, which will be released as soon as possible.
+
+
+
+## 2. Usage
+
+> [!CAUTION]
+> For optimal performance, we refrain from fine-tuning the model's identity. Thus, inquiries such as "Who are you" or "Who developed you" may yield random responses that are not necessarily accurate. 
+
+> [!CAUTION]
+> This open-source model is provided "as is," without warranties or liabilities, and users assume all risks associated with its use; users are advised to comply with local laws, and the model's outputs do not represent the views or positions of the developers. 
+
+The usage of our Xwen-Chat models is similar to that of the Qwen2.5-Instruct models, with the tokenizer and chat template being identical to those of the Qwen2.5-Instruct models.
+
+Here we provide a python script to demonstrate how to deploy our Xwen models to generate reponses:
+
+
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
+
+model_name = "xwen-team/Xwen-72B-Chat"   # Or "xwen-team/Xwen-7B-Chat" if you want to use the 7B model
+
+model = AutoModelForCausalLM.from_pretrained(
+    model_name,
+    torch_dtype="auto",
+    device_map="auto"
+)
+tokenizer = AutoTokenizer.from_pretrained(model_name)
+
+prompt = "Give me a short introduction to large language models."
+messages = [
+    {"role": "system", "content": "You are Xwen, created by Xwen Team. You are a helpful assistant."},   # This system prompt is not necessary, and you can put it as an empty string.
+    {"role": "user", "content": prompt}
+]
+text = tokenizer.apply_chat_template(
+    messages,
+    tokenize=False,
+    add_generation_prompt=True
+)
+model_inputs = tokenizer([text], return_tensors="pt").to(model.device)
+
+generated_ids = model.generate(
+    **model_inputs,
+    max_new_tokens=512
+)
+generated_ids = [
+    output_ids[len(input_ids):] for input_ids, output_ids in zip(model_inputs.input_ids, generated_ids)
+]
+
+response = tokenizer.batch_decode(generated_ids, skip_special_tokens=True)[0]
+
+print(response)
+```
+
+## 3. Evaluation Results
+
+> [!CAUTION]
+> Results on other benchmarks will be updated soon! 😊
+
+🔑: Open-sourced
+🔒: Proprietary
+
+### 3.1 Arena-Hard-Auto
+|                    | Score    | 95% CIs     |
+| --------------------------------- | -------- | ----------- |
+| **Xwen-72B-Chat** 🔑               | **86.1** | (-1.5, 1.7) |
+| Qwen2.5-72B-Chat 🔑                | 63.3     | (-2.5, 2.3) |
+| Athene-v2-Chat 🔑                  | 72.1     | (-2.5, 2.5) |
+| Llama-3.1-Nemotron-70B-Instruct 🔑 | 71.0     | (-2.8, 3.1) |
+| Llama-3.1-405B-Instruct-FP8 🔑     | 67.1     | (-2.2, 2.8) |
+| Claude-3-5-Sonnet-20241022 🔒      | **86.4** | (-1.3, 1.3) |
+| O1-Preview-2024-09-12 🔒           | 81.7     | (-2.2, 2.1) |
+| O1-Mini-2024-09-12 🔒              | 79.3     | (-2.8, 2.3) |
+| GPT-4-Turbo-2024-04-09 🔒          | 74.3     | (-2.4, 2.4) |
+| GPT-4-0125-Preview 🔒              | 73.6     | (-2.0, 2.0) |
+| GPT-4o-2024-08-06 🔒               | 71.1     | (-2.5, 2.0) |
+| Yi-Lightning 🔒                    | 66.9     | (-3.3, 2.7) |
+| Yi-Large-Preview 🔒                | 65.1     | (-2.5, 2.5) |
+| GLM-4-0520 🔒                      | 61.4     | (-2.6, 2.4) |
+
+
+
+
+## References
+
+[1] Yang, An, et al. "Qwen2. 5 technical report." arXiv preprint arXiv:2412.15115 (2024).
+
+[2] Li, Tianle, et al. "From Crowdsourced Data to High-Quality Benchmarks: Arena-Hard and BenchBuilder Pipeline." arXiv preprint arXiv:2406.11939 (2024).
+
+[3] Zheng, Lianmin, et al. "Judging llm-as-a-judge with mt-bench and chatbot arena." Advances in Neural Information Processing Systems 36 (2023).
+
+[4] Liu, Xiao, et al. "Alignbench: Benchmarking chinese alignment of large language models." Proceedings of the 62nd Annual Meeting of the Association for Computational Linguistics (2024).