Update README_convert_gguf.md
Browse files- README_convert_gguf.md +53 -17
README_convert_gguf.md
CHANGED
|
@@ -25,21 +25,10 @@ Dedicated to building a more intuitive, comprehensive, and efficient LLMs compre
|
|
| 25 |
## 📣Latest News
|
| 26 |
- [26/02/09] We have released HY-1.8B-2Bit, 2bit on-device large language model.
|
| 27 |
- [26/01/13] We have released v0.3. We support the training and deployment of Eagle3 for all-scale LLMs/VLMs/Audio models, as detailed in the [guidance documentation](https://angelslim.readthedocs.io/zh-cn/latest/features/speculative_decoding/eagle/index.html). And We released **Sherry**, the hardware-efficient 1.25 bit quantization algorithm [Paper Comming soon] | [[Code]](https://github.com/Tencent/AngelSlim/tree/sherry/Sherry)🔥🔥🔥
|
| 28 |
-
- [25/11/05] We have released v0.2. Quantization support for new models, such as `GLM-4.6`, `Qwen3-VL` and `Qwen3-Omni`, open-sources the Eagle3 speculative decoding training framework, and updates the Diffusion model quantization tools.
|
| 29 |
-
- [25/09/30] We have released **SpecExit**, the reasoning early-exit algorithm: [[Paper]](http://arxiv.org/abs/2509.24248) | [[Docs]](https://angelslim.readthedocs.io/zh-cn/latest/features/speculative_decoding/spec_exit.html) | [[vLLM Code]](https://github.com/vllm-project/vllm/pull/27192)
|
| 30 |
-
- [25/09/26] We have released **TEQUILA**, the ternary quantization algorithm [[Paper]](https://arxiv.org/abs/2509.23809) | [[Code]](https://github.com/Tencent/AngelSlim/tree/tequila/TernaryQuant)
|
| 31 |
-
- [25/09/24] We now support the PTQ quantization of NVFP4 for the Qwen3 series models. We also opensource [Qwen3-32B-NVFP4](https://huggingface.co/AngelSlim/Qwen3-32B_nvfp4) and [Qwen3-235B-A22B-NVFP4](https://huggingface.co/AngelSlim/Qwen3-235B-A22B_nvfp4) weights.
|
| 32 |
|
| 33 |
-
|
| 34 |
-
<summary>Previous News</summary>
|
| 35 |
|
| 36 |
-
|
| 37 |
-
- [25/08/06] We now support quantization for `Hunyuan 0.5B/1.8B/4B/7B` and multimodal model `Qwen2.5VL 3B/7B/32B/72B`, including `FP8/INT4` algorithms, and quantization for `DeepSeek-R1/V3` and `Kimi-K2`, including `FP8-Static` and `W4A8-FP8` algorithms. We also opensource `Hunyuan 1.8B/4B/7B` series Eagle3 model weight.
|
| 38 |
-
- [25/07/04] We now support quantization for `Hunyuan/Qwen2.5/Qwen3/DeepSeek-R1-Distill-Qwen` and other models, including `INT8/FP8/INT4` algorithms. We also opensource `Qwen3` series Eagle3 model weight.
|
| 39 |
-
|
| 40 |
-
</details>
|
| 41 |
-
|
| 42 |
-
## 🌟Convert hf to gguf-q2_0
|
| 43 |
|
| 44 |
**Step1**: Clone llama.cpp
|
| 45 |
|
|
@@ -54,23 +43,70 @@ cd llama.cpp
|
|
| 54 |
python convert_hf_to_gguf.py ../qdq_model_path/ --outfile ./model-fp16.gguf --outtype f16
|
| 55 |
```
|
| 56 |
|
| 57 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 58 |
|
| 59 |
```bash
|
| 60 |
git clone https://github.com/ggml-org/llama.cpp.git
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 61 |
cd llama.cpp
|
| 62 |
-
|
| 63 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 64 |
mkdir build && cd build
|
|
|
|
| 65 |
cmake -DGGML_CPU_KLEIDIAI=ON -DGGML_METAL=OFF -DGGML_BLAS=OFF ..
|
|
|
|
| 66 |
make -j8
|
| 67 |
```
|
| 68 |
|
| 69 |
-
|
|
|
|
| 70 |
```bash
|
| 71 |
./bin/llama-quantize hunyuan-fp16-qdq.gguf hunyuan-q2_0.gguf q2_0c
|
| 72 |
```
|
| 73 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 74 |
## 📝 License
|
| 75 |
|
| 76 |
The code for this project is open-sourced under the [License for AngelSlim](LICENSE).
|
|
|
|
| 25 |
## 📣Latest News
|
| 26 |
- [26/02/09] We have released HY-1.8B-2Bit, 2bit on-device large language model.
|
| 27 |
- [26/01/13] We have released v0.3. We support the training and deployment of Eagle3 for all-scale LLMs/VLMs/Audio models, as detailed in the [guidance documentation](https://angelslim.readthedocs.io/zh-cn/latest/features/speculative_decoding/eagle/index.html). And We released **Sherry**, the hardware-efficient 1.25 bit quantization algorithm [Paper Comming soon] | [[Code]](https://github.com/Tencent/AngelSlim/tree/sherry/Sherry)🔥🔥🔥
|
|
|
|
|
|
|
|
|
|
|
|
|
| 28 |
|
| 29 |
+
For more detailed information, please refer to[[AngelSlim]](https://github.com/Tencent/AngelSlim)
|
|
|
|
| 30 |
|
| 31 |
+
## 🌟Convert hf to gguf-fp16
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 32 |
|
| 33 |
**Step1**: Clone llama.cpp
|
| 34 |
|
|
|
|
| 43 |
python convert_hf_to_gguf.py ../qdq_model_path/ --outfile ./model-fp16.gguf --outtype f16
|
| 44 |
```
|
| 45 |
|
| 46 |
+
## 💻Deployment
|
| 47 |
+
This setup ONLY works on SME2-capable devices (for example, Apple M4, vivo x300 and Arm CPUs with SME2 support). Neon kernel will follow up.
|
| 48 |
+
|
| 49 |
+
### Running Hunyuan model on MacBook M4
|
| 50 |
+
|
| 51 |
+
Clone llama.cpp
|
| 52 |
|
| 53 |
```bash
|
| 54 |
git clone https://github.com/ggml-org/llama.cpp.git
|
| 55 |
+
```
|
| 56 |
+
|
| 57 |
+
Enter the llama.cpp folder
|
| 58 |
+
|
| 59 |
+
```bash
|
| 60 |
cd llama.cpp
|
| 61 |
+
```
|
| 62 |
+
|
| 63 |
+
Fetch and check out the PR branch
|
| 64 |
+
```bash
|
| 65 |
+
git fetch origin pull/19357/head:pr-19357-sme2-int2
|
| 66 |
+
git checkout pr-19357-sme2-int2
|
| 67 |
+
```
|
| 68 |
+
|
| 69 |
+
Build llama.cpp with KleidiAI enabled
|
| 70 |
+
|
| 71 |
+
```bash
|
| 72 |
mkdir build && cd build
|
| 73 |
+
|
| 74 |
cmake -DGGML_CPU_KLEIDIAI=ON -DGGML_METAL=OFF -DGGML_BLAS=OFF ..
|
| 75 |
+
|
| 76 |
make -j8
|
| 77 |
```
|
| 78 |
|
| 79 |
+
Quantize the Hunyuan fp16 model to int2 per-channel (q2_0c)
|
| 80 |
+
|
| 81 |
```bash
|
| 82 |
./bin/llama-quantize hunyuan-fp16-qdq.gguf hunyuan-q2_0.gguf q2_0c
|
| 83 |
```
|
| 84 |
|
| 85 |
+
#### Run the CLI llama.cpp example
|
| 86 |
+
|
| 87 |
+
|
| 88 |
+
```bash
|
| 89 |
+
export GGML_KLEIDIAI_SME=1
|
| 90 |
+
|
| 91 |
+
# thinking
|
| 92 |
+
./bin/llama-cli -m hunyuan-q2_0.gguf -p "写一副春联" -t 1 --seed 4568 -n 32
|
| 93 |
+
# no thinking
|
| 94 |
+
./bin/llama-cli -m hunyuan-q2_0.gguf -p "/no_think写一副春联" -t 1 --seed 4568 -n 32
|
| 95 |
+
```
|
| 96 |
+
|
| 97 |
+
|
| 98 |
+
|
| 99 |
+
#### Run the llama.cpp benchmark
|
| 100 |
+
|
| 101 |
+
The general command is:
|
| 102 |
+
|
| 103 |
+
```bash
|
| 104 |
+
./bin/llama-bench -m hunyuan-q2_0.gguf -p <prompt-length> -t <number-of-threads> -n <gen-length>
|
| 105 |
+
```
|
| 106 |
+
|
| 107 |
+

|
| 108 |
+
|
| 109 |
+
|
| 110 |
## 📝 License
|
| 111 |
|
| 112 |
The code for this project is open-sourced under the [License for AngelSlim](LICENSE).
|