Improve language tag (#1)

- Improve language tag (2d09b3b1cee51718e6c96669c8fcbc55be4b4e6e)


Co-authored-by: Loïck BOURDOIS <[email protected]>

README.md

@@ -1,166 +1,178 @@
----
-license: apache-2.0
-license_link: https://huggingface.co/Qwen/Qwen2.5-32B-Instruct/blob/main/LICENSE
-language:
-- en
-pipeline_tag: text-generation
-base_model: Qwen/Qwen2.5-32B-Instruct
-tags:
-- chat
-- llama-cpp
-- gguf-my-repo
-library_name: transformers
----
-
-# Triangle104/Qwen2.5-32B-Instruct-Q5_K_S-GGUF
-This model was converted to GGUF format from [`Qwen/Qwen2.5-32B-Instruct`](https://huggingface.co/Qwen/Qwen2.5-32B-Instruct) using llama.cpp via the ggml.ai's [GGUF-my-repo](https://huggingface.co/spaces/ggml-org/gguf-my-repo) space.
-Refer to the [original model card](https://huggingface.co/Qwen/Qwen2.5-32B-Instruct) for more details on the model.
-
----
-Model Details:
--
-Qwen2.5 is the latest series of Qwen large language models. For Qwen2.5, we release a number of base language models and instruction-tuned language models ranging from 0.5 to 72 billion parameters. Qwen2.5 brings the following improvements upon Qwen2:
-
-    Significantly more knowledge and has greatly improved capabilities in coding and mathematics, thanks to our specialized expert models in these domains.
-    Significant improvements in instruction following, generating long texts (over 8K tokens), understanding structured data (e.g, tables), and generating structured outputs especially JSON. More resilient to the diversity of system prompts, enhancing role-play implementation and condition-setting for chatbots.
-    Long-context Support up to 128K tokens and can generate up to 8K tokens.
-    Multilingual support for over 29 languages, including Chinese, English, French, Spanish, Portuguese, German, Italian, Russian, Japanese, Korean, Vietnamese, Thai, Arabic, and more.
-
-This repo contains the instruction-tuned 32B Qwen2.5 model, which has the following features:
-
-    Type: Causal Language Models
-    Training Stage: Pretraining & Post-training
-    Architecture: transformers with RoPE, SwiGLU, RMSNorm, and Attention QKV bias
-    Number of Parameters: 32.5B
-    Number of Paramaters (Non-Embedding): 31.0B
-    Number of Layers: 64
-    Number of Attention Heads (GQA): 40 for Q and 8 for KV
-    Context Length: Full 131,072 tokens and generation 8192 tokens
-        Please refer to this section for detailed instructions on how to deploy Qwen2.5 for handling long texts.
-
-For more details, please refer to our blog, GitHub, and Documentation.
-Requirements
-
-The code of Qwen2.5 has been in the latest Hugging face transformers and we advise you to use the latest version of transformers.
-
-With transformers<4.37.0, you will encounter the following error:
-
-KeyError: 'qwen2'
-
-Quickstart
-
-Here provides a code snippet with apply_chat_template to show you how to load the tokenizer and model and how to generate contents.
-
-from transformers import AutoModelForCausalLM, AutoTokenizer
-
-model_name = "Qwen/Qwen2.5-32B-Instruct"
-
-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 model."
-messages = [
-    {"role": "system", "content": "You are Qwen, created by Alibaba Cloud. You are a helpful assistant."},
-    {"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]
-
-Processing Long Texts
-
-The current config.json is set for context length up to 32,768 tokens. To handle extensive inputs exceeding 32,768 tokens, we utilize YaRN, a technique for enhancing model length extrapolation, ensuring optimal performance on lengthy texts.
-
-For supported frameworks, you could add the following to config.json to enable YaRN:
-
-{
-  ...,
-  "rope_scaling": {
-    "factor": 4.0,
-    "original_max_position_embeddings": 32768,
-    "type": "yarn"
-  }
-}
-
-For deployment, we recommend using vLLM. Please refer to our Documentation for usage if you are not familar with vLLM. Presently, vLLM only supports static YARN, which means the scaling factor remains constant regardless of input length, potentially impacting performance on shorter texts. We advise adding the rope_scaling configuration only when processing long contexts is required.
-Evaluation & Performance
-
-Detailed evaluation results are reported in this 📑 blog.
-
-For requirements on GPU memory and the respective throughput, see results here.
-Citation
-
-If you find our work helpful, feel free to give us a cite.
-
-@misc{qwen2.5,
-    title = {Qwen2.5: A Party of Foundation Models},
-    url = {https://qwenlm.github.io/blog/qwen2.5/},
-    author = {Qwen Team},
-    month = {September},
-    year = {2024}
-}
-
-@article{qwen2,
-      title={Qwen2 Technical Report}, 
-      author={An Yang and Baosong Yang and Binyuan Hui and Bo Zheng and Bowen Yu and Chang Zhou and Chengpeng Li and Chengyuan Li and Dayiheng Liu and Fei Huang and Guanting Dong and Haoran Wei and Huan Lin and Jialong Tang and Jialin Wang and Jian Yang and Jianhong Tu and Jianwei Zhang and Jianxin Ma and Jin Xu and Jingren Zhou and Jinze Bai and Jinzheng He and Junyang Lin and Kai Dang and Keming Lu and Keqin Chen and Kexin Yang and Mei Li and Mingfeng Xue and Na Ni and Pei Zhang and Peng Wang and Ru Peng and Rui Men and Ruize Gao and Runji Lin and Shijie Wang and Shuai Bai and Sinan Tan and Tianhang Zhu and Tianhao Li and Tianyu Liu and Wenbin Ge and Xiaodong Deng and Xiaohuan Zhou and Xingzhang Ren and Xinyu Zhang and Xipin Wei and Xuancheng Ren and Yang Fan and Yang Yao and Yichang Zhang and Yu Wan and Yunfei Chu and Yuqiong Liu and Zeyu Cui and Zhenru Zhang and Zhihao Fan},
-      journal={arXiv preprint arXiv:2407.10671},
-      year={2024}
-}
-
----
-## Use with llama.cpp
-Install llama.cpp through brew (works on Mac and Linux)
-
-```bash
-brew install llama.cpp
-
-```
-Invoke the llama.cpp server or the CLI.
-
-### CLI:
-```bash
-llama-cli --hf-repo Triangle104/Qwen2.5-32B-Instruct-Q5_K_S-GGUF --hf-file qwen2.5-32b-instruct-q5_k_s.gguf -p "The meaning to life and the universe is"
-```
-
-### Server:
-```bash
-llama-server --hf-repo Triangle104/Qwen2.5-32B-Instruct-Q5_K_S-GGUF --hf-file qwen2.5-32b-instruct-q5_k_s.gguf -c 2048
-```
-
-Note: You can also use this checkpoint directly through the [usage steps](https://github.com/ggerganov/llama.cpp?tab=readme-ov-file#usage) listed in the Llama.cpp repo as well.
-
-Step 1: Clone llama.cpp from GitHub.
-```
-git clone https://github.com/ggerganov/llama.cpp
-```
-
-Step 2: Move into the llama.cpp folder and build it with `LLAMA_CURL=1` flag along with other hardware-specific flags (for ex: LLAMA_CUDA=1 for Nvidia GPUs on Linux).
-```
-cd llama.cpp && LLAMA_CURL=1 make
-```
-
-Step 3: Run inference through the main binary.
-```
-./llama-cli --hf-repo Triangle104/Qwen2.5-32B-Instruct-Q5_K_S-GGUF --hf-file qwen2.5-32b-instruct-q5_k_s.gguf -p "The meaning to life and the universe is"
-```
-or 
-```
-./llama-server --hf-repo Triangle104/Qwen2.5-32B-Instruct-Q5_K_S-GGUF --hf-file qwen2.5-32b-instruct-q5_k_s.gguf -c 2048
-```
+---
+license: apache-2.0
+license_link: https://huggingface.co/Qwen/Qwen2.5-32B-Instruct/blob/main/LICENSE
+language:
+- zho
+- eng
+- fra
+- spa
+- por
+- deu
+- ita
+- rus
+- jpn
+- kor
+- vie
+- tha
+- ara
+pipeline_tag: text-generation
+base_model: Qwen/Qwen2.5-32B-Instruct
+tags:
+- chat
+- llama-cpp
+- gguf-my-repo
+library_name: transformers
+---
+
+# Triangle104/Qwen2.5-32B-Instruct-Q5_K_S-GGUF
+This model was converted to GGUF format from [`Qwen/Qwen2.5-32B-Instruct`](https://huggingface.co/Qwen/Qwen2.5-32B-Instruct) using llama.cpp via the ggml.ai's [GGUF-my-repo](https://huggingface.co/spaces/ggml-org/gguf-my-repo) space.
+Refer to the [original model card](https://huggingface.co/Qwen/Qwen2.5-32B-Instruct) for more details on the model.
+
+---
+Model Details:
+-
+Qwen2.5 is the latest series of Qwen large language models. For Qwen2.5, we release a number of base language models and instruction-tuned language models ranging from 0.5 to 72 billion parameters. Qwen2.5 brings the following improvements upon Qwen2:
+
+    Significantly more knowledge and has greatly improved capabilities in coding and mathematics, thanks to our specialized expert models in these domains.
+    Significant improvements in instruction following, generating long texts (over 8K tokens), understanding structured data (e.g, tables), and generating structured outputs especially JSON. More resilient to the diversity of system prompts, enhancing role-play implementation and condition-setting for chatbots.
+    Long-context Support up to 128K tokens and can generate up to 8K tokens.
+    Multilingual support for over 29 languages, including Chinese, English, French, Spanish, Portuguese, German, Italian, Russian, Japanese, Korean, Vietnamese, Thai, Arabic, and more.
+
+This repo contains the instruction-tuned 32B Qwen2.5 model, which has the following features:
+
+    Type: Causal Language Models
+    Training Stage: Pretraining & Post-training
+    Architecture: transformers with RoPE, SwiGLU, RMSNorm, and Attention QKV bias
+    Number of Parameters: 32.5B
+    Number of Paramaters (Non-Embedding): 31.0B
+    Number of Layers: 64
+    Number of Attention Heads (GQA): 40 for Q and 8 for KV
+    Context Length: Full 131,072 tokens and generation 8192 tokens
+        Please refer to this section for detailed instructions on how to deploy Qwen2.5 for handling long texts.
+
+For more details, please refer to our blog, GitHub, and Documentation.
+Requirements
+
+The code of Qwen2.5 has been in the latest Hugging face transformers and we advise you to use the latest version of transformers.
+
+With transformers<4.37.0, you will encounter the following error:
+
+KeyError: 'qwen2'
+
+Quickstart
+
+Here provides a code snippet with apply_chat_template to show you how to load the tokenizer and model and how to generate contents.
+
+from transformers import AutoModelForCausalLM, AutoTokenizer
+
+model_name = "Qwen/Qwen2.5-32B-Instruct"
+
+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 model."
+messages = [
+    {"role": "system", "content": "You are Qwen, created by Alibaba Cloud. You are a helpful assistant."},
+    {"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]
+
+Processing Long Texts
+
+The current config.json is set for context length up to 32,768 tokens. To handle extensive inputs exceeding 32,768 tokens, we utilize YaRN, a technique for enhancing model length extrapolation, ensuring optimal performance on lengthy texts.
+
+For supported frameworks, you could add the following to config.json to enable YaRN:
+
+{
+  ...,
+  "rope_scaling": {
+    "factor": 4.0,
+    "original_max_position_embeddings": 32768,
+    "type": "yarn"
+  }
+}
+
+For deployment, we recommend using vLLM. Please refer to our Documentation for usage if you are not familar with vLLM. Presently, vLLM only supports static YARN, which means the scaling factor remains constant regardless of input length, potentially impacting performance on shorter texts. We advise adding the rope_scaling configuration only when processing long contexts is required.
+Evaluation & Performance
+
+Detailed evaluation results are reported in this 📑 blog.
+
+For requirements on GPU memory and the respective throughput, see results here.
+Citation
+
+If you find our work helpful, feel free to give us a cite.
+
+@misc{qwen2.5,
+    title = {Qwen2.5: A Party of Foundation Models},
+    url = {https://qwenlm.github.io/blog/qwen2.5/},
+    author = {Qwen Team},
+    month = {September},
+    year = {2024}
+}
+
+@article{qwen2,
+      title={Qwen2 Technical Report}, 
+      author={An Yang and Baosong Yang and Binyuan Hui and Bo Zheng and Bowen Yu and Chang Zhou and Chengpeng Li and Chengyuan Li and Dayiheng Liu and Fei Huang and Guanting Dong and Haoran Wei and Huan Lin and Jialong Tang and Jialin Wang and Jian Yang and Jianhong Tu and Jianwei Zhang and Jianxin Ma and Jin Xu and Jingren Zhou and Jinze Bai and Jinzheng He and Junyang Lin and Kai Dang and Keming Lu and Keqin Chen and Kexin Yang and Mei Li and Mingfeng Xue and Na Ni and Pei Zhang and Peng Wang and Ru Peng and Rui Men and Ruize Gao and Runji Lin and Shijie Wang and Shuai Bai and Sinan Tan and Tianhang Zhu and Tianhao Li and Tianyu Liu and Wenbin Ge and Xiaodong Deng and Xiaohuan Zhou and Xingzhang Ren and Xinyu Zhang and Xipin Wei and Xuancheng Ren and Yang Fan and Yang Yao and Yichang Zhang and Yu Wan and Yunfei Chu and Yuqiong Liu and Zeyu Cui and Zhenru Zhang and Zhihao Fan},
+      journal={arXiv preprint arXiv:2407.10671},
+      year={2024}
+}
+
+---
+## Use with llama.cpp
+Install llama.cpp through brew (works on Mac and Linux)
+
+```bash
+brew install llama.cpp
+
+```
+Invoke the llama.cpp server or the CLI.
+
+### CLI:
+```bash
+llama-cli --hf-repo Triangle104/Qwen2.5-32B-Instruct-Q5_K_S-GGUF --hf-file qwen2.5-32b-instruct-q5_k_s.gguf -p "The meaning to life and the universe is"
+```
+
+### Server:
+```bash
+llama-server --hf-repo Triangle104/Qwen2.5-32B-Instruct-Q5_K_S-GGUF --hf-file qwen2.5-32b-instruct-q5_k_s.gguf -c 2048
+```
+
+Note: You can also use this checkpoint directly through the [usage steps](https://github.com/ggerganov/llama.cpp?tab=readme-ov-file#usage) listed in the Llama.cpp repo as well.
+
+Step 1: Clone llama.cpp from GitHub.
+```
+git clone https://github.com/ggerganov/llama.cpp
+```
+
+Step 2: Move into the llama.cpp folder and build it with `LLAMA_CURL=1` flag along with other hardware-specific flags (for ex: LLAMA_CUDA=1 for Nvidia GPUs on Linux).
+```
+cd llama.cpp && LLAMA_CURL=1 make
+```
+
+Step 3: Run inference through the main binary.
+```
+./llama-cli --hf-repo Triangle104/Qwen2.5-32B-Instruct-Q5_K_S-GGUF --hf-file qwen2.5-32b-instruct-q5_k_s.gguf -p "The meaning to life and the universe is"
+```
+or 
+```
+./llama-server --hf-repo Triangle104/Qwen2.5-32B-Instruct-Q5_K_S-GGUF --hf-file qwen2.5-32b-instruct-q5_k_s.gguf -c 2048
+```