bartowski commited on
Commit
c15570b
·
verified ·
1 Parent(s): 0b59f56

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +180 -0
README.md ADDED
@@ -0,0 +1,180 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ quantized_by: bartowski
3
+ pipeline_tag: text-generation
4
+ ---
5
+
6
+ ## Llamacpp imatrix Quantizations of Darwin-36B-Opus by FINAL-Bench
7
+
8
+ Using <a href="https://github.com/ggml-org/llama.cpp/">llama.cpp</a> release <a href="https://github.com/ggml-org/llama.cpp/releases/tag/b8919">b8919</a> for quantization.
9
+
10
+ Original model: https://huggingface.co/FINAL-Bench/Darwin-36B-Opus
11
+
12
+ All quants made using imatrix option with dataset from [here](https://gist.github.com/bartowski1182/82ae9b520227f57d79ba04add13d0d0d)
13
+
14
+ Run them in your choice of tools:
15
+
16
+ - [llama.cpp](https://github.com/ggml-org/llama.cpp)
17
+ - [ramalama](https://github.com/containers/ramalama)
18
+ - [LM Studio](https://lmstudio.ai/)
19
+ - [koboldcpp](https://github.com/LostRuins/koboldcpp)
20
+ - [Jan AI](https://www.jan.ai/)
21
+ - [Text Generation Web UI](https://github.com/oobabooga/text-generation-webui)
22
+ - [LoLLMs](https://github.com/ParisNeo/lollms)
23
+
24
+ Note: if it's a newly supported model, you may need to wait for an update from the developers.
25
+
26
+ ## Prompt format
27
+
28
+ ```
29
+ <|im_start|>system
30
+ {system_prompt}<|im_end|>
31
+ <|im_start|>user
32
+ {prompt}<|im_end|>
33
+ <|im_start|>assistant
34
+ <think>
35
+ ```
36
+
37
+ ## Download a file (not the whole branch) from below:
38
+
39
+ | Filename | Quant type | File Size | Split | Description |
40
+ | -------- | ---------- | --------- | ----- | ----------- |
41
+ | [Darwin-36B-Opus-bf16.gguf](https://huggingface.co/bartowski/FINAL-Bench_Darwin-36B-Opus-GGUF/tree/main/FINAL-Bench_Darwin-36B-Opus-bf16) | bf16 | 69.38GB | true | Full BF16 weights. |
42
+ | [Darwin-36B-Opus-Q8_0.gguf](https://huggingface.co/bartowski/FINAL-Bench_Darwin-36B-Opus-GGUF/blob/main/FINAL-Bench_Darwin-36B-Opus-Q8_0.gguf) | Q8_0 | 36.91GB | false | Extremely high quality, generally unneeded but max available quant. |
43
+ | [Darwin-36B-Opus-Q6_K_L.gguf](https://huggingface.co/bartowski/FINAL-Bench_Darwin-36B-Opus-GGUF/blob/main/FINAL-Bench_Darwin-36B-Opus-Q6_K_L.gguf) | Q6_K_L | 30.30GB | false | Uses Q8_0 for embed and output weights. Very high quality, near perfect, *recommended*. |
44
+ | [Darwin-36B-Opus-Q6_K.gguf](https://huggingface.co/bartowski/FINAL-Bench_Darwin-36B-Opus-GGUF/blob/main/FINAL-Bench_Darwin-36B-Opus-Q6_K.gguf) | Q6_K | 30.05GB | false | Very high quality, near perfect, *recommended*. |
45
+ | [Darwin-36B-Opus-Q5_K_L.gguf](https://huggingface.co/bartowski/FINAL-Bench_Darwin-36B-Opus-GGUF/blob/main/FINAL-Bench_Darwin-36B-Opus-Q5_K_L.gguf) | Q5_K_L | 25.33GB | false | Uses Q8_0 for embed and output weights. High quality, *recommended*. |
46
+ | [Darwin-36B-Opus-Q5_K_M.gguf](https://huggingface.co/bartowski/FINAL-Bench_Darwin-36B-Opus-GGUF/blob/main/FINAL-Bench_Darwin-36B-Opus-Q5_K_M.gguf) | Q5_K_M | 25.02GB | false | High quality, *recommended*. |
47
+ | [Darwin-36B-Opus-Q5_K_S.gguf](https://huggingface.co/bartowski/FINAL-Bench_Darwin-36B-Opus-GGUF/blob/main/FINAL-Bench_Darwin-36B-Opus-Q5_K_S.gguf) | Q5_K_S | 24.16GB | false | High quality, *recommended*. |
48
+ | [Darwin-36B-Opus-Q4_1.gguf](https://huggingface.co/bartowski/FINAL-Bench_Darwin-36B-Opus-GGUF/blob/main/FINAL-Bench_Darwin-36B-Opus-Q4_1.gguf) | Q4_1 | 21.97GB | false | Legacy format, similar performance to Q4_K_S but with improved tokens/watt on Apple silicon. |
49
+ | [Darwin-36B-Opus-Q4_K_L.gguf](https://huggingface.co/bartowski/FINAL-Bench_Darwin-36B-Opus-GGUF/blob/main/FINAL-Bench_Darwin-36B-Opus-Q4_K_L.gguf) | Q4_K_L | 21.77GB | false | Uses Q8_0 for embed and output weights. Good quality, *recommended*. |
50
+ | [Darwin-36B-Opus-Q4_K_M.gguf](https://huggingface.co/bartowski/FINAL-Bench_Darwin-36B-Opus-GGUF/blob/main/FINAL-Bench_Darwin-36B-Opus-Q4_K_M.gguf) | Q4_K_M | 21.39GB | false | Good quality, default size for most use cases, *recommended*. |
51
+ | [Darwin-36B-Opus-Q4_K_S.gguf](https://huggingface.co/bartowski/FINAL-Bench_Darwin-36B-Opus-GGUF/blob/main/FINAL-Bench_Darwin-36B-Opus-Q4_K_S.gguf) | Q4_K_S | 20.59GB | false | Slightly lower quality with more space savings, *recommended*. |
52
+ | [Darwin-36B-Opus-Q4_0.gguf](https://huggingface.co/bartowski/FINAL-Bench_Darwin-36B-Opus-GGUF/blob/main/FINAL-Bench_Darwin-36B-Opus-Q4_0.gguf) | Q4_0 | 19.94GB | false | Legacy format, offers online repacking for ARM and AVX CPU inference. |
53
+ | [Darwin-36B-Opus-IQ4_NL.gguf](https://huggingface.co/bartowski/FINAL-Bench_Darwin-36B-Opus-GGUF/blob/main/FINAL-Bench_Darwin-36B-Opus-IQ4_NL.gguf) | IQ4_NL | 19.86GB | false | Similar to IQ4_XS, but slightly larger. Offers online repacking for ARM CPU inference. |
54
+ | [Darwin-36B-Opus-IQ4_XS.gguf](https://huggingface.co/bartowski/FINAL-Bench_Darwin-36B-Opus-GGUF/blob/main/FINAL-Bench_Darwin-36B-Opus-IQ4_XS.gguf) | IQ4_XS | 18.81GB | false | Decent quality, smaller than Q4_K_S with similar performance, *recommended*. |
55
+ | [Darwin-36B-Opus-Q3_K_XL.gguf](https://huggingface.co/bartowski/FINAL-Bench_Darwin-36B-Opus-GGUF/blob/main/FINAL-Bench_Darwin-36B-Opus-Q3_K_XL.gguf) | Q3_K_XL | 17.33GB | false | Uses Q8_0 for embed and output weights. Lower quality but usable, good for low RAM availability. |
56
+ | [Darwin-36B-Opus-IQ3_M.gguf](https://huggingface.co/bartowski/FINAL-Bench_Darwin-36B-Opus-GGUF/blob/main/FINAL-Bench_Darwin-36B-Opus-IQ3_M.gguf) | IQ3_M | 16.90GB | false | Medium-low quality, new method with decent performance comparable to Q3_K_M. |
57
+ | [Darwin-36B-Opus-Q3_K_L.gguf](https://huggingface.co/bartowski/FINAL-Bench_Darwin-36B-Opus-GGUF/blob/main/FINAL-Bench_Darwin-36B-Opus-Q3_K_L.gguf) | Q3_K_L | 16.89GB | false | Lower quality but usable, good for low RAM availability. |
58
+ | [Darwin-36B-Opus-Q3_K_M.gguf](https://huggingface.co/bartowski/FINAL-Bench_Darwin-36B-Opus-GGUF/blob/main/FINAL-Bench_Darwin-36B-Opus-Q3_K_M.gguf) | Q3_K_M | 16.23GB | false | Low quality. |
59
+ | [Darwin-36B-Opus-IQ3_XS.gguf](https://huggingface.co/bartowski/FINAL-Bench_Darwin-36B-Opus-GGUF/blob/main/FINAL-Bench_Darwin-36B-Opus-IQ3_XS.gguf) | IQ3_XS | 16.22GB | false | Lower quality, new method with decent performance, slightly better than Q3_K_S. |
60
+ | [Darwin-36B-Opus-Q3_K_S.gguf](https://huggingface.co/bartowski/FINAL-Bench_Darwin-36B-Opus-GGUF/blob/main/FINAL-Bench_Darwin-36B-Opus-Q3_K_S.gguf) | Q3_K_S | 15.51GB | false | Low quality, not recommended. |
61
+ | [Darwin-36B-Opus-IQ3_XXS.gguf](https://huggingface.co/bartowski/FINAL-Bench_Darwin-36B-Opus-GGUF/blob/main/FINAL-Bench_Darwin-36B-Opus-IQ3_XXS.gguf) | IQ3_XXS | 14.87GB | false | Lower quality, new method with decent performance, comparable to Q3 quants. |
62
+ | [Darwin-36B-Opus-Q2_K_L.gguf](https://huggingface.co/bartowski/FINAL-Bench_Darwin-36B-Opus-GGUF/blob/main/FINAL-Bench_Darwin-36B-Opus-Q2_K_L.gguf) | Q2_K_L | 13.11GB | false | Uses Q8_0 for embed and output weights. Very low quality but surprisingly usable. |
63
+ | [Darwin-36B-Opus-Q2_K.gguf](https://huggingface.co/bartowski/FINAL-Bench_Darwin-36B-Opus-GGUF/blob/main/FINAL-Bench_Darwin-36B-Opus-Q2_K.gguf) | Q2_K | 12.62GB | false | Very low quality but surprisingly usable. |
64
+ | [Darwin-36B-Opus-IQ2_M.gguf](https://huggingface.co/bartowski/FINAL-Bench_Darwin-36B-Opus-GGUF/blob/main/FINAL-Bench_Darwin-36B-Opus-IQ2_M.gguf) | IQ2_M | 12.07GB | false | Relatively low quality, uses SOTA techniques to be surprisingly usable. |
65
+ | [Darwin-36B-Opus-IQ2_S.gguf](https://huggingface.co/bartowski/FINAL-Bench_Darwin-36B-Opus-GGUF/blob/main/FINAL-Bench_Darwin-36B-Opus-IQ2_S.gguf) | IQ2_S | 11.01GB | false | Low quality, uses SOTA techniques to be usable. |
66
+ | [Darwin-36B-Opus-IQ2_XS.gguf](https://huggingface.co/bartowski/FINAL-Bench_Darwin-36B-Opus-GGUF/blob/main/FINAL-Bench_Darwin-36B-Opus-IQ2_XS.gguf) | IQ2_XS | 10.80GB | false | Low quality, uses SOTA techniques to be usable. |
67
+ | [Darwin-36B-Opus-IQ2_XXS.gguf](https://huggingface.co/bartowski/FINAL-Bench_Darwin-36B-Opus-GGUF/blob/main/FINAL-Bench_Darwin-36B-Opus-IQ2_XXS.gguf) | IQ2_XXS | 9.78GB | false | Very low quality, uses SOTA techniques to be usable. |
68
+
69
+ ## Embed/output weights
70
+
71
+ Some of these quants (Q3_K_XL, Q4_K_L etc) are the standard quantization method with the embeddings and output weights quantized to Q8_0 instead of what they would normally default to.
72
+
73
+ ## Downloading using huggingface-cli
74
+
75
+ <details>
76
+ <summary>Click to view download instructions</summary>
77
+
78
+ First, make sure you have hugginface-cli installed:
79
+
80
+ ```
81
+ pip install -U "huggingface_hub[cli]"
82
+ ```
83
+
84
+ Then, you can target the specific file you want:
85
+
86
+ ```
87
+ huggingface-cli download bartowski/FINAL-Bench_Darwin-36B-Opus-GGUF --include "FINAL-Bench_Darwin-36B-Opus-Q4_K_M.gguf" --local-dir ./
88
+ ```
89
+
90
+ If the model is bigger than 50GB, it will have been split into multiple files. In order to download them all to a local folder, run:
91
+
92
+ ```
93
+ huggingface-cli download bartowski/FINAL-Bench_Darwin-36B-Opus-GGUF --include "FINAL-Bench_Darwin-36B-Opus-Q8_0/*" --local-dir ./
94
+ ```
95
+
96
+ You can either specify a new local-dir (FINAL-Bench_Darwin-36B-Opus-Q8_0) or download them all in place (./)
97
+
98
+ </details>
99
+
100
+ ## ARM/AVX information
101
+
102
+ Previously, you would download Q4_0_4_4/4_8/8_8, and these would have their weights interleaved in memory in order to improve performance on ARM and AVX machines by loading up more data in one pass.
103
+
104
+ Now, however, there is something called "online repacking" for weights. details in [this PR](https://github.com/ggml-org/llama.cpp/pull/9921). If you use Q4_0 and your hardware would benefit from repacking weights, it will do it automatically on the fly.
105
+
106
+ As of llama.cpp build [b4282](https://github.com/ggml-org/llama.cpp/releases/tag/b4282) you will not be able to run the Q4_0_X_X files and will instead need to use Q4_0.
107
+
108
+ Additionally, if you want to get slightly better quality for , you can use IQ4_NL thanks to [this PR](https://github.com/ggml-org/llama.cpp/pull/10541) which will also repack the weights for ARM, though only the 4_4 for now. The loading time may be slower but it will result in an overall speed incrase.
109
+
110
+ <details>
111
+ <summary>Click to view Q4_0_X_X information (deprecated</summary>
112
+
113
+ I'm keeping this section to show the potential theoretical uplift in performance from using the Q4_0 with online repacking.
114
+
115
+ <details>
116
+ <summary>Click to view benchmarks on an AVX2 system (EPYC7702)</summary>
117
+
118
+ | model | size | params | backend | threads | test | t/s | % (vs Q4_0) |
119
+ | ------------------------------ | ---------: | ---------: | ---------- | ------: | ------------: | -------------------: |-------------: |
120
+ | qwen2 3B Q4_0 | 1.70 GiB | 3.09 B | CPU | 64 | pp512 | 204.03 ± 1.03 | 100% |
121
+ | qwen2 3B Q4_0 | 1.70 GiB | 3.09 B | CPU | 64 | pp1024 | 282.92 ± 0.19 | 100% |
122
+ | qwen2 3B Q4_0 | 1.70 GiB | 3.09 B | CPU | 64 | pp2048 | 259.49 ± 0.44 | 100% |
123
+ | qwen2 3B Q4_0 | 1.70 GiB | 3.09 B | CPU | 64 | tg128 | 39.12 ± 0.27 | 100% |
124
+ | qwen2 3B Q4_0 | 1.70 GiB | 3.09 B | CPU | 64 | tg256 | 39.31 ± 0.69 | 100% |
125
+ | qwen2 3B Q4_0 | 1.70 GiB | 3.09 B | CPU | 64 | tg512 | 40.52 ± 0.03 | 100% |
126
+ | qwen2 3B Q4_K_M | 1.79 GiB | 3.09 B | CPU | 64 | pp512 | 301.02 ± 1.74 | 147% |
127
+ | qwen2 3B Q4_K_M | 1.79 GiB | 3.09 B | CPU | 64 | pp1024 | 287.23 ± 0.20 | 101% |
128
+ | qwen2 3B Q4_K_M | 1.79 GiB | 3.09 B | CPU | 64 | pp2048 | 262.77 ± 1.81 | 101% |
129
+ | qwen2 3B Q4_K_M | 1.79 GiB | 3.09 B | CPU | 64 | tg128 | 18.80 ± 0.99 | 48% |
130
+ | qwen2 3B Q4_K_M | 1.79 GiB | 3.09 B | CPU | 64 | tg256 | 24.46 ± 3.04 | 83% |
131
+ | qwen2 3B Q4_K_M | 1.79 GiB | 3.09 B | CPU | 64 | tg512 | 36.32 ± 3.59 | 90% |
132
+ | qwen2 3B Q4_0_8_8 | 1.69 GiB | 3.09 B | CPU | 64 | pp512 | 271.71 ± 3.53 | 133% |
133
+ | qwen2 3B Q4_0_8_8 | 1.69 GiB | 3.09 B | CPU | 64 | pp1024 | 279.86 ± 45.63 | 100% |
134
+ | qwen2 3B Q4_0_8_8 | 1.69 GiB | 3.09 B | CPU | 64 | pp2048 | 320.77 ± 5.00 | 124% |
135
+ | qwen2 3B Q4_0_8_8 | 1.69 GiB | 3.09 B | CPU | 64 | tg128 | 43.51 ± 0.05 | 111% |
136
+ | qwen2 3B Q4_0_8_8 | 1.69 GiB | 3.09 B | CPU | 64 | tg256 | 43.35 ± 0.09 | 110% |
137
+ | qwen2 3B Q4_0_8_8 | 1.69 GiB | 3.09 B | CPU | 64 | tg512 | 42.60 ± 0.31 | 105% |
138
+
139
+ Q4_0_8_8 offers a nice bump to prompt processing and a small bump to text generation
140
+
141
+ </details>
142
+
143
+ </details>
144
+
145
+ ## Which file should I choose?
146
+
147
+ <details>
148
+ <summary>Click here for details</summary>
149
+
150
+ A great write up with charts showing various performances is provided by Artefact2 [here](https://gist.github.com/Artefact2/b5f810600771265fc1e39442288e8ec9)
151
+
152
+ The first thing to figure out is how big a model you can run. To do this, you'll need to figure out how much RAM and/or VRAM you have.
153
+
154
+ If you want your model running as FAST as possible, you'll want to fit the whole thing on your GPU's VRAM. Aim for a quant with a file size 1-2GB smaller than your GPU's total VRAM.
155
+
156
+ If you want the absolute maximum quality, add both your system RAM and your GPU's VRAM together, then similarly grab a quant with a file size 1-2GB Smaller than that total.
157
+
158
+ Next, you'll need to decide if you want to use an 'I-quant' or a 'K-quant'.
159
+
160
+ If you don't want to think too much, grab one of the K-quants. These are in format 'QX_K_X', like Q5_K_M.
161
+
162
+ If you want to get more into the weeds, you can check out this extremely useful feature chart:
163
+
164
+ [llama.cpp feature matrix](https://github.com/ggml-org/llama.cpp/wiki/Feature-matrix)
165
+
166
+ But basically, if you're aiming for below Q4, and you're running cuBLAS (Nvidia) or rocBLAS (AMD), you should look towards the I-quants. These are in format IQX_X, like IQ3_M. These are newer and offer better performance for their size.
167
+
168
+ These I-quants can also be used on CPU, but will be slower than their K-quant equivalent, so speed vs performance is a tradeoff you'll have to decide.
169
+
170
+ </details>
171
+
172
+ ## Credits
173
+
174
+ Thank you kalomaze and Dampf for assistance in creating the imatrix calibration dataset.
175
+
176
+ Thank you ZeroWw for the inspiration to experiment with embed/output.
177
+
178
+ Thank you to LM Studio for sponsoring my work.
179
+
180
+ Want to support my work? Visit my ko-fi page here: https://ko-fi.com/bartowski