legraphista commited on
Commit
cbed050
β€’
1 Parent(s): 45a0501

Upload README.md with huggingface_hub

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