legraphista commited on
Commit
8902583
β€’
1 Parent(s): 4bd4551

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +167 -0
README.md ADDED
@@ -0,0 +1,167 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: Qwen/Qwen2.5-3B-Instruct
3
+ inference: false
4
+ language:
5
+ - en
6
+ library_name: gguf
7
+ license: other
8
+ license_link: https://huggingface.co/Qwen/Qwen2.5-3B-Instruct/blob/main/LICENSE
9
+ license_name: qwen-research
10
+ pipeline_tag: text-generation
11
+ quantized_by: legraphista
12
+ tags:
13
+ - chat
14
+ - quantized
15
+ - GGUF
16
+ - quantization
17
+ - imat
18
+ - imatrix
19
+ - static
20
+ - 16bit
21
+ - 8bit
22
+ - 6bit
23
+ - 5bit
24
+ - 4bit
25
+ - 3bit
26
+ - 2bit
27
+ - 1bit
28
+ ---
29
+
30
+ # Qwen2.5-3B-Instruct-IMat-GGUF
31
+ _Llama.cpp imatrix quantization of Qwen/Qwen2.5-3B-Instruct_
32
+
33
+ Original Model: [Qwen/Qwen2.5-3B-Instruct](https://huggingface.co/Qwen/Qwen2.5-3B-Instruct)
34
+ Original dtype: `BF16` (`bfloat16`)
35
+ Quantized by: llama.cpp [b3785](https://github.com/ggerganov/llama.cpp/releases/tag/b3785)
36
+ IMatrix dataset: [here](https://gist.githubusercontent.com/bartowski1182/eb213dccb3571f863da82e99418f81e8/raw/b2869d80f5c16fd7082594248e80144677736635/calibration_datav3.txt)
37
+
38
+ - [Files](#files)
39
+ - [IMatrix](#imatrix)
40
+ - [Common Quants](#common-quants)
41
+ - [All Quants](#all-quants)
42
+ - [Downloading using huggingface-cli](#downloading-using-huggingface-cli)
43
+ - [Inference](#inference)
44
+ - [Simple chat template](#simple-chat-template)
45
+ - [Chat template with system prompt](#chat-template-with-system-prompt)
46
+ - [Llama.cpp](#llama-cpp)
47
+ - [FAQ](#faq)
48
+ - [Why is the IMatrix not applied everywhere?](#why-is-the-imatrix-not-applied-everywhere)
49
+ - [How do I merge a split GGUF?](#how-do-i-merge-a-split-gguf)
50
+
51
+ ---
52
+
53
+ ## Files
54
+
55
+ ### IMatrix
56
+ Status: ⏳ Processing
57
+ Link: [here](https://huggingface.co/legraphista/Qwen2.5-3B-Instruct-IMat-GGUF/blob/main/imatrix.dat)
58
+
59
+ ### Common Quants
60
+ | Filename | Quant type | File Size | Status | Uses IMatrix | Is Split |
61
+ | -------- | ---------- | --------- | ------ | ------------ | -------- |
62
+ | Qwen2.5-3B-Instruct.Q8_0 | Q8_0 | - | ⏳ Processing | βšͺ Static | -
63
+ | Qwen2.5-3B-Instruct.Q6_K | Q6_K | - | ⏳ Processing | βšͺ Static | -
64
+ | Qwen2.5-3B-Instruct.Q4_K | Q4_K | - | ⏳ Processing | 🟒 IMatrix | -
65
+ | Qwen2.5-3B-Instruct.Q3_K | Q3_K | - | ⏳ Processing | 🟒 IMatrix | -
66
+ | Qwen2.5-3B-Instruct.Q2_K | Q2_K | - | ⏳ Processing | 🟒 IMatrix | -
67
+
68
+
69
+ ### All Quants
70
+ | Filename | Quant type | File Size | Status | Uses IMatrix | Is Split |
71
+ | -------- | ---------- | --------- | ------ | ------------ | -------- |
72
+ | Qwen2.5-3B-Instruct.BF16 | BF16 | - | ⏳ Processing | βšͺ Static | -
73
+ | Qwen2.5-3B-Instruct.FP16 | F16 | - | ⏳ Processing | βšͺ Static | -
74
+ | Qwen2.5-3B-Instruct.Q8_0 | Q8_0 | - | ⏳ Processing | βšͺ Static | -
75
+ | Qwen2.5-3B-Instruct.Q6_K | Q6_K | - | ⏳ Processing | βšͺ Static | -
76
+ | Qwen2.5-3B-Instruct.Q5_K | Q5_K | - | ⏳ Processing | βšͺ Static | -
77
+ | Qwen2.5-3B-Instruct.Q5_K_S | Q5_K_S | - | ⏳ Processing | βšͺ Static | -
78
+ | Qwen2.5-3B-Instruct.Q4_K | Q4_K | - | ⏳ Processing | 🟒 IMatrix | -
79
+ | Qwen2.5-3B-Instruct.Q4_K_S | Q4_K_S | - | ⏳ Processing | 🟒 IMatrix | -
80
+ | Qwen2.5-3B-Instruct.IQ4_NL | IQ4_NL | - | ⏳ Processing | 🟒 IMatrix | -
81
+ | Qwen2.5-3B-Instruct.IQ4_XS | IQ4_XS | - | ⏳ Processing | 🟒 IMatrix | -
82
+ | Qwen2.5-3B-Instruct.Q3_K | Q3_K | - | ⏳ Processing | 🟒 IMatrix | -
83
+ | Qwen2.5-3B-Instruct.Q3_K_L | Q3_K_L | - | ⏳ Processing | 🟒 IMatrix | -
84
+ | Qwen2.5-3B-Instruct.Q3_K_S | Q3_K_S | - | ⏳ Processing | 🟒 IMatrix | -
85
+ | Qwen2.5-3B-Instruct.IQ3_M | IQ3_M | - | ⏳ Processing | 🟒 IMatrix | -
86
+ | Qwen2.5-3B-Instruct.IQ3_S | IQ3_S | - | ⏳ Processing | 🟒 IMatrix | -
87
+ | Qwen2.5-3B-Instruct.IQ3_XS | IQ3_XS | - | ⏳ Processing | 🟒 IMatrix | -
88
+ | Qwen2.5-3B-Instruct.IQ3_XXS | IQ3_XXS | - | ⏳ Processing | 🟒 IMatrix | -
89
+ | Qwen2.5-3B-Instruct.Q2_K | Q2_K | - | ⏳ Processing | 🟒 IMatrix | -
90
+ | Qwen2.5-3B-Instruct.Q2_K_S | Q2_K_S | - | ⏳ Processing | 🟒 IMatrix | -
91
+ | Qwen2.5-3B-Instruct.IQ2_M | IQ2_M | - | ⏳ Processing | 🟒 IMatrix | -
92
+ | Qwen2.5-3B-Instruct.IQ2_S | IQ2_S | - | ⏳ Processing | 🟒 IMatrix | -
93
+ | Qwen2.5-3B-Instruct.IQ2_XS | IQ2_XS | - | ⏳ Processing | 🟒 IMatrix | -
94
+ | Qwen2.5-3B-Instruct.IQ2_XXS | IQ2_XXS | - | ⏳ Processing | 🟒 IMatrix | -
95
+ | Qwen2.5-3B-Instruct.IQ1_M | IQ1_M | - | ⏳ Processing | 🟒 IMatrix | -
96
+ | Qwen2.5-3B-Instruct.IQ1_S | IQ1_S | - | ⏳ Processing | 🟒 IMatrix | -
97
+
98
+
99
+ ## Downloading using huggingface-cli
100
+ If you do not have hugginface-cli installed:
101
+ ```
102
+ pip install -U "huggingface_hub[cli]"
103
+ ```
104
+ Download the specific file you want:
105
+ ```
106
+ huggingface-cli download legraphista/Qwen2.5-3B-Instruct-IMat-GGUF --include "Qwen2.5-3B-Instruct.Q8_0.gguf" --local-dir ./
107
+ ```
108
+ If the model file is big, it has been split into multiple files. In order to download them all to a local folder, run:
109
+ ```
110
+ huggingface-cli download legraphista/Qwen2.5-3B-Instruct-IMat-GGUF --include "Qwen2.5-3B-Instruct.Q8_0/*" --local-dir ./
111
+ # see FAQ for merging GGUF's
112
+ ```
113
+
114
+ ---
115
+
116
+ ## Inference
117
+
118
+ ### Simple chat template
119
+ ```
120
+ <|im_start|>system
121
+ You are Qwen, created by Alibaba Cloud. You are a helpful assistant.<|im_end|>
122
+ <|im_start|>user
123
+ {user_prompt}<|im_end|>
124
+ <|im_start|>assistant
125
+ {assistant_response}<|im_end|>
126
+ <|im_start|>user
127
+ {next_user_prompt}<|im_end|>
128
+
129
+ ```
130
+
131
+ ### Chat template with system prompt
132
+ ```
133
+ <|im_start|>system
134
+ {system_prompt}<|im_end|>
135
+ <|im_start|>user
136
+ {user_prompt}<|im_end|>
137
+ <|im_start|>assistant
138
+ {assistant_response}<|im_end|>
139
+ <|im_start|>user
140
+ {next_user_prompt}<|im_end|>
141
+
142
+ ```
143
+
144
+ ### Llama.cpp
145
+ ```
146
+ llama.cpp/main -m Qwen2.5-3B-Instruct.Q8_0.gguf --color -i -p "prompt here (according to the chat template)"
147
+ ```
148
+
149
+ ---
150
+
151
+ ## FAQ
152
+
153
+ ### Why is the IMatrix not applied everywhere?
154
+ According to [this investigation](https://www.reddit.com/r/LocalLLaMA/comments/1993iro/ggufs_quants_can_punch_above_their_weights_now/), it appears that lower quantizations are the only ones that benefit from the imatrix input (as per hellaswag results).
155
+
156
+ ### How do I merge a split GGUF?
157
+ 1. Make sure you have `gguf-split` available
158
+ - To get hold of `gguf-split`, navigate to https://github.com/ggerganov/llama.cpp/releases
159
+ - Download the appropriate zip for your system from the latest release
160
+ - Unzip the archive and you should be able to find `gguf-split`
161
+ 2. Locate your GGUF chunks folder (ex: `Qwen2.5-3B-Instruct.Q8_0`)
162
+ 3. Run `gguf-split --merge Qwen2.5-3B-Instruct.Q8_0/Qwen2.5-3B-Instruct.Q8_0-00001-of-XXXXX.gguf Qwen2.5-3B-Instruct.Q8_0.gguf`
163
+ - Make sure to point `gguf-split` to the first chunk of the split.
164
+
165
+ ---
166
+
167
+ Got a suggestion? Ping me [@legraphista](https://x.com/legraphista)!