bartowski commited on
Commit
9f60dd4
·
verified ·
1 Parent(s): a72691e

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
+ quantized_by: bartowski
3
+ pipeline_tag: text-generation
4
+ ---
5
+
6
+ ## Llamacpp imatrix Quantizations of Jan-v1-4B by janhq
7
+
8
+ Using <a href="https://github.com/ggerganov/llama.cpp/">llama.cpp</a> release <a href="https://github.com/ggerganov/llama.cpp/releases/tag/b6115">b6115</a> for quantization.
9
+
10
+ Original model: https://huggingface.co/janhq/Jan-v1-4B
11
+
12
+ All quants made using imatrix option with dataset from [here](https://gist.github.com/bartowski1182/eb213dccb3571f863da82e99418f81e8) combined with a subset of combined_all_small.parquet from Ed Addario [here](https://huggingface.co/datasets/eaddario/imatrix-calibration/blob/main/combined_all_small.parquet)
13
+
14
+ Run them in [LM Studio](https://lmstudio.ai/)
15
+
16
+ Run them directly with [llama.cpp](https://github.com/ggerganov/llama.cpp), or any other llama.cpp based project
17
+
18
+ ## Prompt format
19
+
20
+ No prompt format found, check original model page
21
+
22
+ ## Download a file (not the whole branch) from below:
23
+
24
+ | Filename | Quant type | File Size | Split | Description |
25
+ | -------- | ---------- | --------- | ----- | ----------- |
26
+ | [Jan-v1-4B-bf16.gguf](https://huggingface.co/bartowski/janhq_Jan-v1-4B-GGUF/blob/main/janhq_Jan-v1-4B-bf16.gguf) | bf16 | 8.05GB | false | Full BF16 weights. |
27
+ | [Jan-v1-4B-Q8_0.gguf](https://huggingface.co/bartowski/janhq_Jan-v1-4B-GGUF/blob/main/janhq_Jan-v1-4B-Q8_0.gguf) | Q8_0 | 4.28GB | false | Extremely high quality, generally unneeded but max available quant. |
28
+ | [Jan-v1-4B-Q6_K_L.gguf](https://huggingface.co/bartowski/janhq_Jan-v1-4B-GGUF/blob/main/janhq_Jan-v1-4B-Q6_K_L.gguf) | Q6_K_L | 3.40GB | false | Uses Q8_0 for embed and output weights. Very high quality, near perfect, *recommended*. |
29
+ | [Jan-v1-4B-Q6_K.gguf](https://huggingface.co/bartowski/janhq_Jan-v1-4B-GGUF/blob/main/janhq_Jan-v1-4B-Q6_K.gguf) | Q6_K | 3.31GB | false | Very high quality, near perfect, *recommended*. |
30
+ | [Jan-v1-4B-Q5_K_L.gguf](https://huggingface.co/bartowski/janhq_Jan-v1-4B-GGUF/blob/main/janhq_Jan-v1-4B-Q5_K_L.gguf) | Q5_K_L | 2.98GB | false | Uses Q8_0 for embed and output weights. High quality, *recommended*. |
31
+ | [Jan-v1-4B-Q5_K_M.gguf](https://huggingface.co/bartowski/janhq_Jan-v1-4B-GGUF/blob/main/janhq_Jan-v1-4B-Q5_K_M.gguf) | Q5_K_M | 2.89GB | false | High quality, *recommended*. |
32
+ | [Jan-v1-4B-Q5_K_S.gguf](https://huggingface.co/bartowski/janhq_Jan-v1-4B-GGUF/blob/main/janhq_Jan-v1-4B-Q5_K_S.gguf) | Q5_K_S | 2.82GB | false | High quality, *recommended*. |
33
+ | [Jan-v1-4B-Q4_1.gguf](https://huggingface.co/bartowski/janhq_Jan-v1-4B-GGUF/blob/main/janhq_Jan-v1-4B-Q4_1.gguf) | Q4_1 | 2.60GB | false | Legacy format, similar performance to Q4_K_S but with improved tokens/watt on Apple silicon. |
34
+ | [Jan-v1-4B-Q4_K_L.gguf](https://huggingface.co/bartowski/janhq_Jan-v1-4B-GGUF/blob/main/janhq_Jan-v1-4B-Q4_K_L.gguf) | Q4_K_L | 2.59GB | false | Uses Q8_0 for embed and output weights. Good quality, *recommended*. |
35
+ | [Jan-v1-4B-Q4_K_M.gguf](https://huggingface.co/bartowski/janhq_Jan-v1-4B-GGUF/blob/main/janhq_Jan-v1-4B-Q4_K_M.gguf) | Q4_K_M | 2.50GB | false | Good quality, default size for most use cases, *recommended*. |
36
+ | [Jan-v1-4B-Q4_K_S.gguf](https://huggingface.co/bartowski/janhq_Jan-v1-4B-GGUF/blob/main/janhq_Jan-v1-4B-Q4_K_S.gguf) | Q4_K_S | 2.38GB | false | Slightly lower quality with more space savings, *recommended*. |
37
+ | [Jan-v1-4B-Q4_0.gguf](https://huggingface.co/bartowski/janhq_Jan-v1-4B-GGUF/blob/main/janhq_Jan-v1-4B-Q4_0.gguf) | Q4_0 | 2.38GB | false | Legacy format, offers online repacking for ARM and AVX CPU inference. |
38
+ | [Jan-v1-4B-IQ4_NL.gguf](https://huggingface.co/bartowski/janhq_Jan-v1-4B-GGUF/blob/main/janhq_Jan-v1-4B-IQ4_NL.gguf) | IQ4_NL | 2.38GB | false | Similar to IQ4_XS, but slightly larger. Offers online repacking for ARM CPU inference. |
39
+ | [Jan-v1-4B-Q3_K_XL.gguf](https://huggingface.co/bartowski/janhq_Jan-v1-4B-GGUF/blob/main/janhq_Jan-v1-4B-Q3_K_XL.gguf) | Q3_K_XL | 2.33GB | false | Uses Q8_0 for embed and output weights. Lower quality but usable, good for low RAM availability. |
40
+ | [Jan-v1-4B-IQ4_XS.gguf](https://huggingface.co/bartowski/janhq_Jan-v1-4B-GGUF/blob/main/janhq_Jan-v1-4B-IQ4_XS.gguf) | IQ4_XS | 2.27GB | false | Decent quality, smaller than Q4_K_S with similar performance, *recommended*. |
41
+ | [Jan-v1-4B-Q3_K_L.gguf](https://huggingface.co/bartowski/janhq_Jan-v1-4B-GGUF/blob/main/janhq_Jan-v1-4B-Q3_K_L.gguf) | Q3_K_L | 2.24GB | false | Lower quality but usable, good for low RAM availability. |
42
+ | [Jan-v1-4B-Q3_K_M.gguf](https://huggingface.co/bartowski/janhq_Jan-v1-4B-GGUF/blob/main/janhq_Jan-v1-4B-Q3_K_M.gguf) | Q3_K_M | 2.08GB | false | Low quality. |
43
+ | [Jan-v1-4B-IQ3_M.gguf](https://huggingface.co/bartowski/janhq_Jan-v1-4B-GGUF/blob/main/janhq_Jan-v1-4B-IQ3_M.gguf) | IQ3_M | 1.96GB | false | Medium-low quality, new method with decent performance comparable to Q3_K_M. |
44
+ | [Jan-v1-4B-Q3_K_S.gguf](https://huggingface.co/bartowski/janhq_Jan-v1-4B-GGUF/blob/main/janhq_Jan-v1-4B-Q3_K_S.gguf) | Q3_K_S | 1.89GB | false | Low quality, not recommended. |
45
+ | [Jan-v1-4B-IQ3_XS.gguf](https://huggingface.co/bartowski/janhq_Jan-v1-4B-GGUF/blob/main/janhq_Jan-v1-4B-IQ3_XS.gguf) | IQ3_XS | 1.81GB | false | Lower quality, new method with decent performance, slightly better than Q3_K_S. |
46
+ | [Jan-v1-4B-Q2_K_L.gguf](https://huggingface.co/bartowski/janhq_Jan-v1-4B-GGUF/blob/main/janhq_Jan-v1-4B-Q2_K_L.gguf) | Q2_K_L | 1.76GB | false | Uses Q8_0 for embed and output weights. Very low quality but surprisingly usable. |
47
+ | [Jan-v1-4B-IQ3_XXS.gguf](https://huggingface.co/bartowski/janhq_Jan-v1-4B-GGUF/blob/main/janhq_Jan-v1-4B-IQ3_XXS.gguf) | IQ3_XXS | 1.67GB | false | Lower quality, new method with decent performance, comparable to Q3 quants. |
48
+ | [Jan-v1-4B-Q2_K.gguf](https://huggingface.co/bartowski/janhq_Jan-v1-4B-GGUF/blob/main/janhq_Jan-v1-4B-Q2_K.gguf) | Q2_K | 1.67GB | false | Very low quality but surprisingly usable. |
49
+ | [Jan-v1-4B-IQ2_M.gguf](https://huggingface.co/bartowski/janhq_Jan-v1-4B-GGUF/blob/main/janhq_Jan-v1-4B-IQ2_M.gguf) | IQ2_M | 1.51GB | false | Relatively low quality, uses SOTA techniques to be surprisingly usable. |
50
+
51
+ ## Embed/output weights
52
+
53
+ 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.
54
+
55
+ ## Downloading using huggingface-cli
56
+
57
+ <details>
58
+ <summary>Click to view download instructions</summary>
59
+
60
+ First, make sure you have hugginface-cli installed:
61
+
62
+ ```
63
+ pip install -U "huggingface_hub[cli]"
64
+ ```
65
+
66
+ Then, you can target the specific file you want:
67
+
68
+ ```
69
+ huggingface-cli download bartowski/janhq_Jan-v1-4B-GGUF --include "janhq_Jan-v1-4B-Q4_K_M.gguf" --local-dir ./
70
+ ```
71
+
72
+ 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:
73
+
74
+ ```
75
+ huggingface-cli download bartowski/janhq_Jan-v1-4B-GGUF --include "janhq_Jan-v1-4B-Q8_0/*" --local-dir ./
76
+ ```
77
+
78
+ You can either specify a new local-dir (janhq_Jan-v1-4B-Q8_0) or download them all in place (./)
79
+
80
+ </details>
81
+
82
+ ## ARM/AVX information
83
+
84
+ 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.
85
+
86
+ Now, however, there is something called "online repacking" for weights. details in [this PR](https://github.com/ggerganov/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.
87
+
88
+ As of llama.cpp build [b4282](https://github.com/ggerganov/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.
89
+
90
+ Additionally, if you want to get slightly better quality for , you can use IQ4_NL thanks to [this PR](https://github.com/ggerganov/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.
91
+
92
+ <details>
93
+ <summary>Click to view Q4_0_X_X information (deprecated</summary>
94
+
95
+ I'm keeping this section to show the potential theoretical uplift in performance from using the Q4_0 with online repacking.
96
+
97
+ <details>
98
+ <summary>Click to view benchmarks on an AVX2 system (EPYC7702)</summary>
99
+
100
+ | model | size | params | backend | threads | test | t/s | % (vs Q4_0) |
101
+ | ------------------------------ | ---------: | ---------: | ---------- | ------: | ------------: | -------------------: |-------------: |
102
+ | qwen2 3B Q4_0 | 1.70 GiB | 3.09 B | CPU | 64 | pp512 | 204.03 ± 1.03 | 100% |
103
+ | qwen2 3B Q4_0 | 1.70 GiB | 3.09 B | CPU | 64 | pp1024 | 282.92 ± 0.19 | 100% |
104
+ | qwen2 3B Q4_0 | 1.70 GiB | 3.09 B | CPU | 64 | pp2048 | 259.49 ± 0.44 | 100% |
105
+ | qwen2 3B Q4_0 | 1.70 GiB | 3.09 B | CPU | 64 | tg128 | 39.12 ± 0.27 | 100% |
106
+ | qwen2 3B Q4_0 | 1.70 GiB | 3.09 B | CPU | 64 | tg256 | 39.31 ± 0.69 | 100% |
107
+ | qwen2 3B Q4_0 | 1.70 GiB | 3.09 B | CPU | 64 | tg512 | 40.52 ± 0.03 | 100% |
108
+ | qwen2 3B Q4_K_M | 1.79 GiB | 3.09 B | CPU | 64 | pp512 | 301.02 ± 1.74 | 147% |
109
+ | qwen2 3B Q4_K_M | 1.79 GiB | 3.09 B | CPU | 64 | pp1024 | 287.23 ± 0.20 | 101% |
110
+ | qwen2 3B Q4_K_M | 1.79 GiB | 3.09 B | CPU | 64 | pp2048 | 262.77 ± 1.81 | 101% |
111
+ | qwen2 3B Q4_K_M | 1.79 GiB | 3.09 B | CPU | 64 | tg128 | 18.80 ± 0.99 | 48% |
112
+ | qwen2 3B Q4_K_M | 1.79 GiB | 3.09 B | CPU | 64 | tg256 | 24.46 ± 3.04 | 83% |
113
+ | qwen2 3B Q4_K_M | 1.79 GiB | 3.09 B | CPU | 64 | tg512 | 36.32 ± 3.59 | 90% |
114
+ | qwen2 3B Q4_0_8_8 | 1.69 GiB | 3.09 B | CPU | 64 | pp512 | 271.71 ± 3.53 | 133% |
115
+ | qwen2 3B Q4_0_8_8 | 1.69 GiB | 3.09 B | CPU | 64 | pp1024 | 279.86 ± 45.63 | 100% |
116
+ | qwen2 3B Q4_0_8_8 | 1.69 GiB | 3.09 B | CPU | 64 | pp2048 | 320.77 ± 5.00 | 124% |
117
+ | qwen2 3B Q4_0_8_8 | 1.69 GiB | 3.09 B | CPU | 64 | tg128 | 43.51 ± 0.05 | 111% |
118
+ | qwen2 3B Q4_0_8_8 | 1.69 GiB | 3.09 B | CPU | 64 | tg256 | 43.35 ± 0.09 | 110% |
119
+ | qwen2 3B Q4_0_8_8 | 1.69 GiB | 3.09 B | CPU | 64 | tg512 | 42.60 ± 0.31 | 105% |
120
+
121
+ Q4_0_8_8 offers a nice bump to prompt processing and a small bump to text generation
122
+
123
+ </details>
124
+
125
+ </details>
126
+
127
+ ## Which file should I choose?
128
+
129
+ <details>
130
+ <summary>Click here for details</summary>
131
+
132
+ A great write up with charts showing various performances is provided by Artefact2 [here](https://gist.github.com/Artefact2/b5f810600771265fc1e39442288e8ec9)
133
+
134
+ 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.
135
+
136
+ 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.
137
+
138
+ 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.
139
+
140
+ Next, you'll need to decide if you want to use an 'I-quant' or a 'K-quant'.
141
+
142
+ 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.
143
+
144
+ If you want to get more into the weeds, you can check out this extremely useful feature chart:
145
+
146
+ [llama.cpp feature matrix](https://github.com/ggerganov/llama.cpp/wiki/Feature-matrix)
147
+
148
+ 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.
149
+
150
+ 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.
151
+
152
+ </details>
153
+
154
+ ## Credits
155
+
156
+ Thank you kalomaze and Dampf for assistance in creating the imatrix calibration dataset.
157
+
158
+ Thank you ZeroWw for the inspiration to experiment with embed/output.
159
+
160
+ Thank you to LM Studio for sponsoring my work.
161
+
162
+ Want to support my work? Visit my ko-fi page here: https://ko-fi.com/bartowski