auto-patch README.md

README.md

@@ -1,6 +1,73 @@
+---
+base_model: HelpingAI/HelpingAI2.5-5B
+language:
+- en
+library_name: transformers
+license: other
+license_link: https://huggingface.co/OEvortex/HelpingAI2.5-2B/blob/main/LICENSE.md
+license_name: helpingai
+quantized_by: mradermacher
+tags:
+- HelpingAI
+- Emotionally-Intelligent
+- EQ-focused
+- Conversational
+- SLM
+---
+## About
+
 <!-- ### quantize_version: 2 -->
 <!-- ### output_tensor_quantised: 1 -->
 <!-- ### convert_type: hf -->
 <!-- ### vocab_type:  -->
 <!-- ### tags: nicoboss -->
 static quants of https://huggingface.co/HelpingAI/HelpingAI2.5-5B
+
+<!-- provided-files -->
+weighted/imatrix quants are available at https://huggingface.co/mradermacher/HelpingAI2.5-5B-i1-GGUF
+## Usage
+
+If you are unsure how to use GGUF files, refer to one of [TheBloke's
+READMEs](https://huggingface.co/TheBloke/KafkaLM-70B-German-V0.1-GGUF) for
+more details, including on how to concatenate multi-part files.
+
+## Provided Quants
+
+(sorted by size, not necessarily quality. IQ-quants are often preferable over similar sized non-IQ quants)
+
+| Link | Type | Size/GB | Notes |
+|:-----|:-----|--------:|:------|
+| [GGUF](https://huggingface.co/mradermacher/HelpingAI2.5-5B-GGUF/resolve/main/HelpingAI2.5-5B.Q2_K.gguf) | Q2_K | 2.2 |  |
+| [GGUF](https://huggingface.co/mradermacher/HelpingAI2.5-5B-GGUF/resolve/main/HelpingAI2.5-5B.Q3_K_S.gguf) | Q3_K_S | 2.5 |  |
+| [GGUF](https://huggingface.co/mradermacher/HelpingAI2.5-5B-GGUF/resolve/main/HelpingAI2.5-5B.Q3_K_M.gguf) | Q3_K_M | 2.7 | lower quality |
+| [GGUF](https://huggingface.co/mradermacher/HelpingAI2.5-5B-GGUF/resolve/main/HelpingAI2.5-5B.Q3_K_L.gguf) | Q3_K_L | 2.9 |  |
+| [GGUF](https://huggingface.co/mradermacher/HelpingAI2.5-5B-GGUF/resolve/main/HelpingAI2.5-5B.IQ4_XS.gguf) | IQ4_XS | 3.0 |  |
+| [GGUF](https://huggingface.co/mradermacher/HelpingAI2.5-5B-GGUF/resolve/main/HelpingAI2.5-5B.Q4_0_4_4.gguf) | Q4_0_4_4 | 3.1 | fast on arm, low quality |
+| [GGUF](https://huggingface.co/mradermacher/HelpingAI2.5-5B-GGUF/resolve/main/HelpingAI2.5-5B.Q4_K_S.gguf) | Q4_K_S | 3.1 | fast, recommended |
+| [GGUF](https://huggingface.co/mradermacher/HelpingAI2.5-5B-GGUF/resolve/main/HelpingAI2.5-5B.Q4_K_M.gguf) | Q4_K_M | 3.3 | fast, recommended |
+| [GGUF](https://huggingface.co/mradermacher/HelpingAI2.5-5B-GGUF/resolve/main/HelpingAI2.5-5B.Q5_K_S.gguf) | Q5_K_S | 3.7 |  |
+| [GGUF](https://huggingface.co/mradermacher/HelpingAI2.5-5B-GGUF/resolve/main/HelpingAI2.5-5B.Q5_K_M.gguf) | Q5_K_M | 3.8 |  |
+| [GGUF](https://huggingface.co/mradermacher/HelpingAI2.5-5B-GGUF/resolve/main/HelpingAI2.5-5B.Q6_K.gguf) | Q6_K | 4.3 | very good quality |
+| [GGUF](https://huggingface.co/mradermacher/HelpingAI2.5-5B-GGUF/resolve/main/HelpingAI2.5-5B.Q8_0.gguf) | Q8_0 | 5.6 | fast, best quality |
+| [GGUF](https://huggingface.co/mradermacher/HelpingAI2.5-5B-GGUF/resolve/main/HelpingAI2.5-5B.f16.gguf) | f16 | 10.4 | 16 bpw, overkill |
+
+Here is a handy graph by ikawrakow comparing some lower-quality quant
+types (lower is better):
+
+![image.png](https://www.nethype.de/huggingface_embed/quantpplgraph.png)
+
+And here are Artefact2's thoughts on the matter:
+https://gist.github.com/Artefact2/b5f810600771265fc1e39442288e8ec9
+
+## FAQ / Model Request
+
+See https://huggingface.co/mradermacher/model_requests for some answers to
+questions you might have and/or if you want some other model quantized.
+
+## Thanks
+
+I thank my company, [nethype GmbH](https://www.nethype.de/), for letting
+me use its servers and providing upgrades to my workstation to enable
+this work in my free time. Additional thanks to [@nicoboss](https://huggingface.co/nicoboss) for giving me access to his private supercomputer, enabling me to provide many more imatrix quants, at much higher quality, than I would otherwise be able to.
+
+<!-- end -->