diff --git a/README.md b/README.md index faa39df..3982fe0 100644 --- a/README.md +++ b/README.md @@ -1,51 +1,147 @@ --- -frameworks: -- Pytorch -license: Apache License 2.0 -tasks: -- text-generation - -#model-type: -##如 gpt、phi、llama、chatglm、baichuan 等 -#- gpt - -#domain: -##如 nlp、cv、audio、multi-modal -#- nlp - -#language: -##语言代码列表 https://help.aliyun.com/document_detail/215387.html?spm=a2c4g.11186623.0.0.9f8d7467kni6Aa -#- cn - -#metrics: -##如 CIDEr、Blue、ROUGE 等 -#- CIDEr - -#tags: -##各种自定义，包括 pretrained、fine-tuned、instruction-tuned、RL-tuned 等训练方法和其他 -#- pretrained - -#tools: -##如 vllm、fastchat、llamacpp、AdaSeq 等 -#- vllm +license: apache-2.0 +license_link: https://huggingface.co/Qwen/QWQ-32B/blob/main/LICENSE +language: +- en +pipeline_tag: text-generation +base_model: Qwen/Qwen2.5-32B +tags: +- chat --- -### 当前模型的贡献者未提供更加详细的模型介绍。模型文件和权重，可浏览“模型文件”页面获取。 -#### 您可以通过如下git clone命令，或者ModelScope SDK来下载模型 -SDK下载 -```bash -#安装ModelScope -pip install modelscope +# QwQ-32B + + + Chat + + +## Introduction + +QwQ is the reasoning model of Qwen series. Compared with conventional instruction-tuned models QwQ which is capable of thinking and reasoning can achieve significantly enhanced performance in downstream tasks espeically hard problems. QwQ-32B is the medium-size reasoning model, which is capable of achieving competitive performance against state-of-the art reasoning models, e.g., DeepSeek-R1, o1-mini. + +**This repo contains the QwQ 32B model**, which has the following features: +- Type: Causal Language Models +- Training Stage: Pretraining & Post-training (Supervised Finetuning and Reinforcement Learning) +- 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 + +**Note:** For the best experience, please review the [usage guidelines](#usage-guidelines) before deploying QwQ models. + +For more details, please refer to our [blog](https://qwenlm.github.io/blog/qwen2.5/), [GitHub](https://github.com/QwenLM/Qwen2.5), and [Documentation](https://qwen.readthedocs.io/en/latest/). + +## 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. + ```python -#SDK模型下载 -from modelscope import snapshot_download -model_dir = snapshot_download('Qwen/QwQ-32B') -``` -Git下载 -``` -#Git模型下载 -git clone https://www.modelscope.cn/Qwen/QwQ-32B.git +from transformers import AutoModelForCausalLM, AutoTokenizer + +model_name = "Qwen/QwQ-32B" + +model = AutoModelForCausalLM.from_pretrained( + model_name, + torch_dtype="auto", + device_map="auto" +) +tokenizer = AutoTokenizer.from_pretrained(model_name) + +prompt = "How many r's are in the word \"strawberry\"" +messages = [ + {"role": "user", "content": prompt} +] +text = tokenizer.apply_chat_template( + messages, + tokenize=False, + add_generation_prompt=True +) + +# avoid empty thought content by forcing the model to start with "\n" +response_prefix = "\n" +text += response_prefix + +model_inputs = tokenizer([text], return_tensors="pt").to(model.device) + +generated_ids = model.generate( + **model_inputs, + max_new_tokens=32768 +) +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_prefix + response) ``` -

如果您是本模型的贡献者，我们邀请您根据模型贡献文档，及时完善模型卡片内容。

\ No newline at end of file +### Usage Guidelines + +To achieve optimal performance, we recommend the following settings: + +1. **Enforce Thoughtful Output**: Ensure the model starts with "\\n" to prevent generating empty thinking content, which can degrade output quality. + +2. **Sampling Parameters**: + - Use Temperature=0.6 and TopP=0.95 instead of Greedy decoding to avoid endless repetitions and enhance diversity. + - For complex reasoning tasks like math or coding, set TopK=40. + - For other types of questions, use TopK=20. + +3. **Standardize Output Format**: We recommend using prompts to standardize model outputs when benchmarking. + - **Math Problems**: Include "Please reason step by step, and put your final answer within \boxed{}." in the prompt. + - **Multiple-Choice Questions**: Add the following JSON structure to the prompt to standardize responses: "Please show your choice in the `answer` field with only the choice letter, e.g.,`\"answer\": \"C\"`." in the prompt. + +4. **Handle Long Inputs**: For inputs exceeding 32,768 tokens, enable [YaRN](https://arxiv.org/abs/2309.00071) to improve the model's ability to capture long-sequence information effectively. + +For supported frameworks, you could add the following to `config.json` to enable YaRN: +```json +{ + ..., + "rope_scaling": { + "factor": 4.0, + "original_max_position_embeddings": 32768, + "type": "yarn" + } +} +``` + +For deployment, we recommend using vLLM. Please refer to our [Documentation](https://qwen.readthedocs.io/en/latest/deployment/vllm.html) 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](https://qwenlm.github.io/blog/qwen2.5/). + +For requirements on GPU memory and the respective throughput, see results [here](https://qwen.readthedocs.io/en/latest/benchmark/speed_benchmark.html). + +## 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} +} +``` \ No newline at end of file