auto-patch README.md

README.md

@@ -1,6 +1,68 @@
+---
+base_model: tiiuae/Falcon3-10B-Instruct
+language:
+- en
+library_name: transformers
+license: other
+license_link: https://falconllm.tii.ae/falcon-terms-and-conditions.html
+license_name: falcon-llm-license
+quantized_by: mradermacher
+tags:
+- falcon3
+---
+## About
+
 <!-- ### quantize_version: 2 -->
 <!-- ### output_tensor_quantised: 1 -->
 <!-- ### convert_type: hf -->
 <!-- ### vocab_type:  -->
 <!-- ### tags:  -->
 static quants of https://huggingface.co/tiiuae/Falcon3-10B-Instruct
+
+<!-- provided-files -->
+weighted/imatrix quants seem not to be available (by me) at this time. If they do not show up a week or so after the static ones, I have probably not planned for them. Feel free to request them by opening a Community Discussion.
+## 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/Falcon3-10B-Instruct-GGUF/resolve/main/Falcon3-10B-Instruct.Q2_K.gguf) | Q2_K | 4.0 |  |
+| [GGUF](https://huggingface.co/mradermacher/Falcon3-10B-Instruct-GGUF/resolve/main/Falcon3-10B-Instruct.Q3_K_S.gguf) | Q3_K_S | 4.7 |  |
+| [GGUF](https://huggingface.co/mradermacher/Falcon3-10B-Instruct-GGUF/resolve/main/Falcon3-10B-Instruct.Q3_K_M.gguf) | Q3_K_M | 5.2 | lower quality |
+| [GGUF](https://huggingface.co/mradermacher/Falcon3-10B-Instruct-GGUF/resolve/main/Falcon3-10B-Instruct.Q3_K_L.gguf) | Q3_K_L | 5.6 |  |
+| [GGUF](https://huggingface.co/mradermacher/Falcon3-10B-Instruct-GGUF/resolve/main/Falcon3-10B-Instruct.IQ4_XS.gguf) | IQ4_XS | 5.8 |  |
+| [GGUF](https://huggingface.co/mradermacher/Falcon3-10B-Instruct-GGUF/resolve/main/Falcon3-10B-Instruct.Q4_K_S.gguf) | Q4_K_S | 6.1 | fast, recommended |
+| [GGUF](https://huggingface.co/mradermacher/Falcon3-10B-Instruct-GGUF/resolve/main/Falcon3-10B-Instruct.Q4_K_M.gguf) | Q4_K_M | 6.4 | fast, recommended |
+| [GGUF](https://huggingface.co/mradermacher/Falcon3-10B-Instruct-GGUF/resolve/main/Falcon3-10B-Instruct.Q5_K_S.gguf) | Q5_K_S | 7.2 |  |
+| [GGUF](https://huggingface.co/mradermacher/Falcon3-10B-Instruct-GGUF/resolve/main/Falcon3-10B-Instruct.Q5_K_M.gguf) | Q5_K_M | 7.4 |  |
+| [GGUF](https://huggingface.co/mradermacher/Falcon3-10B-Instruct-GGUF/resolve/main/Falcon3-10B-Instruct.Q6_K.gguf) | Q6_K | 8.6 | very good quality |
+| [GGUF](https://huggingface.co/mradermacher/Falcon3-10B-Instruct-GGUF/resolve/main/Falcon3-10B-Instruct.Q8_0.gguf) | Q8_0 | 11.1 | fast, best quality |
+| [GGUF](https://huggingface.co/mradermacher/Falcon3-10B-Instruct-GGUF/resolve/main/Falcon3-10B-Instruct.f16.gguf) | f16 | 20.7 | 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.
+
+<!-- end -->