|
--- |
|
base_model: google/shieldgemma-2b |
|
extra_gated_button_content: Acknowledge license |
|
extra_gated_heading: Access Gemma on Hugging Face |
|
extra_gated_prompt: "To access Gemma on Hugging Face, you\u2019re required to review\ |
|
\ and agree to Google\u2019s usage license. To do this, please ensure you\u2019\ |
|
re logged in to Hugging Face and click below. Requests are processed immediately." |
|
inference: false |
|
library_name: gguf |
|
license: gemma |
|
pipeline_tag: text-generation |
|
quantized_by: legraphista |
|
tags: |
|
- quantized |
|
- GGUF |
|
- quantization |
|
- imat |
|
- imatrix |
|
- static |
|
- 16bit |
|
- 8bit |
|
- 6bit |
|
- 5bit |
|
- 4bit |
|
- 3bit |
|
- 2bit |
|
- 1bit |
|
--- |
|
|
|
# shieldgemma-2b-IMat-GGUF |
|
_Llama.cpp imatrix quantization of google/shieldgemma-2b_ |
|
|
|
Original Model: [google/shieldgemma-2b](https://huggingface.co/google/shieldgemma-2b) |
|
Original dtype: `BF16` (`bfloat16`) |
|
Quantized by: llama.cpp [b3525](https://github.com/ggerganov/llama.cpp/releases/tag/b3525) |
|
IMatrix dataset: [here](https://gist.githubusercontent.com/bartowski1182/eb213dccb3571f863da82e99418f81e8/raw/b2869d80f5c16fd7082594248e80144677736635/calibration_datav3.txt) |
|
|
|
- [Files](#files) |
|
- [IMatrix](#imatrix) |
|
- [Common Quants](#common-quants) |
|
- [All Quants](#all-quants) |
|
- [Downloading using huggingface-cli](#downloading-using-huggingface-cli) |
|
- [Inference](#inference) |
|
- [Simple chat template](#simple-chat-template) |
|
- [Llama.cpp](#llama-cpp) |
|
- [FAQ](#faq) |
|
- [Why is the IMatrix not applied everywhere?](#why-is-the-imatrix-not-applied-everywhere) |
|
- [How do I merge a split GGUF?](#how-do-i-merge-a-split-gguf) |
|
|
|
--- |
|
|
|
## Files |
|
|
|
### IMatrix |
|
Status: ✅ Available |
|
Link: [here](https://huggingface.co/legraphista/shieldgemma-2b-IMat-GGUF/blob/main/imatrix.dat) |
|
|
|
### Common Quants |
|
| Filename | Quant type | File Size | Status | Uses IMatrix | Is Split | |
|
| -------- | ---------- | --------- | ------ | ------------ | -------- | |
|
| [shieldgemma-2b.Q8_0.gguf](https://huggingface.co/legraphista/shieldgemma-2b-IMat-GGUF/blob/main/shieldgemma-2b.Q8_0.gguf) | Q8_0 | 2.78GB | ✅ Available | ⚪ Static | 📦 No |
|
| [shieldgemma-2b.Q6_K.gguf](https://huggingface.co/legraphista/shieldgemma-2b-IMat-GGUF/blob/main/shieldgemma-2b.Q6_K.gguf) | Q6_K | 2.15GB | ✅ Available | ⚪ Static | 📦 No |
|
| [shieldgemma-2b.Q4_K.gguf](https://huggingface.co/legraphista/shieldgemma-2b-IMat-GGUF/blob/main/shieldgemma-2b.Q4_K.gguf) | Q4_K | 1.71GB | ✅ Available | 🟢 IMatrix | 📦 No |
|
| [shieldgemma-2b.Q3_K.gguf](https://huggingface.co/legraphista/shieldgemma-2b-IMat-GGUF/blob/main/shieldgemma-2b.Q3_K.gguf) | Q3_K | 1.46GB | ✅ Available | 🟢 IMatrix | 📦 No |
|
| [shieldgemma-2b.Q2_K.gguf](https://huggingface.co/legraphista/shieldgemma-2b-IMat-GGUF/blob/main/shieldgemma-2b.Q2_K.gguf) | Q2_K | 1.23GB | ✅ Available | 🟢 IMatrix | 📦 No |
|
|
|
|
|
### All Quants |
|
| Filename | Quant type | File Size | Status | Uses IMatrix | Is Split | |
|
| -------- | ---------- | --------- | ------ | ------------ | -------- | |
|
| [shieldgemma-2b.BF16.gguf](https://huggingface.co/legraphista/shieldgemma-2b-IMat-GGUF/blob/main/shieldgemma-2b.BF16.gguf) | BF16 | 5.24GB | ✅ Available | ⚪ Static | 📦 No |
|
| [shieldgemma-2b.FP16.gguf](https://huggingface.co/legraphista/shieldgemma-2b-IMat-GGUF/blob/main/shieldgemma-2b.FP16.gguf) | F16 | 5.24GB | ✅ Available | ⚪ Static | 📦 No |
|
| [shieldgemma-2b.Q8_0.gguf](https://huggingface.co/legraphista/shieldgemma-2b-IMat-GGUF/blob/main/shieldgemma-2b.Q8_0.gguf) | Q8_0 | 2.78GB | ✅ Available | ⚪ Static | 📦 No |
|
| [shieldgemma-2b.Q6_K.gguf](https://huggingface.co/legraphista/shieldgemma-2b-IMat-GGUF/blob/main/shieldgemma-2b.Q6_K.gguf) | Q6_K | 2.15GB | ✅ Available | ⚪ Static | 📦 No |
|
| [shieldgemma-2b.Q5_K.gguf](https://huggingface.co/legraphista/shieldgemma-2b-IMat-GGUF/blob/main/shieldgemma-2b.Q5_K.gguf) | Q5_K | 1.92GB | ✅ Available | ⚪ Static | 📦 No |
|
| [shieldgemma-2b.Q5_K_S.gguf](https://huggingface.co/legraphista/shieldgemma-2b-IMat-GGUF/blob/main/shieldgemma-2b.Q5_K_S.gguf) | Q5_K_S | 1.88GB | ✅ Available | ⚪ Static | 📦 No |
|
| [shieldgemma-2b.Q4_K.gguf](https://huggingface.co/legraphista/shieldgemma-2b-IMat-GGUF/blob/main/shieldgemma-2b.Q4_K.gguf) | Q4_K | 1.71GB | ✅ Available | 🟢 IMatrix | 📦 No |
|
| shieldgemma-2b.Q4_K_S | Q4_K_S | - | ⏳ Processing | 🟢 IMatrix | - |
|
| shieldgemma-2b.IQ4_NL | IQ4_NL | - | ⏳ Processing | 🟢 IMatrix | - |
|
| shieldgemma-2b.IQ4_XS | IQ4_XS | - | ⏳ Processing | 🟢 IMatrix | - |
|
| [shieldgemma-2b.Q3_K.gguf](https://huggingface.co/legraphista/shieldgemma-2b-IMat-GGUF/blob/main/shieldgemma-2b.Q3_K.gguf) | Q3_K | 1.46GB | ✅ Available | 🟢 IMatrix | 📦 No |
|
| shieldgemma-2b.Q3_K_L | Q3_K_L | - | ⏳ Processing | 🟢 IMatrix | - |
|
| shieldgemma-2b.Q3_K_S | Q3_K_S | - | ⏳ Processing | 🟢 IMatrix | - |
|
| shieldgemma-2b.IQ3_M | IQ3_M | - | ⏳ Processing | 🟢 IMatrix | - |
|
| shieldgemma-2b.IQ3_S | IQ3_S | - | ⏳ Processing | 🟢 IMatrix | - |
|
| shieldgemma-2b.IQ3_XS | IQ3_XS | - | ⏳ Processing | 🟢 IMatrix | - |
|
| shieldgemma-2b.IQ3_XXS | IQ3_XXS | - | ⏳ Processing | 🟢 IMatrix | - |
|
| [shieldgemma-2b.Q2_K.gguf](https://huggingface.co/legraphista/shieldgemma-2b-IMat-GGUF/blob/main/shieldgemma-2b.Q2_K.gguf) | Q2_K | 1.23GB | ✅ Available | 🟢 IMatrix | 📦 No |
|
| shieldgemma-2b.Q2_K_S | Q2_K_S | - | ⏳ Processing | 🟢 IMatrix | - |
|
| shieldgemma-2b.IQ2_M | IQ2_M | - | ⏳ Processing | 🟢 IMatrix | - |
|
| shieldgemma-2b.IQ2_S | IQ2_S | - | ⏳ Processing | 🟢 IMatrix | - |
|
| shieldgemma-2b.IQ2_XS | IQ2_XS | - | ⏳ Processing | 🟢 IMatrix | - |
|
| shieldgemma-2b.IQ2_XXS | IQ2_XXS | - | ⏳ Processing | 🟢 IMatrix | - |
|
| shieldgemma-2b.IQ1_M | IQ1_M | - | ⏳ Processing | 🟢 IMatrix | - |
|
| shieldgemma-2b.IQ1_S | IQ1_S | - | ⏳ Processing | 🟢 IMatrix | - |
|
|
|
|
|
## Downloading using huggingface-cli |
|
If you do not have hugginface-cli installed: |
|
``` |
|
pip install -U "huggingface_hub[cli]" |
|
``` |
|
Download the specific file you want: |
|
``` |
|
huggingface-cli download legraphista/shieldgemma-2b-IMat-GGUF --include "shieldgemma-2b.Q8_0.gguf" --local-dir ./ |
|
``` |
|
If the model file is big, it has been split into multiple files. In order to download them all to a local folder, run: |
|
``` |
|
huggingface-cli download legraphista/shieldgemma-2b-IMat-GGUF --include "shieldgemma-2b.Q8_0/*" --local-dir ./ |
|
# see FAQ for merging GGUF's |
|
``` |
|
|
|
--- |
|
|
|
## Inference |
|
|
|
### Simple chat template |
|
``` |
|
<bos>You are a policy expert trying to help determine whether a user prompt is in violation of the defined safety policies. |
|
|
|
<start_of_turn> |
|
Human Question: {next_user_prompt} |
|
<end_of_turn> |
|
|
|
Our safety principle is defined in the below: |
|
|
|
* {guideline} |
|
|
|
=== |
|
|
|
Does the human question violate the above principle? Your answer must start with 'Yes' or 'No'. And then walk through step by step to be sure we answer correctly. |
|
|
|
|
|
``` |
|
|
|
### Llama.cpp |
|
``` |
|
llama.cpp/main -m shieldgemma-2b.Q8_0.gguf --color -i -p "prompt here (according to the chat template)" |
|
``` |
|
|
|
--- |
|
|
|
## FAQ |
|
|
|
### Why is the IMatrix not applied everywhere? |
|
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). |
|
|
|
### How do I merge a split GGUF? |
|
1. Make sure you have `gguf-split` available |
|
- To get hold of `gguf-split`, navigate to https://github.com/ggerganov/llama.cpp/releases |
|
- Download the appropriate zip for your system from the latest release |
|
- Unzip the archive and you should be able to find `gguf-split` |
|
2. Locate your GGUF chunks folder (ex: `shieldgemma-2b.Q8_0`) |
|
3. Run `gguf-split --merge shieldgemma-2b.Q8_0/shieldgemma-2b.Q8_0-00001-of-XXXXX.gguf shieldgemma-2b.Q8_0.gguf` |
|
- Make sure to point `gguf-split` to the first chunk of the split. |
|
|
|
--- |
|
|
|
Got a suggestion? Ping me [@legraphista](https://x.com/legraphista)! |
