Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,153 @@
+---
+base_model: m-a-p/neo_7b_sft_v0.1
+inference: false
+library_name: gguf
+license: apache-2.0
+pipeline_tag: text-generation
+quantized_by: legraphista
+tags:
+- quantized
+- GGUF
+- imatrix
+- quantization
+- imat
+- imatrix
+- static
+- 16bit
+- 8bit
+- 6bit
+- 5bit
+- 4bit
+- 3bit
+- 2bit
+- 1bit
+---
+
+# neo_7b_sft_v0.1-IMat-GGUF
+_Llama.cpp imatrix quantization of m-a-p/neo_7b_sft_v0.1_
+
+Original Model: [m-a-p/neo_7b_sft_v0.1](https://huggingface.co/m-a-p/neo_7b_sft_v0.1)  
+Original dtype: `BF16` (`bfloat16`)  
+Quantized by:  llama.cpp [b3051](https://github.com/ggerganov/llama.cpp/releases/tag/b3051)  
+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)
+    - [Chat template with system prompt](#chat-template-with-system-prompt)
+    - [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: ⏳ Processing  
+Link: [here](https://huggingface.co/legraphista/neo_7b_sft_v0.1-IMat-GGUF/blob/main/imatrix.dat) 
+
+### Common Quants
+| Filename | Quant type | File Size | Status | Uses IMatrix | Is Split |
+| -------- | ---------- | --------- | ------ | ------------ | -------- |
+| neo_7b_sft_v0.1.Q8_0 | Q8_0 | - | ⏳ Processing | ⚪ Static | -
+| neo_7b_sft_v0.1.Q6_K | Q6_K | - | ⏳ Processing | ⚪ Static | -
+| neo_7b_sft_v0.1.Q4_K | Q4_K | - | ⏳ Processing | 🟢 IMatrix | -
+| neo_7b_sft_v0.1.Q3_K | Q3_K | - | ⏳ Processing | 🟢 IMatrix | -
+| neo_7b_sft_v0.1.Q2_K | Q2_K | - | ⏳ Processing | 🟢 IMatrix | -
+
+
+### All Quants
+| Filename | Quant type | File Size | Status | Uses IMatrix | Is Split |
+| -------- | ---------- | --------- | ------ | ------------ | -------- |
+| neo_7b_sft_v0.1.BF16 | BF16 | - | ⏳ Processing | ⚪ Static | -
+| neo_7b_sft_v0.1.FP16 | F16 | - | ⏳ Processing | ⚪ Static | -
+| neo_7b_sft_v0.1.Q8_0 | Q8_0 | - | ⏳ Processing | ⚪ Static | -
+| neo_7b_sft_v0.1.Q6_K | Q6_K | - | ⏳ Processing | ⚪ Static | -
+| neo_7b_sft_v0.1.Q5_K | Q5_K | - | ⏳ Processing | ⚪ Static | -
+| neo_7b_sft_v0.1.Q5_K_S | Q5_K_S | - | ⏳ Processing | ⚪ Static | -
+| neo_7b_sft_v0.1.Q4_K | Q4_K | - | ⏳ Processing | 🟢 IMatrix | -
+| neo_7b_sft_v0.1.Q4_K_S | Q4_K_S | - | ⏳ Processing | 🟢 IMatrix | -
+| neo_7b_sft_v0.1.IQ4_NL | IQ4_NL | - | ⏳ Processing | 🟢 IMatrix | -
+| neo_7b_sft_v0.1.IQ4_XS | IQ4_XS | - | ⏳ Processing | 🟢 IMatrix | -
+| neo_7b_sft_v0.1.Q3_K | Q3_K | - | ⏳ Processing | 🟢 IMatrix | -
+| neo_7b_sft_v0.1.Q3_K_L | Q3_K_L | - | ⏳ Processing | 🟢 IMatrix | -
+| neo_7b_sft_v0.1.Q3_K_S | Q3_K_S | - | ⏳ Processing | 🟢 IMatrix | -
+| neo_7b_sft_v0.1.IQ3_M | IQ3_M | - | ⏳ Processing | 🟢 IMatrix | -
+| neo_7b_sft_v0.1.IQ3_S | IQ3_S | - | ⏳ Processing | 🟢 IMatrix | -
+| neo_7b_sft_v0.1.IQ3_XS | IQ3_XS | - | ⏳ Processing | 🟢 IMatrix | -
+| neo_7b_sft_v0.1.IQ3_XXS | IQ3_XXS | - | ⏳ Processing | 🟢 IMatrix | -
+| neo_7b_sft_v0.1.Q2_K | Q2_K | - | ⏳ Processing | 🟢 IMatrix | -
+| neo_7b_sft_v0.1.Q2_K_S | Q2_K_S | - | ⏳ Processing | 🟢 IMatrix | -
+| neo_7b_sft_v0.1.IQ2_M | IQ2_M | - | ⏳ Processing | 🟢 IMatrix | -
+| neo_7b_sft_v0.1.IQ2_S | IQ2_S | - | ⏳ Processing | 🟢 IMatrix | -
+| neo_7b_sft_v0.1.IQ2_XS | IQ2_XS | - | ⏳ Processing | 🟢 IMatrix | -
+| neo_7b_sft_v0.1.IQ2_XXS | IQ2_XXS | - | ⏳ Processing | 🟢 IMatrix | -
+| neo_7b_sft_v0.1.IQ1_M | IQ1_M | - | ⏳ Processing | 🟢 IMatrix | -
+| neo_7b_sft_v0.1.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/neo_7b_sft_v0.1-IMat-GGUF --include "neo_7b_sft_v0.1.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/neo_7b_sft_v0.1-IMat-GGUF --include "neo_7b_sft_v0.1.Q8_0/*" --local-dir ./
+# see FAQ for merging GGUF's
+```
+
+---
+
+## Inference
+
+### Simple chat template
+```
+<s>[INST] <<SYS>>
+You are a helpful, respectful and honest assistant. Always answer as helpfully as possible, while being safe. Your answers should not include any harmful, unethical, racist, sexist, toxic, dangerous, or illegal content. Please ensure that your responses are socially unbiased and positive in nature.
+
+If a question does not make any sense, or is not factually coherent, explain why instead of answering something not correct. If you don't know the answer to a question, please don't share false information.
+<</SYS>>
+
+{user_prompt} [/INST]{assistant_response}</s><s>[INST] {next_user_prompt} [/INST]
+```
+
+### Chat template with system prompt
+```
+<s>[INST] {user_prompt} [/INST]{assistant_response}</s><s>[INST] {next_user_prompt} [/INST]
+```
+
+### Llama.cpp
+```
+llama.cpp/main -m neo_7b_sft_v0.1.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: `neo_7b_sft_v0.1.Q8_0`)
+3. Run `gguf-split --merge neo_7b_sft_v0.1.Q8_0/neo_7b_sft_v0.1.Q8_0-00001-of-XXXXX.gguf neo_7b_sft_v0.1.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)!