Update README.md

README.md

@@ -1,3 +1,126 @@
 ---
 license: apache-2.0
+language:
+- en
+library_name: transformers
+pipeline_tag: text-generation
 ---
+
+![SauerkrautLM](images/SauerkrautLM.png "SauerkrautLM")
+## VAGO solutions SauerkrautLM
+Introducing SauerkrautLM-v1 - Your German Language Powerhouse! 
+
+We are thrilled to unveil our **very first release**, **SauerkrautLM-v1**. This remarkable creation marks a significant milestone as it is specifically **tailored for the German-speaking community**. In a landscape where German language models are scarce, we are proud to offer a solution that fills this void. 
+What sets SauerkrautLM-v1 apart is its versatility. Whether you are an individual looking to harness its capabilities for personal use or a business seeking to integrate it into your projects, our model is designed to accommodate all. It operates under the Apache 2.0 License, providing you with the freedom to explore its potential in both private and commercial applications. 
+Performance is at the heart of SauerkrautLM-v1. We put it to the **test using a customized version of MT-Bench for the German language**, and the results speak volumes. It currently stands as the most robust German Language Model on Hugging Face (based on german mt-bench results), showcasing its exceptional capabilities. Rest assured, this model is here to shine and set new standards. And the best thing is it comes in four different sizes (3B, 7B, 13B, 70B) to address your individual needs. 
+Our model's journey began with meticulous training using an **augmented dataset within the QLoRA approach**. This is just the beginning of our model series, promising even more innovative and powerful solutions in the future. 
+
+Join us on this exciting adventure as we redefine the possibilities of language modeling for the German-speaking world. 
+SauerkrautLM-v1 is here to empower your language-related endeavors like never before. 
+
+## All HerO Models
+
+| Model | HF    | GPTQ  | GGUF  | AWQ  |
+|-------|-------|-------|-------|-------|
+| SauerkrautLM-7b-HerO   | [Link](https://huggingface.co/VAGOsolutions/SauerkrautLM-7b-HerO) | coming soon | coming soon | coming soon |
+| SauerkrautLM-7b-HerO-multilingual   | [Link](https://huggingface.co/VAGOsolutions/SauerkrautLM-7b-HerO-multilingual) | coming soon | coming soon | coming soon |
+
+## Model Details
+**SauerkrautLM-7b-HerO**
+
+**Training Dataset:**
+
+SauerkrautLM-7b-HerO-multilingual was trained with mix of German data augmentation and translated data. 
+We found, that only a simple translation of training data can lead to unnatural German phrasings. 
+Data augmentation techniques were used to grant grammatical, syntactical correctness and a more natural German wording in our training data. 
+
+**Merge Procedure:**
+
+SauerkrautLM-7b-HerO was merged on 1 A100 with mergekit.
+The merged model contains [OpenHermes-2.5-Mistral-7B](https://huggingface.co/teknium/OpenHermes-2.5-Mistral-7B) and [Open-Orca/Mistral-7B-OpenOrca](https://huggingface.co/Open-Orca/Mistral-7B-OpenOrca)
+We used the gradient slurp technique.
+
+
+- **Model Type:** SauerkrautLM-7b-HerO is an auto-regressive language model based on the transformer architecture 
+- **Language(s):** English 
+- **License:** APACHE 2.0
+- **Contact:** [Website](https://vago-solutions.de/#Kontakt) [David Golchinfar](mailto:golchinfar@vago-solutions.de)
+
+**Prompt Template:**
+```
+<|im_start|>system
+You are Sauerkraut-HerO, a great language model that answers politely and competently. Write down your thoughts step by step to solve problems meaningfully.
+<|im_end|>
+<|im_start|>user
+How are you?<|im_end|>
+<|im_start|>assistant
+I am doing well!<|im_end|>
+<|im_start|>user
+Please tell me about how merged models can benefit from existent top-models.<|im_end|>
+<|im_start|>assistant
+```
+## Evaluation
+**MT-Bench**
+
+ ![First Turn](images/eng-1turn.png "First Turn")
+ ![Second Turn](images/eng-2turn.png "Second Turn")
+ ![Average](images/eng-avg.png "Average")
+
+**Language Model evaluation Harness**
+```
+|        Task        |Version| Metric | Value |   |Stderr|
+|--------------------|------:|--------|------:|---|-----:|
+|arc_challenge       |      0|acc     | 0.5785|±  |0.0144|
+|                    |       |acc_norm| 0.5939|±  |0.0144|
+|arc_easy            |      0|acc     | 0.8392|±  |0.0075|
+|                    |       |acc_norm| 0.8207|±  |0.0079|
+|boolq               |      1|acc     | 0.8734|±  |0.0058|
+|copa                |      0|acc     | 0.9000|±  |0.0302|
+|hellaswag           |      0|acc     | 0.6429|±  |0.0048|
+|                    |       |acc_norm| 0.8259|±  |0.0038|
+|lambada_openai_mt_de|      0|ppl     |65.8632|±  |4.5390|
+|                    |       |acc     | 0.3910|±  |0.0068|
+|lambada_standard    |      0|ppl     | 3.6267|±  |0.0831|
+|                    |       |acc     | 0.6831|±  |0.0065|
+|multirc             |      1|acc     | 0.1448|±  |0.0114|
+|openbookqa          |      0|acc     | 0.3500|±  |0.0214|
+|                    |       |acc_norm| 0.4640|±  |0.0223|
+|piqa                |      0|acc     | 0.8183|±  |0.0090|
+|                    |       |acc_norm| 0.8346|±  |0.0087|
+|race                |      1|acc     | 0.4641|±  |0.0154|
+|rte                 |      0|acc     | 0.7148|±  |0.0272|
+|truthfulqa_mc       |      1|mc1     | 0.3672|±  |0.0169|
+|                    |       |mc2     | 0.5347|±  |0.0154|
+|webqs               |      0|acc     | 0.1422|±  |0.0078|
+|wic                 |      0|acc     | 0.6646|±  |0.0187|
+|winogrande          |      0|acc     | 0.7419|±  |0.0123|
+|wsc                 |      0|acc     | 0.6058|±  |0.0482|
+|drop                |      1|em      | 0.0430|±  |0.0021|
+|                    |       |f1      | 0.1860|±  |0.0028|
+|triviaqa            |      3|em      | 0.5687|±  |0.0037|
+|wmt16-de-en         |      0|bleu    |40.2285|±  |0.3789|
+|                    |       |chrf    | 0.6432|±  |0.0027|
+|                    |       |ter     | 0.4709|±  |0.0037|
+|wmt16-en-de         |      0|bleu    |24.9193|±  |0.3536|
+|                    |       |chrf    | 0.5267|±  |0.0033|
+|                    |       |ter     | 0.6506|±  |0.0041|
+|xnli_de             |      0|acc     | 0.4451|±  |0.0070|
+|xnli_en             |      0|acc     | 0.5581|±  |0.0070|
+```  
+
+## Disclaimer
+We must inform users that despite our best efforts in data cleansing, the possibility of some such content slipping through cannot be entirely ruled out.
+However, we cannot guarantee consistently appropriate behavior. Therefore, if you encounter any issues or come across inappropriate content, we kindly request that you inform us through the contact information provided.
+Additionally, it is essential to understand that the licensing of these models does not constitute legal advice. We are not held responsible for the actions of third parties who utilize our models. These models may be employed for commercial purposes, and the Apache 2.0 remains applicable and is included with the model files.
+ 
+## Contact
+If you are interested in customized LLMs for business applications, please get in contact with us via our website or contact us at [Dr. Daryoush Vaziri](mailto:vaziri@vago-solutions.de). We are also grateful for your feedback and suggestions.
+ 
+## Collaborations
+We are also keenly seeking support and investment for our startup, VAGO solutions, where we continuously advance the development of robust language models designed to address a diverse range of purposes and requirements. If the prospect of collaboratively navigating future challenges excites you, we warmly invite you to reach out to us.
+
+## Acknowledgement
+Many thanks to [OpenOrca](https://huggingface.co/Open-Orca) and [teknium](https://huggingface.co/teknium) for providing such valuable models to the Open-Source community.
+
+
+