RichardErkhov commited on
Commit
40e0cfa
1 Parent(s): 0ba5912

uploaded readme

Browse files
Files changed (1) hide show
  1. README.md +137 -0
README.md ADDED
@@ -0,0 +1,137 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ Quantization made by Richard Erkhov.
2
+
3
+ [Github](https://github.com/RichardErkhov)
4
+
5
+ [Discord](https://discord.gg/pvy7H8DZMG)
6
+
7
+ [Request more models](https://github.com/RichardErkhov/quant_request)
8
+
9
+
10
+ SauerkrautLM-Mixtral-8x7B-Instruct - bnb 4bits
11
+ - Model creator: https://huggingface.co/VAGOsolutions/
12
+ - Original model: https://huggingface.co/VAGOsolutions/SauerkrautLM-Mixtral-8x7B-Instruct/
13
+
14
+
15
+
16
+
17
+ Original model description:
18
+ ---
19
+ license: apache-2.0
20
+ language:
21
+ - en
22
+ - de
23
+ - fr
24
+ - it
25
+ - es
26
+ library_name: transformers
27
+ pipeline_tag: text-generation
28
+ tags:
29
+ - mistral
30
+ - finetune
31
+ - dpo
32
+ - Instruct
33
+ - augmentation
34
+ - german
35
+ - mixtral
36
+ - moe
37
+ datasets:
38
+ - argilla/distilabel-math-preference-dpo
39
+ ---
40
+
41
+ ![SauerkrautLM](https://vago-solutions.ai/wp-content/uploads/2024/02/Sauerkraut_Instruct_MoE_Instruct.png "SauerkrautLM-Mixtral-8x7B")
42
+ ## VAGO solutions SauerkrautLM-Mixtral-8x7B-Instruct
43
+ Introducing **SauerkrautLM-Mixtral-8x7B-Instruct** – our Sauerkraut version of the powerful Mixtral-8x7B-Instruct!
44
+ Aligned with **DPO**
45
+
46
+ # Table of Contents
47
+ 1. [Overview of all SauerkrautLM-Mixtral models](#all-sauerkrautlm-mixtral-models)
48
+ 2. [Model Details](#model-details)
49
+ - [Prompt template](#prompt-template)
50
+ - [Training Dataset](#training-dataset)
51
+ - [Data Contamination Test](#data-contamination-test-results)
52
+ 3. [Evaluation](#evaluation)
53
+ 5. [Disclaimer](#disclaimer)
54
+ 6. [Contact](#contact)
55
+ 7. [Collaborations](#collaborations)
56
+ 8. [Acknowledgement](#acknowledgement)
57
+
58
+
59
+ ## All SauerkrautLM-Mixtral Models
60
+
61
+ | Model | HF | GPTQ | GGUF | AWQ |
62
+ |-------|-------|-------|-------|-------|
63
+ | SauerkrautLM-Mixtral-8x7B-Instruct | [Link](https://huggingface.co/VAGOsolutions/SauerkrautLM-Mixtral-8x7B-Instruct) | [Link](https://huggingface.co/TheBloke/SauerkrautLM-Mixtral-8x7B-Instruct-GPTQ) | [Link](https://huggingface.co/TheBloke/SauerkrautLM-Mixtral-8x7B-Instruct-GGUF) | [Link](https://huggingface.co/TheBloke/SauerkrautLM-Mixtral-8x7B-Instruct-AWQ) |
64
+ | SauerkrautLM-Mixtral-8x7B | [Link](https://huggingface.co/VAGOsolutions/SauerkrautLM-Mixtral-8x7B) | [Link](https://huggingface.co/TheBloke/SauerkrautLM-Mixtral-8x7B-GPTQ) | [Link](https://huggingface.co/TheBloke/SauerkrautLM-Mixtral-8x7B-GGUF) | [Link](https://huggingface.co/TheBloke/SauerkrautLM-Mixtral-8x7B-AWQ) |
65
+
66
+ ## Model Details
67
+ **SauerkrautLM-Mixtral-8x7B-Instruct**
68
+ - **Model Type:** SauerkrautLM-Mixtral-8x7B-Instruct-v0.1 is a Mixture of Experts (MoE) Model based on [mistralai/Mixtral-8x7B-Instruct-v0.1](https://huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1)
69
+ - **Language(s):** English, German, French, Italian, Spanish
70
+ - **License:** APACHE 2.0
71
+ - **Contact:** [Website](https://vago-solutions.de/#Kontakt) [David Golchinfar](mailto:golchinfar@vago-solutions.de)
72
+
73
+ ### Training Dataset:
74
+
75
+ SauerkrautLM-Mixtral-8x7B-Instruct was trained with mix of German data augmentation and translated data.
76
+ Aligned through **DPO** with our **new German SauerkrautLM-DPO dataset** based on parts of the SFT SauerkrautLM dataset
77
+ as chosen answers and [Sauerkraut-7b-HerO](https://huggingface.co/VAGOsolutions/SauerkrautLM-7b-HerO) as rejected answers. Added with additional **translated Parts of the [HuggingFaceH4/ultrafeedback_binarized](https://huggingface.co/datasets/HuggingFaceH4/ultrafeedback_binarized)** (Our dataset do not contain any TruthfulQA prompts - check Data Contamination Test Results) and **[argilla/distilabel-math-preference-dpo](https://huggingface.co/datasets/argilla/distilabel-math-preference-dpo).**
78
+ We found, that only a simple translation of training data can lead to unnatural German phrasings.
79
+ Data augmentation techniques were used to grant grammatical, syntactical correctness and a more natural German wording in our training data.
80
+
81
+ ### Data Contamination Test Results
82
+
83
+ Some models on the HuggingFace leaderboard had problems with wrong data getting mixed in.
84
+ We checked our SauerkrautLM-DPO dataset with a special test [1] on a smaller model for this problem.
85
+ The HuggingFace team used the same methods [2, 3].
86
+
87
+ Our results, with `result < 0.1, %:` being well below 0.9, indicate that our dataset is free from contamination.
88
+
89
+ *The data contamination test results of HellaSwag and Winograde will be added once [1] supports them.*
90
+
91
+ | Dataset | ARC | MMLU | TruthfulQA | GSM8K |
92
+ |------------------------------|-------|-------|-------|-------|
93
+ | **SauerkrautLM-DPO**| result < 0.1, %: 0.0 |result < 0.1, %: 0.09 | result < 0.1, %: 0.13 | result < 0.1, %: 0.16 |
94
+
95
+ [1] https://github.com/swj0419/detect-pretrain-code-contamination
96
+
97
+ [2] https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard/discussions/474#657f2245365456e362412a06
98
+
99
+ [3] https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard/discussions/265#657b6debf81f6b44b8966230
100
+
101
+ ### Prompt Template:
102
+ ```
103
+ <s> [INST] Instruction [/INST] Model answer</s> [INST] Follow-up instruction [/INST]
104
+ ```
105
+ ## Evaluation
106
+ ![Harness](https://vago-solutions.de/wp-content/uploads/2023/12/MOE_Instruct.png "SauerkrautLM-Mixtral-8x7B-Instruct Harness")
107
+ *evaluated with lm-evaluation-harness v0.3.0 - mmlu coming soon
108
+
109
+ *All benchmarks were performed with a sliding window of 4096. New Benchmarks with Sliding Window null coming soon
110
+
111
+ **German RAG LLM Evaluation**
112
+ corrected result after FIX: https://github.com/huggingface/lighteval/pull/171
113
+ ```
114
+ | Task |Version|Metric|Value| |Stderr|
115
+ |------------------------------------------------------|------:|------|----:|---|-----:|
116
+ |all | |acc |0.975|± |0.0045|
117
+ |community:german_rag_eval:_average:0 | |acc |0.975|± |0.0045|
118
+ |community:german_rag_eval:choose_context_by_question:0| 0|acc |0.953|± |0.0067|
119
+ |community:german_rag_eval:choose_question_by_context:0| 0|acc |0.998|± |0.0014|
120
+ |community:german_rag_eval:context_question_match:0 | 0|acc |0.975|± |0.0049|
121
+ |community:german_rag_eval:question_answer_match:0 | 0|acc |0.974|± |0.0050|
122
+ ```
123
+
124
+ ## Disclaimer
125
+ We must inform users that despite our best efforts in data cleansing, the possibility of uncensored content slipping through cannot be entirely ruled out.
126
+ 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.
127
+ 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.
128
+  
129
+ ## Contact
130
+ 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.
131
+  
132
+ ## Collaborations
133
+ 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.
134
+
135
+ ## Acknowledgement
136
+ Many thanks to [argilla](https://huggingface.co/datasets/argilla) and [Huggingface](https://huggingface.co) for providing such valuable datasets to the Open-Source community. And of course a big thanks to MistralAI for providing the open source community with their latest technology!
137
+