"Update README.md"

README.md

@@ -1,56 +1,46 @@
 ---
-inference: false
-license: apache-2.0
-model_creator: tiiuae
-model_link: https://huggingface.co/tiiuae/falcon-7b
-model_name: Falcon 7B
-model_type: falcon
-pipeline_tag: text-generation
-quantized_by: maddes8cht
 datasets:
 - tiiuae/falcon-refinedweb
 language:
 - en
-tags:
-- falcon
+inference: false
+license: apache-2.0
 ---
 [![banner](https://maddes8cht.github.io/assets/buttons/Huggingface-banner.jpg)]()
-## I am still building the structure of these descriptions.
-These will carry increasingly more content to help find the best models for a purpose.
-Tiiuae-Falcon 7B is the original foundational Falcon model from Tiiuae, converted to gguf format.
 
----
-# Falcon 7B - gguf
+## I am still building the structure of these descriptions.
 
-<details>
-<summary> Table of contents
+These will contain increasingly more content to help find the best models for a purpose.
 
-</summary>
+# falcon-7b - GGUF
+- Model creator: [tiiuae](https://huggingface.co/tiiuae)
+- Original model: [falcon-7b](https://huggingface.co/tiiuae/falcon-7b)
+These are gguf quantized models of the riginal Falcon 7B Model by tiiuae.
+Falcon is a foundational large language model coming in two different sizes: 7b and 40b.
+# About GGUF format
 
-# Table of contents
+`gguf` is the current file format used by the [`ggml`](https://github.com/ggerganov/ggml) library.
+A growing list of Software is using it and can therefore use this model.
+The core project making use of the ggml library is the [llama.cpp](https://github.com/ggerganov/llama.cpp) project by Georgi Gerganov
 
-- [Summary](#summary)
-- [Original Model Card](#original-model-card-by-tiiuae)
+# Quantization variants
 
-</details>
+There is a bunch of quantized files available. How to choose the best for you:
 
----
-
-# Summary
-- Model creator: [tiiuae](https://huggingface.co/tiiuae)
-- Original model: [Falcon 7b](https://huggingface.co/tiiuae/falcon-7b)
+# legacy quants
 
-These are gguf quantized models of the riginal Falcon 7B Model by tiiuae. falcon is a foundational large language model coming in two different sizes: 7b and 40b.
+Q4_0, Q4_1, Q5_0, Q5_1 and Q8 are `legacy` quantization types.
+Nevertheless, they are fully supported, as there are several circumstances that cause certain model not to be compatible with the modern K-quants.
+Falcon 7B models cannot be quantized to K-quants.
 
-[↑](#table-of-contents)
+# K-quants
 
-<details>
-<summary> Original Model Card by tiiuae
-</summary>
+K-quants are based on the idea that the quantization of certain parts affects the quality in different ways. If you quantize certain parts more and others less, you get a more powerful model with the same file size, or a smaller file size and lower memory load with comparable performance.
+So, if possible, use K-quants.
+With a Q6_K you should find it really hard to find a quality difference to the original model - ask your model two times the same question and you may encounter bigger quality differences.
 
-# Original Model Card by tiiuae
-[***Link to original model card***](https://huggingface.co/tiiuae/falcon-7b)
 
+# Original Model Card:
 # 🚀 Falcon-7B
 
 **Falcon-7B is a 7B parameters causal decoder-only model built by [TII](https://www.tii.ae) and trained on 1,500B tokens of [RefinedWeb](https://huggingface.co/datasets/tiiuae/falcon-refinedweb) enhanced with curated corpora. It is made available under the Apache 2.0 license.**
@@ -113,7 +103,7 @@ You will need **at least 16GB of memory** to swiftly run inference with Falcon-7
 
 - **Developed by:** [https://www.tii.ae](https://www.tii.ae);
 - **Model type:** Causal decoder-only;
-- **Language(s) (NLP):** English and French;
+- **Language(s) (NLP):** English, German, Spanish, French (and limited capabilities in Italian, Portuguese, Polish, Dutch, Romanian, Czech, Swedish);
 - **License:** Apache 2.0.
 
 ### Model Source
@@ -278,6 +268,11 @@ Falcon-7B is made available under the Apache 2.0 license.
 
 ## Contact
 [email protected]
-</details>
 
-[↑](#table-of-contents)
+      <center>
+<a href="https://maddes8cht.github.com"><img src="/assets/buttons/maddes8cht-github-io.jpg" alt="GitHub" /></a>
+<a href="https://stackexchange.com/users/26485911"><img src="https://stackexchange.com/users/flair/26485911.png" width="208" height="58" alt="profile for maddes8cht on Stack Exchange, a network of free, community-driven Q&amp;A sites" title="profile for maddes8cht on Stack Exchange, a network of free, community-driven Q&amp;A sites"></a>
+<a href="https://github.com/maddes8cht"><img src="/assets/buttons/github-button.jpg" alt="GitHub" /></a>
+<a href="https://huggingface.co/maddes8cht"><img src="/assets/buttons/huggingface-button.jpg" alt="HuggingFace" /></a></p>
+<a href="https://twitter.com/maddes1966"><img src="/assets/buttons/twitter-button.jpg" alt="HuggingFace" /></a></p>
+      </center>