Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,239 @@
+---
+language:
+- en
+- zh
+library_name: transformers
+license: mit
+pipeline_tag: text-generation
+tags:
+- moe
+- fp8
+---
+
+# GLM-4.5-FP8
+
+[📚 Paper](https://huggingface.co/papers/2508.06471) | [💻 Code](https://github.com/zai-org/GLM-4.5) | [🌐 Project Page](https://z.ai/blog/glm-4.5)
+
+<div align="center">
+<img src=https://raw.githubusercontent.com/zai-org/GLM-4.5/refs/heads/main/resources/logo.svg width="15%"/>
+</div>
+<p align="center">
+    👋 Join our <a href="https://discord.gg/QR7SARHRxK" target="_blank">Discord</a> community.
+    <br>
+    📖 Check out the GLM-4.5 <a href="https://z.ai/blog/glm-4.5" target="_blank">technical blog</a>.
+    <br>
+    📍 Use GLM-4.5 API services on <a href="https://docs.z.ai/guides/llm/glm-4.5">Z.ai API Platform (Global)</a> or <br> <a href="https://docs.bigmodel.cn/cn/guide/models/text/glm-4.5">Zhipu AI Open Platform (Mainland China)</a>.
+    <br>
+    👉 One click to <a href="https://chat.z.ai">GLM-4.5</a>.
+</p>
+  
+## Paper Abstract
+
+We present GLM-4.5, an open-source Mixture-of-Experts (MoE) large language model with 355B total parameters and 32B activated parameters, featuring a hybrid reasoning method that supports both thinking and direct response modes. Through multi-stage training on 23T tokens and comprehensive post-training with expert model iteration and reinforcement learning, GLM-4.5 achieves strong performance across agentic, reasoning, and coding (ARC) tasks, scoring 70.1% on TAU-Bench, 91.0% on AIME 24, and 64.2% on SWE-bench Verified. With much fewer parameters than several competitors, GLM-4.5 ranks 3rd overall among all evaluated models and 2nd on agentic benchmarks. We release both GLM-4.5 (355B parameters) and a compact version, GLM-4.5-Air (106B parameters), to advance research in reasoning and agentic AI systems. Code, models, and more information are available at this https URL .
+
+## Model Introduction
+
+The **GLM-4.5** series models are foundation models designed for intelligent agents. GLM-4.5 has **355** billion total parameters with **32** billion active parameters, while GLM-4.5-Air adopts a more compact design with **106** billion total parameters and **12** billion active parameters. GLM-4.5 models unify reasoning, coding, and intelligent agent capabilities to meet the complex demands of intelligent agent applications.
+
+Both GLM-4.5 and GLM-4.5-Air are hybrid reasoning models that provide two modes: thinking mode for complex reasoning and tool usage, and non-thinking mode for immediate responses.
+
+We have open-sourced the base models, hybrid reasoning models, and FP8 versions of the hybrid reasoning models for both GLM-4.5 and GLM-4.5-Air. They are released under the MIT open-source license and can be used commercially and for secondary development.
+
+As demonstrated in our comprehensive evaluation across 12 industry-standard benchmarks, GLM-4.5 achieves exceptional performance with a score of **63.2**, in the **3rd** place among all the proprietary and open-source models. Notably, GLM-4.5-Air delivers competitive results at **59.8** while maintaining superior efficiency.
+
+![bench](https://raw.githubusercontent.com/zai-org/GLM-4.5/refs/heads/main/resources/bench.png)
+
+For more eval results, show cases, and technical details, please visit our [technical blog](https://z.ai/blog/glm-4.5) or refer to the [technical report (paper)](https://huggingface.co/papers/2508.06471).
+
+The model code, tool parser and reasoning parser can be found in the implementation of [transformers](https://github.com/huggingface/transformers/tree/main/src/transformers/models/glm4_moe), [vLLM](https://github.com/vllm-project/vllm/blob/main/vllm/model_executor/models/glm4_moe_mtp.py) and [SGLang](https://github.com/sgl-project/sglang/blob/main/python/sglang/srt/models/glm4_moe.py).
+
+## Model Downloads
+
+You can directly experience the model on [Hugging Face](https://huggingface.co/spaces/zai-org/GLM-4.5-Space)
+or [ModelScope](https://modelscope.cn/studios/ZhipuAI/GLM-4.5-Demo) or download the model by following the links below.
+
+| Model            | Download Links                                                                                                                                | Model Size | Precision |
+|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|------------|-----------|
+| GLM-4.5          | [🤗 Hugging Face](https://huggingface.co/zai-org/GLM-4.5)<br> [🤖 ModelScope](https://modelscope.cn/models/ZhipuAI/GLM-4.5)                   | 355B-A32B  | BF16      |
+| GLM-4.5-Air      | [🤗 Hugging Face](https://huggingface.co/zai-org/GLM-4.5-Air)<br> [🤖 ModelScope](https://modelscope.cn/models/ZhipuAI/GLM-4.5-Air)           | 106B-A12B  | BF16      |
+| GLM-4.5-FP8      | [🤗 Hugging Face](https://huggingface.co/zai-org/GLM-4.5-FP8)<br> [🤖 ModelScope](https://modelscope.cn/models/ZhipuAI/GLM-4.5-FP8)           | 355B-A32B  | FP8       |
+| GLM-4.5-Air-FP8  | [🤗 Hugging Face](https://huggingface.co/zai-org/GLM-4.5-Air-FP8)<br> [🤖 ModelScope](https://modelscope.cn/models/ZhipuAI/GLM-4.5-Air-FP8)   | 106B-A12B  | FP8       |
+| GLM-4.5-Base     | [🤗 Hugging Face](https://huggingface.co/zai-org/GLM-4.5-Base)<br> [🤖 ModelScope](https://modelscope.cn/models/ZhipuAI/GLM-4.5-Base)         | 355B-A32B  | BF16      |
+| GLM-4.5-Air-Base | [🤗 Hugging Face](https://huggingface.co/zai-org/GLM-4.5-Air-Base)<br> [🤖 ModelScope](https://modelscope.cn/models/ZhipuAI/GLM-4.5-Air-Base) | 106B-A12B  | BF16      |
+
+## System Requirements
+
+### Inference
+
+We provide minimum and recommended configurations for "full-featured" model inference. The data in the table below is
+based on the following conditions:
+
+1. All models use MTP layers and specify
+   `--speculative-num-steps 3 --speculative-eagle-topk 1 --speculative-num-draft-tokens 4` to ensure competitive
+   inference speed.
+2. The `cpu-offload` parameter is not used.
+3. Inference batch size does not exceed `8`.
+4. All are executed on devices that natively support FP8 inference, ensuring both weights and cache are in FP8 format.
+5. Server memory must exceed `1T` to ensure normal model loading and operation.
+
+The models can run under the configurations in the table below:
+
+| Model       | Precision | GPU Type and Count   | Test Framework |
+|-------------|-----------|----------------------|----------------|
+| GLM-4.5     | BF16      | H100 x 16 / H200 x 8 | sglang         |
+| GLM-4.5     | FP8       | H100 x 8 / H200 x 4  | sglang         |
+| GLM-4.5-Air | BF16      | H100 x 4 / H200 x 2  | sglang         |
+| GLM-4.5-Air | FP8       | H100 x 2 / H200 x 1  | sglang         |
+
+Under the configurations in the table below, the models can utilize their full 128K context length:
+
+| Model       | Precision | GPU Type and Count    | Test Framework |
+|-------------|-----------|-----------------------|----------------|
+| GLM-4.5     | BF16      | H100 x 32 / H200 x 16 | sglang         |
+| GLM-4.5     | FP8       | H100 x 16 / H200 x 8  | sglang         |
+| GLM-4.5-Air | BF16      | H100 x 8 / H200 x 4   | sglang         |
+| GLM-4.5-Air | FP8       | H100 x 4 / H200 x 2   | sglang         |\
+  
+### Fine-tuning
+
+The code can run under the configurations in the table below
+using [Llama Factory](https://github.com/hiyouga/LLaMA-Factory):
+
+| Model       | GPU Type and Count | Strategy | Batch Size (per GPU) |
+|-------------|--------------------|----------|----------------------|
+| GLM-4.5     | H100 x 16          | Lora     | 1                    |
+| GLM-4.5-Air | H100 x 4           | Lora     | 1                    |
+
+The code can run under the configurations in the table below using [Swift](https://github.com/modelscope/ms-swift):
+
+| Model       | GPU Type and Count | Strategy | Batch Size (per GPU) |
+|-------------|--------------------|----------|----------------------|
+| GLM-4.5     | H20 (96GiB) x 16   | Lora     | 1                    |
+| GLM-4.5-Air | H20 (96GiB) x 4    | Lora     | 1                    |
+| GLM-4.5     | H20 (96GiB) x 128  | SFT      | 1                    |
+| GLM-4.5-Air | H20 (96GiB) x 32   | SFT      | 1                    |
+| GLM-4.5     | H20 (96GiB) x 128  | RL       | 1                    |
+| GLM-4.5-Air | H20 (96GiB) x 32   | RL       | 1                    |
+
+## Quick Start
+
+For more comprehensive details and setup instructions, please refer to our [GitHub page](https://github.com/zai-org/GLM-4.5).
+
+### Transformers Inference
+
+Here is a basic example to run inference with the `transformers` library, demonstrating both thinking and non-thinking modes:
+
+```python
+from transformers import AutoTokenizer, AutoModelForCausalLM
+import torch
+
+# Load model and tokenizer
+model_id = "zai-org/GLM-4.5-FP8"
+tokenizer = AutoTokenizer.from_pretrained(model_id, trust_remote_code=True)
+model = AutoModelForCausalLM.from_pretrained(
+    model_id,
+    torch_dtype=torch.bfloat16, # Adjust as needed (e.g., torch.float8 for FP8 models)
+    low_cpu_mem_usage=True,
+    device_map="auto",
+    trust_remote_code=True
+)
+model.eval()
+
+messages = [
+    {"role": "user", "content": "Hello, how are you?"},
+]
+
+# Example for non-thinking mode (direct response)
+# The `add_nothink_token=True` parameter triggers non-thinking mode.
+# This mode is suitable for straightforward questions not requiring complex reasoning or tool usage.
+inputs_nothink_text = tokenizer.apply_chat_template(messages, add_generation_prompt=True, tokenize=False, add_nothink_token=True)
+input_ids_nothink = tokenizer(inputs_nothink_text, return_tensors="pt").input_ids.to(model.device)
+outputs_nothink = model.generate(input_ids_nothink, max_new_tokens=100)
+print("Non-thinking mode response:", tokenizer.decode(outputs_nothink[0][len(input_ids_nothink[0]):], skip_special_tokens=True))
+
+# Example for thinking mode (for complex reasoning or tool usage)
+# By default, `add_nothink_token=False` or omitting it triggers thinking mode.
+# This mode allows the model to perform multi-step reasoning, break down tasks, and utilize tools.
+inputs_think_text = tokenizer.apply_chat_template(messages, add_generation_prompt=True, tokenize=False, add_nothink_token=False)
+input_ids_think = tokenizer(inputs_think_text, return_tensors="pt").input_ids.to(model.device)
+outputs_think = model.generate(input_ids_think, max_new_tokens=100)
+print("Thinking mode response:", tokenizer.decode(outputs_think[0][len(input_ids_think[0]):], skip_special_tokens=True))
+```
+
+### vLLM
+
++ Both BF16 and FP8 can be started with the following code:
+
+```shell
+vllm serve zai-org/GLM-4.5-Air \
+    --tensor-parallel-size 8 \
+    --tool-call-parser glm45 \
+    --reasoning-parser glm45 \
+    --enable-auto-tool-choice \
+    --served-model-name glm-4.5-air
+```
+
+If you're using 8x H100 GPUs and encounter insufficient memory when running the GLM-4.5 model, you'll need
+`--cpu-offload-gb 16` (only applicable to vLLM).
+
+If you encounter `flash infer` issues, use `VLLM_ATTENTION_BACKEND=XFORMERS` as a temporary replacement. You can also
+specify `TORCH_CUDA_ARCH_LIST='9.0+PTX'` to use `flash infer` (different GPUs have different TORCH_CUDA_ARCH_LIST
+values, please check accordingly).
+
+### SGLang
+
++ BF16
+
+```shell
+python3 -m sglang.launch_server \
+  --model-path zai-org/GLM-4.5-Air \
+  --tp-size 8 \
+  --tool-call-parser glm45  \
+  --reasoning-parser glm45 \
+  --speculative-algorithm EAGLE \
+  --speculative-num-steps 3 \
+  --speculative-eagle-topk 1 \
+  --speculative-num-draft-tokens 4 \
+  --mem-fraction-static 0.7 \
+  --served-model-name glm-4.5-air \
+  --host 0.0.0.0 \
+  --port 8000
+```
+
++ FP8
+
+```shell
+python3 -m sglang.launch_server \
+  --model-path zai-org/GLM-4.5-Air-FP8 \
+  --tp-size 4 \
+  --tool-call-parser glm45  \
+  --reasoning-parser glm45  \
+  --speculative-algorithm EAGLE \
+  --speculative-num-steps 3  \
+  --speculative-eagle-topk 1  \
+  --speculative-num-draft-tokens 4 \
+  --mem-fraction-static 0.7 \
+  --disable-shared-experts-fusion \
+  --served-model-name glm-4.5-air-fp8 \
+  --host 0.0.0.0 \
+  --port 8000
+```
+
+### Request Parameter Instructions
+
++ When using `vLLM` and `SGLang`, thinking mode is enabled by default when sending requests. If you want to disable the
+  thinking switch, you need to add the `extra_body={"chat_template_kwargs": {"enable_thinking": False}}` parameter.
++ Both support tool calling. Please use OpenAI-style tool description format for calls.
++ For specific code, please refer to `api_request.py` in the `inference` folder.
+
+## Citation
+If you find our work useful or helpful for your R&D works, please feel free to cite our paper as below.
+
+```bibtex
+@article{zhu2025glm45,
+  title={GLM-4.5: Agentic, Reasoning, and Coding (ARC) Foundation Models},
+  author={Zhu, Xiaohan and Sun, Tianxiang and Wang, Hao and Xu, Yi and Zhang, Yichen and Wang, Junyi and Huang, Junjie and Zeng, Jiao and Huang, Yangyang and Gu, Ruipeng and Zhang, Xiaodong and Du, Mengying and Han, Hao and Li, Chao and Xiao, Jin and Guo, Weidong and Li, Zhen and Lu, Jingkang and Chen, Shu and Chen, Huadong and Chen, Peng and Liu, Hongguang and Guo, Guang and Liu, Wen and Yang, Tianyu and Hu, Bo and Zhang, Wenmin and Sun, Maosong},
+  journal={arXiv preprint arXiv:2508.06471},
+  year={2025}
+}
+```