auto-patch README.md

README.md

@@ -1,6 +1,94 @@
+---
+base_model: ICONNAI/ICONN-1
+extra_gated_fields:
+  Country: country
+  Date of agreement: date_picker
+  Full name: text
+  I agree to all terms in the ICONN AI License Agreement, including:
+    options:
+    - I will NOT use this model for commercial purposes without explicit written permission.
+    - I will NOT redistribute, upload, or share this model in any public or private
+      repository.
+    - I will NOT train new models or derivatives from this model.
+    - I will NOT use this model for unethical, harmful, deceptive, exploitative, or
+      surveillance purposes.
+    - I understand this license may be revoked if I breach any terms.
+    type: checkbox
+  I am using this model for:
+    options:
+    - Personal use
+    - Internal business use
+    - Academic research
+    - Educational purposes
+    - label: Other (explain below)
+      value: other
+    type: select
+  Organization (if any): text
+  Purpose explanation (if "Other"): text
+extra_gated_prompt: |
+  By accessing or downloading this model, you agree to the ICONN AI License Agreement.  This includes restrictions on commercial use, redistribution, derivative model training,  and uploading to public or private repositories. You may not use this model to harm, surveil,  deceive, exploit, manipulate, or conduct unethical AI research. All use must comply with  ethical standards and respect human dignity.
+language:
+- en
+library_name: transformers
+license: apache-2.0
+quantized_by: mradermacher
+tags:
+- emotional-ai
+- ICONN
+- chatbot
+- base
+---
+## About
+
 <!-- ### quantize_version: 2 -->
 <!-- ### output_tensor_quantised: 1 -->
 <!-- ### convert_type: hf -->
 <!-- ### vocab_type:  -->
 <!-- ### tags:  -->
 static quants of https://huggingface.co/ICONNAI/ICONN-1
+
+<!-- provided-files -->
+weighted/imatrix quants are available at https://huggingface.co/mradermacher/ICONN-1-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/ICONN-1-GGUF/resolve/main/ICONN-1.Q2_K.gguf) | Q2_K | 30.9 |  |
+| [GGUF](https://huggingface.co/mradermacher/ICONN-1-GGUF/resolve/main/ICONN-1.Q3_K_S.gguf) | Q3_K_S | 36.5 |  |
+| [GGUF](https://huggingface.co/mradermacher/ICONN-1-GGUF/resolve/main/ICONN-1.Q3_K_M.gguf) | Q3_K_M | 40.3 | lower quality |
+| [GGUF](https://huggingface.co/mradermacher/ICONN-1-GGUF/resolve/main/ICONN-1.Q3_K_L.gguf) | Q3_K_L | 43.6 |  |
+| [GGUF](https://huggingface.co/mradermacher/ICONN-1-GGUF/resolve/main/ICONN-1.Q4_K_S.gguf) | Q4_K_S | 47.9 | fast, recommended |
+| [PART 1](https://huggingface.co/mradermacher/ICONN-1-GGUF/resolve/main/ICONN-1.Q4_K_M.gguf.part1of2) [PART 2](https://huggingface.co/mradermacher/ICONN-1-GGUF/resolve/main/ICONN-1.Q4_K_M.gguf.part2of2) | Q4_K_M | 51.0 | fast, recommended |
+| [PART 1](https://huggingface.co/mradermacher/ICONN-1-GGUF/resolve/main/ICONN-1.Q5_K_S.gguf.part1of2) [PART 2](https://huggingface.co/mradermacher/ICONN-1-GGUF/resolve/main/ICONN-1.Q5_K_S.gguf.part2of2) | Q5_K_S | 57.9 |  |
+| [PART 1](https://huggingface.co/mradermacher/ICONN-1-GGUF/resolve/main/ICONN-1.Q5_K_M.gguf.part1of2) [PART 2](https://huggingface.co/mradermacher/ICONN-1-GGUF/resolve/main/ICONN-1.Q5_K_M.gguf.part2of2) | Q5_K_M | 59.7 |  |
+| [PART 1](https://huggingface.co/mradermacher/ICONN-1-GGUF/resolve/main/ICONN-1.Q6_K.gguf.part1of2) [PART 2](https://huggingface.co/mradermacher/ICONN-1-GGUF/resolve/main/ICONN-1.Q6_K.gguf.part2of2) | Q6_K | 69.0 | very good quality |
+| [PART 1](https://huggingface.co/mradermacher/ICONN-1-GGUF/resolve/main/ICONN-1.Q8_0.gguf.part1of2) [PART 2](https://huggingface.co/mradermacher/ICONN-1-GGUF/resolve/main/ICONN-1.Q8_0.gguf.part2of2) | Q8_0 | 89.3 | fast, best quality |
+
+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 -->