TheBloke commited on
Commit
99b1d31
1 Parent(s): a7019f3

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +438 -0
README.md ADDED
@@ -0,0 +1,438 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: VAGOsolutions/SauerkrautLM-Mixtral-8x7B
3
+ datasets:
4
+ - Open-Orca/SlimOrca
5
+ - argilla/distilabel-math-preference-dpo
6
+ inference: false
7
+ language:
8
+ - en
9
+ - de
10
+ - fr
11
+ - it
12
+ - es
13
+ library_name: transformers
14
+ license: apache-2.0
15
+ model_creator: VAGO solutions
16
+ model_name: SauerkrautLM Mixtral 8X7B
17
+ model_type: mixtral
18
+ pipeline_tag: text-generation
19
+ prompt_template: '<|im_start|>system
20
+
21
+ {system_message}<|im_end|>
22
+
23
+ <|im_start|>user
24
+
25
+ {prompt}<|im_end|>
26
+
27
+ <|im_start|>assistant
28
+
29
+ '
30
+ quantized_by: TheBloke
31
+ tags:
32
+ - mistral
33
+ - finetune
34
+ - sft
35
+ - dpo
36
+ - chatml
37
+ - augmentation
38
+ - german
39
+ - mixtral
40
+ ---
41
+ <!-- markdownlint-disable MD041 -->
42
+
43
+ <!-- header start -->
44
+ <!-- 200823 -->
45
+ <div style="width: auto; margin-left: auto; margin-right: auto">
46
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
47
+ </div>
48
+ <div style="display: flex; justify-content: space-between; width: 100%;">
49
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
50
+ <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
51
+ </div>
52
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
53
+ <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://www.patreon.com/TheBlokeAI">Want to contribute? TheBloke's Patreon page</a></p>
54
+ </div>
55
+ </div>
56
+ <div style="text-align:center; margin-top: 0em; margin-bottom: 0em"><p style="margin-top: 0.25em; margin-bottom: 0em;">TheBloke's LLM work is generously supported by a grant from <a href="https://a16z.com">andreessen horowitz (a16z)</a></p></div>
57
+ <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
58
+ <!-- header end -->
59
+
60
+ # SauerkrautLM Mixtral 8X7B - GGUF
61
+ - Model creator: [VAGO solutions](https://huggingface.co/VAGOsolutions)
62
+ - Original model: [SauerkrautLM Mixtral 8X7B](https://huggingface.co/VAGOsolutions/SauerkrautLM-Mixtral-8x7B)
63
+
64
+ <!-- description start -->
65
+ ## Description
66
+
67
+ This repo contains GGUF format model files for [VAGO solutions's SauerkrautLM Mixtral 8X7B](https://huggingface.co/VAGOsolutions/SauerkrautLM-Mixtral-8x7B).
68
+
69
+ <!-- description end -->
70
+ <!-- README_GGUF.md-about-gguf start -->
71
+ ### About GGUF
72
+
73
+ GGUF is a new format introduced by the llama.cpp team on August 21st 2023. It is a replacement for GGML, which is no longer supported by llama.cpp.
74
+
75
+ Here is an incomplete list of clients and libraries that are known to support GGUF:
76
+
77
+ * [llama.cpp](https://github.com/ggerganov/llama.cpp). The source project for GGUF. Offers a CLI and a server option.
78
+ * [text-generation-webui](https://github.com/oobabooga/text-generation-webui), the most widely used web UI, with many features and powerful extensions. Supports GPU acceleration.
79
+ * [KoboldCpp](https://github.com/LostRuins/koboldcpp), a fully featured web UI, with GPU accel across all platforms and GPU architectures. Especially good for story telling.
80
+ * [GPT4All](https://gpt4all.io/index.html), a free and open source local running GUI, supporting Windows, Linux and macOS with full GPU accel.
81
+ * [LM Studio](https://lmstudio.ai/), an easy-to-use and powerful local GUI for Windows and macOS (Silicon), with GPU acceleration. Linux available, in beta as of 27/11/2023.
82
+ * [LoLLMS Web UI](https://github.com/ParisNeo/lollms-webui), a great web UI with many interesting and unique features, including a full model library for easy model selection.
83
+ * [Faraday.dev](https://faraday.dev/), an attractive and easy to use character-based chat GUI for Windows and macOS (both Silicon and Intel), with GPU acceleration.
84
+ * [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
85
+ * [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.
86
+ * [ctransformers](https://github.com/marella/ctransformers), a Python library with GPU accel, LangChain support, and OpenAI-compatible AI server. Note, as of time of writing (November 27th 2023), ctransformers has not been updated in a long time and does not support many recent models.
87
+
88
+ <!-- README_GGUF.md-about-gguf end -->
89
+ <!-- repositories-available start -->
90
+ ## Repositories available
91
+
92
+ * [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/SauerkrautLM-Mixtral-8x7B-AWQ)
93
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/SauerkrautLM-Mixtral-8x7B-GPTQ)
94
+ * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/SauerkrautLM-Mixtral-8x7B-GGUF)
95
+ * [VAGO solutions's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/VAGOsolutions/SauerkrautLM-Mixtral-8x7B)
96
+ <!-- repositories-available end -->
97
+
98
+ <!-- prompt-template start -->
99
+ ## Prompt template: ChatML
100
+
101
+ ```
102
+ <|im_start|>system
103
+ {system_message}<|im_end|>
104
+ <|im_start|>user
105
+ {prompt}<|im_end|>
106
+ <|im_start|>assistant
107
+
108
+ ```
109
+
110
+ <!-- prompt-template end -->
111
+
112
+
113
+ <!-- compatibility_gguf start -->
114
+ ## Compatibility
115
+
116
+ These quantised GGUFv2 files are compatible with llama.cpp from August 27th onwards, as of commit [d0cee0d](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221)
117
+
118
+ They are also compatible with many third party UIs and libraries - please see the list at the top of this README.
119
+
120
+ ## Explanation of quantisation methods
121
+
122
+ <details>
123
+ <summary>Click to see details</summary>
124
+
125
+ The new methods available are:
126
+
127
+ * GGML_TYPE_Q2_K - "type-1" 2-bit quantization in super-blocks containing 16 blocks, each block having 16 weight. Block scales and mins are quantized with 4 bits. This ends up effectively using 2.5625 bits per weight (bpw)
128
+ * GGML_TYPE_Q3_K - "type-0" 3-bit quantization in super-blocks containing 16 blocks, each block having 16 weights. Scales are quantized with 6 bits. This end up using 3.4375 bpw.
129
+ * GGML_TYPE_Q4_K - "type-1" 4-bit quantization in super-blocks containing 8 blocks, each block having 32 weights. Scales and mins are quantized with 6 bits. This ends up using 4.5 bpw.
130
+ * GGML_TYPE_Q5_K - "type-1" 5-bit quantization. Same super-block structure as GGML_TYPE_Q4_K resulting in 5.5 bpw
131
+ * GGML_TYPE_Q6_K - "type-0" 6-bit quantization. Super-blocks with 16 blocks, each block having 16 weights. Scales are quantized with 8 bits. This ends up using 6.5625 bpw
132
+
133
+ Refer to the Provided Files table below to see what files use which methods, and how.
134
+ </details>
135
+ <!-- compatibility_gguf end -->
136
+
137
+ <!-- README_GGUF.md-provided-files start -->
138
+ ## Provided files
139
+
140
+ | Name | Quant method | Bits | Size | Max RAM required | Use case |
141
+ | ---- | ---- | ---- | ---- | ---- | ----- |
142
+ | [sauerkrautlm-mixtral-8x7b.Q2_K.gguf](https://huggingface.co/TheBloke/SauerkrautLM-Mixtral-8x7B-GGUF/blob/main/sauerkrautlm-mixtral-8x7b.Q2_K.gguf) | Q2_K | 2 | 15.64 GB| 18.14 GB | smallest, significant quality loss - not recommended for most purposes |
143
+ | [sauerkrautlm-mixtral-8x7b.Q3_K_M.gguf](https://huggingface.co/TheBloke/SauerkrautLM-Mixtral-8x7B-GGUF/blob/main/sauerkrautlm-mixtral-8x7b.Q3_K_M.gguf) | Q3_K_M | 3 | 20.36 GB| 22.86 GB | very small, high quality loss |
144
+ | [sauerkrautlm-mixtral-8x7b.Q4_0.gguf](https://huggingface.co/TheBloke/SauerkrautLM-Mixtral-8x7B-GGUF/blob/main/sauerkrautlm-mixtral-8x7b.Q4_0.gguf) | Q4_0 | 4 | 26.44 GB| 28.94 GB | legacy; small, very high quality loss - prefer using Q3_K_M |
145
+ | [sauerkrautlm-mixtral-8x7b.Q4_K_M.gguf](https://huggingface.co/TheBloke/SauerkrautLM-Mixtral-8x7B-GGUF/blob/main/sauerkrautlm-mixtral-8x7b.Q4_K_M.gguf) | Q4_K_M | 4 | 26.44 GB| 28.94 GB | medium, balanced quality - recommended |
146
+ | [sauerkrautlm-mixtral-8x7b.Q5_0.gguf](https://huggingface.co/TheBloke/SauerkrautLM-Mixtral-8x7B-GGUF/blob/main/sauerkrautlm-mixtral-8x7b.Q5_0.gguf) | Q5_0 | 5 | 32.23 GB| 34.73 GB | legacy; medium, balanced quality - prefer using Q4_K_M |
147
+ | [sauerkrautlm-mixtral-8x7b.Q5_K_M.gguf](https://huggingface.co/TheBloke/SauerkrautLM-Mixtral-8x7B-GGUF/blob/main/sauerkrautlm-mixtral-8x7b.Q5_K_M.gguf) | Q5_K_M | 5 | 32.23 GB| 34.73 GB | large, very low quality loss - recommended |
148
+ | [sauerkrautlm-mixtral-8x7b.Q6_K.gguf](https://huggingface.co/TheBloke/SauerkrautLM-Mixtral-8x7B-GGUF/blob/main/sauerkrautlm-mixtral-8x7b.Q6_K.gguf) | Q6_K | 6 | 38.38 GB| 40.88 GB | very large, extremely low quality loss |
149
+ | [sauerkrautlm-mixtral-8x7b.Q8_0.gguf](https://huggingface.co/TheBloke/SauerkrautLM-Mixtral-8x7B-GGUF/blob/main/sauerkrautlm-mixtral-8x7b.Q8_0.gguf) | Q8_0 | 8 | 49.62 GB| 52.12 GB | very large, extremely low quality loss - not recommended |
150
+
151
+ **Note**: the above RAM figures assume no GPU offloading. If layers are offloaded to the GPU, this will reduce RAM usage and use VRAM instead.
152
+
153
+
154
+
155
+ <!-- README_GGUF.md-provided-files end -->
156
+
157
+ <!-- README_GGUF.md-how-to-download start -->
158
+ ## How to download GGUF files
159
+
160
+ **Note for manual downloaders:** You almost never want to clone the entire repo! Multiple different quantisation formats are provided, and most users only want to pick and download a single file.
161
+
162
+ The following clients/libraries will automatically download models for you, providing a list of available models to choose from:
163
+
164
+ * LM Studio
165
+ * LoLLMS Web UI
166
+ * Faraday.dev
167
+
168
+ ### In `text-generation-webui`
169
+
170
+ Under Download Model, you can enter the model repo: TheBloke/SauerkrautLM-Mixtral-8x7B-GGUF and below it, a specific filename to download, such as: sauerkrautlm-mixtral-8x7b.Q4_K_M.gguf.
171
+
172
+ Then click Download.
173
+
174
+ ### On the command line, including multiple files at once
175
+
176
+ I recommend using the `huggingface-hub` Python library:
177
+
178
+ ```shell
179
+ pip3 install huggingface-hub
180
+ ```
181
+
182
+ Then you can download any individual model file to the current directory, at high speed, with a command like this:
183
+
184
+ ```shell
185
+ huggingface-cli download TheBloke/SauerkrautLM-Mixtral-8x7B-GGUF sauerkrautlm-mixtral-8x7b.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
186
+ ```
187
+
188
+ <details>
189
+ <summary>More advanced huggingface-cli download usage (click to read)</summary>
190
+
191
+ You can also download multiple files at once with a pattern:
192
+
193
+ ```shell
194
+ huggingface-cli download TheBloke/SauerkrautLM-Mixtral-8x7B-GGUF --local-dir . --local-dir-use-symlinks False --include='*Q4_K*gguf'
195
+ ```
196
+
197
+ For more documentation on downloading with `huggingface-cli`, please see: [HF -> Hub Python Library -> Download files -> Download from the CLI](https://huggingface.co/docs/huggingface_hub/guides/download#download-from-the-cli).
198
+
199
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
200
+
201
+ ```shell
202
+ pip3 install hf_transfer
203
+ ```
204
+
205
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
206
+
207
+ ```shell
208
+ HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/SauerkrautLM-Mixtral-8x7B-GGUF sauerkrautlm-mixtral-8x7b.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
209
+ ```
210
+
211
+ Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
212
+ </details>
213
+ <!-- README_GGUF.md-how-to-download end -->
214
+
215
+ <!-- README_GGUF.md-how-to-run start -->
216
+ ## Example `llama.cpp` command
217
+
218
+ Make sure you are using `llama.cpp` from commit [d0cee0d](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221) or later.
219
+
220
+ ```shell
221
+ ./main -ngl 35 -m sauerkrautlm-mixtral-8x7b.Q4_K_M.gguf --color -c 32768 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "<|im_start|>system\n{system_message}<|im_end|>\n<|im_start|>user\n{prompt}<|im_end|>\n<|im_start|>assistant"
222
+ ```
223
+
224
+ Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
225
+
226
+ Change `-c 32768` to the desired sequence length. For extended sequence models - eg 8K, 16K, 32K - the necessary RoPE scaling parameters are read from the GGUF file and set by llama.cpp automatically. Note that longer sequence lengths require much more resources, so you may need to reduce this value.
227
+
228
+ If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
229
+
230
+ For other parameters and how to use them, please refer to [the llama.cpp documentation](https://github.com/ggerganov/llama.cpp/blob/master/examples/main/README.md)
231
+
232
+ ## How to run in `text-generation-webui`
233
+
234
+ Further instructions can be found in the text-generation-webui documentation, here: [text-generation-webui/docs/04 ‐ Model Tab.md](https://github.com/oobabooga/text-generation-webui/blob/main/docs/04%20%E2%80%90%20Model%20Tab.md#llamacpp).
235
+
236
+ ## How to run from Python code
237
+
238
+ You can use GGUF models from Python using the [llama-cpp-python](https://github.com/abetlen/llama-cpp-python) or [ctransformers](https://github.com/marella/ctransformers) libraries. Note that at the time of writing (Nov 27th 2023), ctransformers has not been updated for some time and is not compatible with some recent models. Therefore I recommend you use llama-cpp-python.
239
+
240
+ ### How to load this model in Python code, using llama-cpp-python
241
+
242
+ For full documentation, please see: [llama-cpp-python docs](https://abetlen.github.io/llama-cpp-python/).
243
+
244
+ #### First install the package
245
+
246
+ Run one of the following commands, according to your system:
247
+
248
+ ```shell
249
+ # Base ctransformers with no GPU acceleration
250
+ pip install llama-cpp-python
251
+ # With NVidia CUDA acceleration
252
+ CMAKE_ARGS="-DLLAMA_CUBLAS=on" pip install llama-cpp-python
253
+ # Or with OpenBLAS acceleration
254
+ CMAKE_ARGS="-DLLAMA_BLAS=ON -DLLAMA_BLAS_VENDOR=OpenBLAS" pip install llama-cpp-python
255
+ # Or with CLBLast acceleration
256
+ CMAKE_ARGS="-DLLAMA_CLBLAST=on" pip install llama-cpp-python
257
+ # Or with AMD ROCm GPU acceleration (Linux only)
258
+ CMAKE_ARGS="-DLLAMA_HIPBLAS=on" pip install llama-cpp-python
259
+ # Or with Metal GPU acceleration for macOS systems only
260
+ CMAKE_ARGS="-DLLAMA_METAL=on" pip install llama-cpp-python
261
+
262
+ # In windows, to set the variables CMAKE_ARGS in PowerShell, follow this format; eg for NVidia CUDA:
263
+ $env:CMAKE_ARGS = "-DLLAMA_OPENBLAS=on"
264
+ pip install llama-cpp-python
265
+ ```
266
+
267
+ #### Simple llama-cpp-python example code
268
+
269
+ ```python
270
+ from llama_cpp import Llama
271
+
272
+ # Set gpu_layers to the number of layers to offload to GPU. Set to 0 if no GPU acceleration is available on your system.
273
+ llm = Llama(
274
+ model_path="./sauerkrautlm-mixtral-8x7b.Q4_K_M.gguf", # Download the model file first
275
+ n_ctx=32768, # The max sequence length to use - note that longer sequence lengths require much more resources
276
+ n_threads=8, # The number of CPU threads to use, tailor to your system and the resulting performance
277
+ n_gpu_layers=35 # The number of layers to offload to GPU, if you have GPU acceleration available
278
+ )
279
+
280
+ # Simple inference example
281
+ output = llm(
282
+ "<|im_start|>system\n{system_message}<|im_end|>\n<|im_start|>user\n{prompt}<|im_end|>\n<|im_start|>assistant", # Prompt
283
+ max_tokens=512, # Generate up to 512 tokens
284
+ stop=["</s>"], # Example stop token - not necessarily correct for this specific model! Please check before using.
285
+ echo=True # Whether to echo the prompt
286
+ )
287
+
288
+ # Chat Completion API
289
+
290
+ llm = Llama(model_path="./sauerkrautlm-mixtral-8x7b.Q4_K_M.gguf", chat_format="llama-2") # Set chat_format according to the model you are using
291
+ llm.create_chat_completion(
292
+ messages = [
293
+ {"role": "system", "content": "You are a story writing assistant."},
294
+ {
295
+ "role": "user",
296
+ "content": "Write a story about llamas."
297
+ }
298
+ ]
299
+ )
300
+ ```
301
+
302
+ ## How to use with LangChain
303
+
304
+ Here are guides on using llama-cpp-python and ctransformers with LangChain:
305
+
306
+ * [LangChain + llama-cpp-python](https://python.langchain.com/docs/integrations/llms/llamacpp)
307
+ * [LangChain + ctransformers](https://python.langchain.com/docs/integrations/providers/ctransformers)
308
+
309
+ <!-- README_GGUF.md-how-to-run end -->
310
+
311
+ <!-- footer start -->
312
+ <!-- 200823 -->
313
+ ## Discord
314
+
315
+ For further support, and discussions on these models and AI in general, join us at:
316
+
317
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
318
+
319
+ ## Thanks, and how to contribute
320
+
321
+ Thanks to the [chirper.ai](https://chirper.ai) team!
322
+
323
+ Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
324
+
325
+ I've had a lot of people ask if they can contribute. I enjoy providing models and helping people, and would love to be able to spend even more time doing it, as well as expanding into new projects like fine tuning/training.
326
+
327
+ If you're able and willing to contribute it will be most gratefully received and will help me to keep providing more models, and to start work on new AI projects.
328
+
329
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
330
+
331
+ * Patreon: https://patreon.com/TheBlokeAI
332
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
333
+
334
+ **Special thanks to**: Aemon Algiz.
335
+
336
+ **Patreon special mentions**: Michael Levine, 阿明, Trailburnt, Nikolai Manek, John Detwiler, Randy H, Will Dee, Sebastain Graf, NimbleBox.ai, Eugene Pentland, Emad Mostaque, Ai Maven, Jim Angel, Jeff Scroggin, Michael Davis, Manuel Alberto Morcote, Stephen Murray, Robert, Justin Joy, Luke @flexchar, Brandon Frisco, Elijah Stavena, S_X, Dan Guido, Undi ., Komninos Chatzipapas, Shadi, theTransient, Lone Striker, Raven Klaugh, jjj, Cap'n Zoog, Michel-Marie MAUDET (LINAGORA), Matthew Berman, David, Fen Risland, Omer Bin Jawed, Luke Pendergrass, Kalila, OG, Erik Bjäreholt, Rooh Singh, Joseph William Delisle, Dan Lewis, TL, John Villwock, AzureBlack, Brad, Pedro Madruga, Caitlyn Gatomon, K, jinyuan sun, Mano Prime, Alex, Jeffrey Morgan, Alicia Loh, Illia Dulskyi, Chadd, transmissions 11, fincy, Rainer Wilmers, ReadyPlayerEmma, knownsqashed, Mandus, biorpg, Deo Leter, Brandon Phillips, SuperWojo, Sean Connelly, Iucharbius, Jack West, Harry Royden McLaughlin, Nicholas, terasurfer, Vitor Caleffi, Duane Dunston, Johann-Peter Hartmann, David Ziegler, Olakabola, Ken Nordquist, Trenton Dambrowitz, Tom X Nguyen, Vadim, Ajan Kanaga, Leonard Tan, Clay Pascal, Alexandros Triantafyllidis, JM33133, Xule, vamX, ya boyyy, subjectnull, Talal Aujan, Alps Aficionado, wassieverse, Ari Malik, James Bentley, Woland, Spencer Kim, Michael Dempsey, Fred von Graf, Elle, zynix, William Richards, Stanislav Ovsiannikov, Edmond Seymore, Jonathan Leane, Martin Kemka, usrbinkat, Enrico Ros
337
+
338
+
339
+ Thank you to all my generous patrons and donaters!
340
+
341
+ And thank you again to a16z for their generous grant.
342
+
343
+ <!-- footer end -->
344
+
345
+ <!-- original-model-card start -->
346
+ # Original model card: VAGO solutions's SauerkrautLM Mixtral 8X7B
347
+
348
+
349
+ ![SauerkrautLM](https://vago-solutions.de/wp-content/uploads/2023/12/Sauerkraut_MoE.png "SauerkrautLM-Mixtral-8x7B")
350
+ ## VAGO solutions SauerkrautLM-Mixtral-8x7B
351
+ Introducing **SauerkrautLM-Mixtral-8x7B** – our Sauerkraut version of the powerful Mixtral-8x7B!
352
+ Finetuned and aligned with **SFT** and **DPO**
353
+
354
+ # Table of Contents
355
+ 1. [Overview of all SauerkrautLM-Mixtral models](#all-sauerkrautlm-mixtral-models)
356
+ 2. [Model Details](#model-details)
357
+ - [Prompt template](#prompt-template)
358
+ - [Training Dataset](#training-dataset)
359
+ 3. [Evaluation](#evaluation)
360
+ 5. [Disclaimer](#disclaimer)
361
+ 6. [Contact](#contact)
362
+ 7. [Collaborations](#collaborations)
363
+ 8. [Acknowledgement](#acknowledgement)
364
+
365
+
366
+ ## All SauerkrautLM-Mixtral Models
367
+
368
+ | Model | HF | GPTQ | GGUF | AWQ |
369
+ |-------|-------|-------|-------|-------|
370
+ | SauerkrautLM-Mixtral-8x7B | [Link](https://huggingface.co/VAGOsolutions/SauerkrautLM-Mixtral-8x7B) | coming soon | coming soon | coming soon |
371
+ | SauerkrautLM-Mixtral-8x7B-Instruct | [Link](https://huggingface.co/VAGOsolutions/SauerkrautLM-Mixtral-8x7B-Instruct) | coming soon | coming soon | coming soon |
372
+
373
+ ## Model Details
374
+ **SauerkrautLM-Mixtral-8x7B**
375
+ - **Model Type:** SauerkrautLM-Mixtral-8x7B is a Mixture of Experts (MoE) Model based on [mistralai/Mixtral-8x7B-v0.1](https://huggingface.co/mistralai/Mixtral-8x7B-v0.1)
376
+ - **Language(s):** English, German, French, Italian, Spanish
377
+ - **License:** APACHE 2.0
378
+ - **Contact:** [Website](https://vago-solutions.de/#Kontakt) [David Golchinfar](mailto:golchinfar@vago-solutions.de)
379
+
380
+ ### Training Dataset:
381
+
382
+ SauerkrautLM-Mixtral-8x7B was trained with mix of German data augmentation and translated data.
383
+ **SFT** with the dataset[OpenOrca/Slim-Orca](https://huggingface.co/datasets/Open-Orca/SlimOrca) and aligned through **DPO** with our **new German SauerkrautLM-DPO dataset** based on parts of the SFT SauerkrautLM dataset
384
+ 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)** and **[argilla/distilabel-math-preference-dpo](https://huggingface.co/datasets/argilla/distilabel-math-preference-dpo).**
385
+ We found, that only a simple translation of training data can lead to unnatural German phrasings.
386
+ Data augmentation techniques were used to grant grammatical, syntactical correctness and a more natural German wording in our training data.
387
+
388
+ ### Data Contamination Test Results
389
+
390
+ Some models on the HuggingFace leaderboard had problems with wrong data getting mixed in.
391
+ We checked our SauerkrautLM-DPO dataset with a special test [1] on a smaller model for this problem.
392
+ The HuggingFace team used the same methods [2, 3].
393
+
394
+ Our results, with `result < 0.1, %:` being well below 0.9, indicate that our dataset is free from contamination.
395
+
396
+ *The data contamination test results of HellaSwag and Winograde will be added once [1] supports them.*
397
+
398
+ | Dataset | ARC | MMLU | TruthfulQA | GSM8K |
399
+ |------------------------------|-------|-------|-------|-------|
400
+ | **SauerkrautLM-DPO**| result < 0.1, %: 0.0 |result < 0.1, %: 0.09 | result < 0.1, %: 0.13 | result < 0.1, %: 0.16 |
401
+
402
+ [1] https://github.com/swj0419/detect-pretrain-code-contamination
403
+
404
+ [2] https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard/discussions/474#657f2245365456e362412a06
405
+
406
+ [3] https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard/discussions/265#657b6debf81f6b44b8966230
407
+
408
+ ### Prompt Template:
409
+ ```
410
+ <|im_start|>system
411
+ Du bist ein großes Sprachmodell, das höflich und kompetent antwortet. Schreibe deine Gedanken Schritt für Schritt auf, um Probleme sinnvoll zu lösen.<|im_end|>
412
+ <|im_start|>user
413
+ Wie geht es dir?<|im_end|>
414
+ <|im_start|>assistant
415
+
416
+ ```
417
+ ## Evaluation
418
+
419
+ ![Harness](https://vago-solutions.de/wp-content/uploads/2023/12/MoEbenchmark.png "SauerkrautLM-Mixtral-8x7B Harness")
420
+ *evaluated with lm-evaluation-harness v0.3.0 - mmlu coming soon
421
+
422
+ *All benchmarks were performed with a sliding window of 4096. New Benchmarks with Sliding Window null coming soon
423
+
424
+ ## Disclaimer
425
+ We must inform users that despite our best efforts in data cleansing, the possibility of uncensored content slipping through cannot be entirely ruled out.
426
+ 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.
427
+ 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.
428
+
429
+ ## Contact
430
+ 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.
431
+
432
+ ## Collaborations
433
+ 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.
434
+
435
+ ## Acknowledgement
436
+ Many thanks to [OpenOrca](https://huggingface.co/Open-Orca), [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!
437
+
438
+ <!-- original-model-card end -->