Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,157 @@
+---
+base_model: princeton-nlp/Llama-3-Instruct-8B-SimPO
+inference: false
+library_name: gguf
+pipeline_tag: text-generation
+quantized_by: legraphista
+tags:
+- quantized
+- GGUF
+- imatrix
+- quantization
+- imat
+- imatrix
+- static
+---
+
+# Llama-3-Instruct-8B-SimPO-IMat-GGUF
+_Llama.cpp imatrix quantization of princeton-nlp/Llama-3-Instruct-8B-SimPO_
+
+Original Model: [princeton-nlp/Llama-3-Instruct-8B-SimPO](https://huggingface.co/princeton-nlp/Llama-3-Instruct-8B-SimPO)  
+Original dtype: `BF16` (`bfloat16`)  
+Quantized by: llama.cpp [b3023](https://github.com/ggerganov/llama.cpp/releases/tag/b3023)  
+IMatrix dataset: [here](https://gist.githubusercontent.com/legraphista/d6d93f1a254bcfc58e0af3777eaec41e/raw/d380e7002cea4a51c33fffd47db851942754e7cc/imatrix.calibration.medium.raw)  
+
+- [Llama-3-Instruct-8B-SimPO-IMat-GGUF](#llama-3-instruct-8b-simpo-imat-gguf)
+    - [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/Llama-3-Instruct-8B-SimPO-IMat-GGUF/blob/main/imatrix.dat) 
+
+### Common Quants
+| Filename | Quant type | File Size | Status | Uses IMatrix | Is Split |
+| -------- | ---------- | --------- | ------ | ------------ | -------- |
+| Llama-3-Instruct-8B-SimPO.Q8_0 | Q8_0 | - | ⏳ Processing | ⚪ Static | -
+| Llama-3-Instruct-8B-SimPO.Q6_K | Q6_K | - | ⏳ Processing | ⚪ Static | -
+| Llama-3-Instruct-8B-SimPO.Q4_K | Q4_K | - | ⏳ Processing | 🟢 IMatrix | -
+| Llama-3-Instruct-8B-SimPO.Q3_K | Q3_K | - | ⏳ Processing | 🟢 IMatrix | -
+| Llama-3-Instruct-8B-SimPO.Q2_K | Q2_K | - | ⏳ Processing | 🟢 IMatrix | -
+
+
+### All Quants
+| Filename | Quant type | File Size | Status | Uses IMatrix | Is Split |
+| -------- | ---------- | --------- | ------ | ------------ | -------- |
+| Llama-3-Instruct-8B-SimPO.Q8_0 | Q8_0 | - | ⏳ Processing | ⚪ Static | -
+| Llama-3-Instruct-8B-SimPO.Q6_K | Q6_K | - | ⏳ Processing | ⚪ Static | -
+| Llama-3-Instruct-8B-SimPO.Q4_K | Q4_K | - | ⏳ Processing | 🟢 IMatrix | -
+| Llama-3-Instruct-8B-SimPO.Q3_K | Q3_K | - | ⏳ Processing | 🟢 IMatrix | -
+| Llama-3-Instruct-8B-SimPO.Q2_K | Q2_K | - | ⏳ Processing | 🟢 IMatrix | -
+| Llama-3-Instruct-8B-SimPO.BF16 | BF16 | - | ⏳ Processing | ⚪ Static | -
+| Llama-3-Instruct-8B-SimPO.FP16 | F16 | - | ⏳ Processing | ⚪ Static | -
+| Llama-3-Instruct-8B-SimPO.Q5_K | Q5_K | - | ⏳ Processing | ⚪ Static | -
+| Llama-3-Instruct-8B-SimPO.Q5_K_S | Q5_K_S | - | ⏳ Processing | ⚪ Static | -
+| Llama-3-Instruct-8B-SimPO.Q4_K_S | Q4_K_S | - | ⏳ Processing | 🟢 IMatrix | -
+| Llama-3-Instruct-8B-SimPO.Q3_K_L | Q3_K_L | - | ⏳ Processing | 🟢 IMatrix | -
+| Llama-3-Instruct-8B-SimPO.Q3_K_S | Q3_K_S | - | ⏳ Processing | 🟢 IMatrix | -
+| Llama-3-Instruct-8B-SimPO.Q2_K_S | Q2_K_S | - | ⏳ Processing | 🟢 IMatrix | -
+| Llama-3-Instruct-8B-SimPO.IQ4_NL | IQ4_NL | - | ⏳ Processing | 🟢 IMatrix | -
+| Llama-3-Instruct-8B-SimPO.IQ4_XS | IQ4_XS | - | ⏳ Processing | 🟢 IMatrix | -
+| Llama-3-Instruct-8B-SimPO.IQ3_M | IQ3_M | - | ⏳ Processing | 🟢 IMatrix | -
+| Llama-3-Instruct-8B-SimPO.IQ3_S | IQ3_S | - | ⏳ Processing | 🟢 IMatrix | -
+| Llama-3-Instruct-8B-SimPO.IQ3_XS | IQ3_XS | - | ⏳ Processing | 🟢 IMatrix | -
+| Llama-3-Instruct-8B-SimPO.IQ3_XXS | IQ3_XXS | - | ⏳ Processing | 🟢 IMatrix | -
+| Llama-3-Instruct-8B-SimPO.IQ2_M | IQ2_M | - | ⏳ Processing | 🟢 IMatrix | -
+| Llama-3-Instruct-8B-SimPO.IQ2_S | IQ2_S | - | ⏳ Processing | 🟢 IMatrix | -
+| Llama-3-Instruct-8B-SimPO.IQ2_XS | IQ2_XS | - | ⏳ Processing | 🟢 IMatrix | -
+| Llama-3-Instruct-8B-SimPO.IQ2_XXS | IQ2_XXS | - | ⏳ Processing | 🟢 IMatrix | -
+| Llama-3-Instruct-8B-SimPO.IQ1_M | IQ1_M | - | ⏳ Processing | 🟢 IMatrix | -
+| Llama-3-Instruct-8B-SimPO.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/Llama-3-Instruct-8B-SimPO-IMat-GGUF --include "Llama-3-Instruct-8B-SimPO.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/Llama-3-Instruct-8B-SimPO-IMat-GGUF --include "Llama-3-Instruct-8B-SimPO.Q8_0/*" --local-dir ./
+# see FAQ for merging GGUF's
+```
+
+---
+
+## Inference
+
+### Simple chat template
+```
+<|im_start|>user
+Can you provide ways to eat combinations of bananas and dragonfruits?<|im_end|>
+<|im_start|>assistant
+Sure! Here are some ways to eat bananas and dragonfruits together:
+ 1. Banana and dragonfruit smoothie: Blend bananas and dragonfruits together with some milk and honey.
+ 2. Banana and dragonfruit salad: Mix sliced bananas and dragonfruits together with some lemon juice and honey.<|im_end|>
+<|im_start|>user
+What about solving an 2x + 3 = 7 equation?<|im_end|>
+
+```
+
+### Chat template with system prompt
+```
+<|im_start|>system
+You are a helpful AI.<|im_end|>
+<|im_start|>user
+Can you provide ways to eat combinations of bananas and dragonfruits?<|im_end|>
+<|im_start|>assistant
+Sure! Here are some ways to eat bananas and dragonfruits together:
+ 1. Banana and dragonfruit smoothie: Blend bananas and dragonfruits together with some milk and honey.
+ 2. Banana and dragonfruit salad: Mix sliced bananas and dragonfruits together with some lemon juice and honey.<|im_end|>
+<|im_start|>user
+What about solving an 2x + 3 = 7 equation?<|im_end|>
+
+```
+
+### Llama.cpp
+```
+llama.cpp/main -m Llama-3-Instruct-8B-SimPO.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: `Llama-3-Instruct-8B-SimPO.Q8_0`)
+3. Run `gguf-split --merge Llama-3-Instruct-8B-SimPO.Q8_0/Llama-3-Instruct-8B-SimPO.Q8_0-00001-of-XXXXX.gguf Llama-3-Instruct-8B-SimPO.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)!