Create README.md

README.md

@@ -0,0 +1,119 @@
+---
+license: other
+license_name: tongyi-qianwen-research
+license_link: >-
+  https://huggingface.co/Qwen/Qwen1.5-32B/blob/main/LICENSE
+language:
+- de
+- en
+tags:
+- sft
+- dpo
+---
+
+
+![SauerkrautLM](https://vago-solutions.ai/wp-content/uploads/2024/04/SauerkrautLM-Qwen-32b.png "SauerkrautLM-Qwen-32b")
+## VAGO solutions SauerkrautLM-Qwen-32b
+Introducing **SauerkrautLM-Qwen-32b** – our Sauerkraut version of the powerful [Qwen/Qwen1.5-32B](https://huggingface.co/Qwen/Qwen1.5-32B)!
+**It is an early stage finetuned model and should be used with caution!**
+
+The model **SauerkrautLM-Qwen-32b** is a **joint effort** between **VAGO solutions** and **Hyperspace.ai.** 
+
+- Finetuned with **SFT**
+- Aligned with **DPO**
+
+# Table of Contents
+1. [Overview of all SauerkrautLM-Qwen-32b](#all-SauerkrautLM-Qwen-32b)
+2. [Model Details](#model-details)
+   - [Prompt template](#prompt-template)
+   - [Training procedure](#proceed-of-the-training)
+3. [Evaluation](#evaluation)
+5. [Disclaimer](#disclaimer)
+6. [Contact](#contact)
+7. [Collaborations](#collaborations)
+8. [Acknowledgement](#acknowledgement)
+
+
+## All SauerkrautLM-Qwen-32b
+
+| Model | HF    | EXL2  | GGUF  | AWQ  |
+|-------|-------|-------|-------|-------|
+| SauerkrautLM-Qwen-32b  | [Link](https://huggingface.co/VAGOsolutions/SauerkrautLM-Qwen-32b) | coming soon | coming soon | coming soon |
+
+## Model Details
+**SauerkrautLM-Gemma-7b**
+- **Model Type:** SauerkrautLM-Qwen-32b is a finetuned Model based on [Qwen/Qwen1.5-32B](https://huggingface.co/Qwen/Qwen1.5-32B)
+- **Language(s):** German, English
+- **License:** [tongyi-qianwen-research](https://huggingface.co/Qwen/Qwen1.5-32B/blob/main/LICENSEs)
+- **Contact:** [VAGO solutions](https://vago-solutions.ai), [Hyperspace.ai](https://hyperspace.computer/)
+
+### Training procedure:
+We trained this model for 2 epochs on 160k data samples with SFT.
+Afterwards we applied DPO with 110k data.
+
+**We teached German language skills on this model.** As far as we know, it is the first Qwen 32B model with bilingual skills in German and English. Nevertheless, formulations may occur that are not entirely correct (still work in progress).
+
+
+### Prompt Template:
+
+**English:**
+```
+<|im_start|>system
+You are SauerkrautLM, a helpful AI assistant.<|im_end|>
+<|im_start|>user
+{prompt}<|im_end|>
+<|im_start|>assistant
+
+```
+
+**German:**
+```
+<|im_start|>system
+Du bist SauerkrautLM, ein hilfreicher und freundlicher KI-Assistent.<|im_end|>
+<|im_start|>user
+{prompt}<|im_end|>
+<|im_start|>assistant
+
+```
+### Example output of german language:
+
+```
+Die Karte zeigte eine verborgene Höhle, die in den umliegenden Bergen zu finden war. Mia war von der Idee fasziniert, diese Höhle zu entdecken und ihre Geheimnisse zu lüften. Sie nahm die Karte mit sich und machte sich auf den Weg, um die Höhle zu finden.
+Die Wanderung zu den Bergen war eine Herausforderung, aber Mia war fest entschlossen, ihr Abenteuer zu vollenden. Sie überwand steinige Wege und überquerte klirrende Bäche, die ihre Füße kühlten und ihr die Energie für den Rest des Weges gab.
+Endlich erreichte Mia die Höhle, die von einem dichten Wald umgeben war. Die Höhle war ein Ort der Geheimnisse und des Staunens, der ihr Herz höher schlagen ließ. Sie betrat die Höhle, und die Dunkelheit umhüllte sie wie ein Schleier aus Stille.
+In der Höhle fand Mia eine alte Schatzkiste, die mit einem alten, verwitterten Holz verziert war. Mit zitternden Händen öffnete sie die Schatzkiste und fand darin eine alte, zerfledderte Schriftrolle. Die Schriftrolle war ein geheimnisvolles Artefakt, das ihr die Geschichte der Höhle offenbarte.
+```
+
+## Evaluation
+
+**Open LLM Leaderboard:**
+
+
+| Metric                | Value                     |
+|-----------------------|---------------------------|
+| Avg.                  | **73.11**  |
+| ARC (25-shot)         | 59.22         |
+| HellaSwag (10-shot)   | 82.32  |
+| MMLU (5-shot)         | 74.40|
+| TruthfulQA (0-shot)   | 61.03 |
+| Winogrande (5-shot)   | 82.16  |
+| GSM8K (5-shot)        | 79.53        |
+
+
+
+
+
+
+## Disclaimer
+We must inform users that despite our best efforts in data cleansing, the possibility of uncensored 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.
+ 
+## Contact
+If you are interested in customized LLMs for business applications, please get in contact with us via our websites. We are also grateful for your feedback and suggestions.
+ 
+## Collaborations
+We are also keenly seeking support and investment for our startups, VAGO solutions and Hyperspace 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 at [VAGO solutions](https://vago-solutions.de/#Kontakt), [Hyperspace.computer](https://hyperspace.computer/)
+
+## Acknowledgement
+Many thanks to [Qwen](https://huggingface.co/Qwen) for providing such valuable model to the Open-Source community