bartowski's picture
Upload README.md with huggingface_hub
8c2c741 verified
|
raw
history blame
10.8 kB
metadata
quantized_by: bartowski
pipeline_tag: text-generation

Llamacpp imatrix Quantizations of TQ2.5-14B-Sugarquill-v1

Using llama.cpp release b4014 for quantization.

Original model: https://huggingface.co/allura-org/TQ2.5-14B-Sugarquill-v1

All quants made using imatrix option with dataset from here

Run them in LM Studio

Prompt format

<|im_start|>system
{system_prompt}<|im_end|>
<|im_start|>user
{prompt}<|im_end|>
<|im_start|>assistant

Download a file (not the whole branch) from below:

Filename Quant type File Size Split Description
TQ2.5-14B-Sugarquill-v1-f16.gguf f16 29.55GB false Full F16 weights.
TQ2.5-14B-Sugarquill-v1-Q8_0.gguf Q8_0 15.70GB false Extremely high quality, generally unneeded but max available quant.
TQ2.5-14B-Sugarquill-v1-Q6_K_L.gguf Q6_K_L 12.50GB false Uses Q8_0 for embed and output weights. Very high quality, near perfect, recommended.
TQ2.5-14B-Sugarquill-v1-Q6_K.gguf Q6_K 12.12GB false Very high quality, near perfect, recommended.
TQ2.5-14B-Sugarquill-v1-Q5_K_L.gguf Q5_K_L 10.99GB false Uses Q8_0 for embed and output weights. High quality, recommended.
TQ2.5-14B-Sugarquill-v1-Q5_K_M.gguf Q5_K_M 10.51GB false High quality, recommended.
TQ2.5-14B-Sugarquill-v1-Q5_K_S.gguf Q5_K_S 10.27GB false High quality, recommended.
TQ2.5-14B-Sugarquill-v1-Q4_K_L.gguf Q4_K_L 9.57GB false Uses Q8_0 for embed and output weights. Good quality, recommended.
TQ2.5-14B-Sugarquill-v1-Q4_K_M.gguf Q4_K_M 8.99GB false Good quality, default size for must use cases, recommended.
TQ2.5-14B-Sugarquill-v1-Q3_K_XL.gguf Q3_K_XL 8.61GB false Uses Q8_0 for embed and output weights. Lower quality but usable, good for low RAM availability.
TQ2.5-14B-Sugarquill-v1-Q4_K_S.gguf Q4_K_S 8.57GB false Slightly lower quality with more space savings, recommended.
TQ2.5-14B-Sugarquill-v1-Q4_0.gguf Q4_0 8.54GB false Legacy format, generally not worth using over similarly sized formats
TQ2.5-14B-Sugarquill-v1-Q4_0_8_8.gguf Q4_0_8_8 8.52GB false Optimized for ARM inference. Requires 'sve' support (see link below). Don't use on Mac or Windows.
TQ2.5-14B-Sugarquill-v1-Q4_0_4_8.gguf Q4_0_4_8 8.52GB false Optimized for ARM inference. Requires 'i8mm' support (see link below). Don't use on Mac or Windows.
TQ2.5-14B-Sugarquill-v1-Q4_0_4_4.gguf Q4_0_4_4 8.52GB false Optimized for ARM inference. Should work well on all ARM chips, pick this if you're unsure. Don't use on Mac or Windows.
TQ2.5-14B-Sugarquill-v1-IQ4_XS.gguf IQ4_XS 8.12GB false Decent quality, smaller than Q4_K_S with similar performance, recommended.
TQ2.5-14B-Sugarquill-v1-Q3_K_L.gguf Q3_K_L 7.92GB false Lower quality but usable, good for low RAM availability.
TQ2.5-14B-Sugarquill-v1-Q3_K_M.gguf Q3_K_M 7.34GB false Low quality.
TQ2.5-14B-Sugarquill-v1-IQ3_M.gguf IQ3_M 6.92GB false Medium-low quality, new method with decent performance comparable to Q3_K_M.
TQ2.5-14B-Sugarquill-v1-Q3_K_S.gguf Q3_K_S 6.66GB false Low quality, not recommended.
TQ2.5-14B-Sugarquill-v1-Q2_K_L.gguf Q2_K_L 6.53GB false Uses Q8_0 for embed and output weights. Very low quality but surprisingly usable.
TQ2.5-14B-Sugarquill-v1-IQ3_XS.gguf IQ3_XS 6.38GB false Lower quality, new method with decent performance, slightly better than Q3_K_S.
TQ2.5-14B-Sugarquill-v1-Q2_K.gguf Q2_K 5.77GB false Very low quality but surprisingly usable.
TQ2.5-14B-Sugarquill-v1-IQ2_M.gguf IQ2_M 5.36GB false Relatively low quality, uses SOTA techniques to be surprisingly usable.
TQ2.5-14B-Sugarquill-v1-IQ2_S.gguf IQ2_S 5.00GB false Low quality, uses SOTA techniques to be usable.
TQ2.5-14B-Sugarquill-v1-IQ2_XS.gguf IQ2_XS 4.70GB false Low quality, uses SOTA techniques to be usable.

Embed/output weights

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.

Some say that this improves the quality, others don't notice any difference. If you use these models PLEASE COMMENT with your findings. I would like feedback that these are actually used and useful so I don't keep uploading quants no one is using.

Thanks!

Downloading using huggingface-cli

First, make sure you have hugginface-cli installed:

pip install -U "huggingface_hub[cli]"

Then, you can target the specific file you want:

huggingface-cli download bartowski/TQ2.5-14B-Sugarquill-v1-GGUF --include "TQ2.5-14B-Sugarquill-v1-Q4_K_M.gguf" --local-dir ./

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:

huggingface-cli download bartowski/TQ2.5-14B-Sugarquill-v1-GGUF --include "TQ2.5-14B-Sugarquill-v1-Q8_0/*" --local-dir ./

You can either specify a new local-dir (TQ2.5-14B-Sugarquill-v1-Q8_0) or download them all in place (./)

Q4_0_X_X

These are NOT for Metal (Apple) offloading, only ARM chips.

If you're using an ARM chip, the Q4_0_X_X quants will have a substantial speedup. Check out Q4_0_4_4 speed comparisons on the original pull request

To check which one would work best for your ARM chip, you can check AArch64 SoC features (thanks EloyOn!).

Which file should I choose?

A great write up with charts showing various performances is provided by Artefact2 here

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.

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.

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.

Next, you'll need to decide if you want to use an 'I-quant' or a 'K-quant'.

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.

If you want to get more into the weeds, you can check out this extremely useful feature chart:

llama.cpp feature matrix

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.

These I-quants can also be used on CPU and Apple Metal, but will be slower than their K-quant equivalent, so speed vs performance is a tradeoff you'll have to decide.

The I-quants are not compatible with Vulcan, which is also AMD, so if you have an AMD card double check if you're using the rocBLAS build or the Vulcan build. At the time of writing this, LM Studio has a preview with ROCm support, and other inference engines have specific builds for ROCm.

Credits

Thank you kalomaze and Dampf for assistance in creating the imatrix calibration dataset

Thank you ZeroWw for the inspiration to experiment with embed/output

Want to support my work? Visit my ko-fi page here: https://ko-fi.com/bartowski