TheBloke commited on
Commit
5fdfb9e
1 Parent(s): 4d3d445

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +386 -0
README.md ADDED
@@ -0,0 +1,386 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: VAGOsolutions/SauerkrautLM-7b-v1
3
+ inference: false
4
+ language:
5
+ - de
6
+ - en
7
+ library_name: transformers
8
+ license: llama2
9
+ model_creator: VAGO solutions
10
+ model_name: SauerkrautLM 7B v1
11
+ model_type: llama
12
+ pipeline_tag: text-generation
13
+ prompt_template: "Ein Chat zwischen einem Benutzer und einem KI-Assistenten. Der KI-Assistent\
14
+ \ gibt hilfreiche, detaillierte und h\xF6fliche Antworten. \nUser: {prompt} \nAssistant:\n"
15
+ quantized_by: TheBloke
16
+ ---
17
+
18
+ <!-- header start -->
19
+ <!-- 200823 -->
20
+ <div style="width: auto; margin-left: auto; margin-right: auto">
21
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
22
+ </div>
23
+ <div style="display: flex; justify-content: space-between; width: 100%;">
24
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
25
+ <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
26
+ </div>
27
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
28
+ <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>
29
+ </div>
30
+ </div>
31
+ <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>
32
+ <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
33
+ <!-- header end -->
34
+
35
+ # SauerkrautLM 7B v1 - GGUF
36
+ - Model creator: [VAGO solutions](https://huggingface.co/VAGOsolutions)
37
+ - Original model: [SauerkrautLM 7B v1](https://huggingface.co/VAGOsolutions/SauerkrautLM-7b-v1)
38
+
39
+ <!-- description start -->
40
+ ## Description
41
+
42
+ This repo contains GGUF format model files for [VAGO solutions's SauerkrautLM 7B v1](https://huggingface.co/VAGOsolutions/SauerkrautLM-7b-v1).
43
+
44
+ <!-- description end -->
45
+ <!-- README_GGUF.md-about-gguf start -->
46
+ ### About GGUF
47
+
48
+ 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.
49
+
50
+ Here is an incomplate list of clients and libraries that are known to support GGUF:
51
+
52
+ * [llama.cpp](https://github.com/ggerganov/llama.cpp). The source project for GGUF. Offers a CLI and a server option.
53
+ * [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.
54
+ * [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.
55
+ * [LM Studio](https://lmstudio.ai/), an easy-to-use and powerful local GUI for Windows and macOS (Silicon), with GPU acceleration.
56
+ * [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.
57
+ * [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.
58
+ * [ctransformers](https://github.com/marella/ctransformers), a Python library with GPU accel, LangChain support, and OpenAI-compatible AI server.
59
+ * [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
60
+ * [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.
61
+
62
+ <!-- README_GGUF.md-about-gguf end -->
63
+ <!-- repositories-available start -->
64
+ ## Repositories available
65
+
66
+ * [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/SauerkrautLM-7B-v1-AWQ)
67
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/SauerkrautLM-7B-v1-GPTQ)
68
+ * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/SauerkrautLM-7B-v1-GGUF)
69
+ * [VAGO solutions's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/VAGOsolutions/SauerkrautLM-7b-v1)
70
+ <!-- repositories-available end -->
71
+
72
+ <!-- prompt-template start -->
73
+ ## Prompt template: Sauerkraut
74
+
75
+ ```
76
+ Ein Chat zwischen einem Benutzer und einem KI-Assistenten. Der KI-Assistent gibt hilfreiche, detaillierte und höfliche Antworten.
77
+ User: {prompt}
78
+ Assistant:
79
+
80
+ ```
81
+
82
+ <!-- prompt-template end -->
83
+
84
+
85
+ <!-- compatibility_gguf start -->
86
+ ## Compatibility
87
+
88
+ 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)
89
+
90
+ They are also compatible with many third party UIs and libraries - please see the list at the top of this README.
91
+
92
+ ## Explanation of quantisation methods
93
+ <details>
94
+ <summary>Click to see details</summary>
95
+
96
+ The new methods available are:
97
+ * 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)
98
+ * 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.
99
+ * 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.
100
+ * GGML_TYPE_Q5_K - "type-1" 5-bit quantization. Same super-block structure as GGML_TYPE_Q4_K resulting in 5.5 bpw
101
+ * 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
102
+
103
+ Refer to the Provided Files table below to see what files use which methods, and how.
104
+ </details>
105
+ <!-- compatibility_gguf end -->
106
+
107
+ <!-- README_GGUF.md-provided-files start -->
108
+ ## Provided files
109
+
110
+ | Name | Quant method | Bits | Size | Max RAM required | Use case |
111
+ | ---- | ---- | ---- | ---- | ---- | ----- |
112
+ | [sauerkrautlm-7b-v1.Q2_K.gguf](https://huggingface.co/TheBloke/SauerkrautLM-7B-v1-GGUF/blob/main/sauerkrautlm-7b-v1.Q2_K.gguf) | Q2_K | 2 | 2.83 GB| 5.33 GB | smallest, significant quality loss - not recommended for most purposes |
113
+ | [sauerkrautlm-7b-v1.Q3_K_S.gguf](https://huggingface.co/TheBloke/SauerkrautLM-7B-v1-GGUF/blob/main/sauerkrautlm-7b-v1.Q3_K_S.gguf) | Q3_K_S | 3 | 2.95 GB| 5.45 GB | very small, high quality loss |
114
+ | [sauerkrautlm-7b-v1.Q3_K_M.gguf](https://huggingface.co/TheBloke/SauerkrautLM-7B-v1-GGUF/blob/main/sauerkrautlm-7b-v1.Q3_K_M.gguf) | Q3_K_M | 3 | 3.30 GB| 5.80 GB | very small, high quality loss |
115
+ | [sauerkrautlm-7b-v1.Q3_K_L.gguf](https://huggingface.co/TheBloke/SauerkrautLM-7B-v1-GGUF/blob/main/sauerkrautlm-7b-v1.Q3_K_L.gguf) | Q3_K_L | 3 | 3.60 GB| 6.10 GB | small, substantial quality loss |
116
+ | [sauerkrautlm-7b-v1.Q4_0.gguf](https://huggingface.co/TheBloke/SauerkrautLM-7B-v1-GGUF/blob/main/sauerkrautlm-7b-v1.Q4_0.gguf) | Q4_0 | 4 | 3.83 GB| 6.33 GB | legacy; small, very high quality loss - prefer using Q3_K_M |
117
+ | [sauerkrautlm-7b-v1.Q4_K_S.gguf](https://huggingface.co/TheBloke/SauerkrautLM-7B-v1-GGUF/blob/main/sauerkrautlm-7b-v1.Q4_K_S.gguf) | Q4_K_S | 4 | 3.86 GB| 6.36 GB | small, greater quality loss |
118
+ | [sauerkrautlm-7b-v1.Q4_K_M.gguf](https://huggingface.co/TheBloke/SauerkrautLM-7B-v1-GGUF/blob/main/sauerkrautlm-7b-v1.Q4_K_M.gguf) | Q4_K_M | 4 | 4.08 GB| 6.58 GB | medium, balanced quality - recommended |
119
+ | [sauerkrautlm-7b-v1.Q5_0.gguf](https://huggingface.co/TheBloke/SauerkrautLM-7B-v1-GGUF/blob/main/sauerkrautlm-7b-v1.Q5_0.gguf) | Q5_0 | 5 | 4.65 GB| 7.15 GB | legacy; medium, balanced quality - prefer using Q4_K_M |
120
+ | [sauerkrautlm-7b-v1.Q5_K_S.gguf](https://huggingface.co/TheBloke/SauerkrautLM-7B-v1-GGUF/blob/main/sauerkrautlm-7b-v1.Q5_K_S.gguf) | Q5_K_S | 5 | 4.65 GB| 7.15 GB | large, low quality loss - recommended |
121
+ | [sauerkrautlm-7b-v1.Q5_K_M.gguf](https://huggingface.co/TheBloke/SauerkrautLM-7B-v1-GGUF/blob/main/sauerkrautlm-7b-v1.Q5_K_M.gguf) | Q5_K_M | 5 | 4.78 GB| 7.28 GB | large, very low quality loss - recommended |
122
+ | [sauerkrautlm-7b-v1.Q6_K.gguf](https://huggingface.co/TheBloke/SauerkrautLM-7B-v1-GGUF/blob/main/sauerkrautlm-7b-v1.Q6_K.gguf) | Q6_K | 6 | 5.53 GB| 8.03 GB | very large, extremely low quality loss |
123
+ | [sauerkrautlm-7b-v1.Q8_0.gguf](https://huggingface.co/TheBloke/SauerkrautLM-7B-v1-GGUF/blob/main/sauerkrautlm-7b-v1.Q8_0.gguf) | Q8_0 | 8 | 7.16 GB| 9.66 GB | very large, extremely low quality loss - not recommended |
124
+
125
+ **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.
126
+
127
+
128
+
129
+ <!-- README_GGUF.md-provided-files end -->
130
+
131
+ <!-- README_GGUF.md-how-to-download start -->
132
+ ## How to download GGUF files
133
+
134
+ **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.
135
+
136
+ The following clients/libraries will automatically download models for you, providing a list of available models to choose from:
137
+ - LM Studio
138
+ - LoLLMS Web UI
139
+ - Faraday.dev
140
+
141
+ ### In `text-generation-webui`
142
+
143
+ Under Download Model, you can enter the model repo: TheBloke/SauerkrautLM-7B-v1-GGUF and below it, a specific filename to download, such as: sauerkrautlm-7b-v1.Q4_K_M.gguf.
144
+
145
+ Then click Download.
146
+
147
+ ### On the command line, including multiple files at once
148
+
149
+ I recommend using the `huggingface-hub` Python library:
150
+
151
+ ```shell
152
+ pip3 install huggingface-hub
153
+ ```
154
+
155
+ Then you can download any individual model file to the current directory, at high speed, with a command like this:
156
+
157
+ ```shell
158
+ huggingface-cli download TheBloke/SauerkrautLM-7B-v1-GGUF sauerkrautlm-7b-v1.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
159
+ ```
160
+
161
+ <details>
162
+ <summary>More advanced huggingface-cli download usage</summary>
163
+
164
+ You can also download multiple files at once with a pattern:
165
+
166
+ ```shell
167
+ huggingface-cli download TheBloke/SauerkrautLM-7B-v1-GGUF --local-dir . --local-dir-use-symlinks False --include='*Q4_K*gguf'
168
+ ```
169
+
170
+ 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).
171
+
172
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
173
+
174
+ ```shell
175
+ pip3 install hf_transfer
176
+ ```
177
+
178
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
179
+
180
+ ```shell
181
+ HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/SauerkrautLM-7B-v1-GGUF sauerkrautlm-7b-v1.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
182
+ ```
183
+
184
+ Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
185
+ </details>
186
+ <!-- README_GGUF.md-how-to-download end -->
187
+
188
+ <!-- README_GGUF.md-how-to-run start -->
189
+ ## Example `llama.cpp` command
190
+
191
+ Make sure you are using `llama.cpp` from commit [d0cee0d](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221) or later.
192
+
193
+ ```shell
194
+ ./main -ngl 32 -m sauerkrautlm-7b-v1.Q4_K_M.gguf --color -c 4096 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "Ein Chat zwischen einem Benutzer und einem KI-Assistenten. Der KI-Assistent gibt hilfreiche, detaillierte und höfliche Antworten. \nUser: {prompt} \nAssistant:"
195
+ ```
196
+
197
+ Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
198
+
199
+ Change `-c 4096` 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.
200
+
201
+ If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
202
+
203
+ 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)
204
+
205
+ ## How to run in `text-generation-webui`
206
+
207
+ Further instructions here: [text-generation-webui/docs/llama.cpp.md](https://github.com/oobabooga/text-generation-webui/blob/main/docs/llama.cpp.md).
208
+
209
+ ## How to run from Python code
210
+
211
+ 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.
212
+
213
+ ### How to load this model in Python code, using ctransformers
214
+
215
+ #### First install the package
216
+
217
+ Run one of the following commands, according to your system:
218
+
219
+ ```shell
220
+ # Base ctransformers with no GPU acceleration
221
+ pip install ctransformers
222
+ # Or with CUDA GPU acceleration
223
+ pip install ctransformers[cuda]
224
+ # Or with AMD ROCm GPU acceleration (Linux only)
225
+ CT_HIPBLAS=1 pip install ctransformers --no-binary ctransformers
226
+ # Or with Metal GPU acceleration for macOS systems only
227
+ CT_METAL=1 pip install ctransformers --no-binary ctransformers
228
+ ```
229
+
230
+ #### Simple ctransformers example code
231
+
232
+ ```python
233
+ from ctransformers import AutoModelForCausalLM
234
+
235
+ # Set gpu_layers to the number of layers to offload to GPU. Set to 0 if no GPU acceleration is available on your system.
236
+ llm = AutoModelForCausalLM.from_pretrained("TheBloke/SauerkrautLM-7B-v1-GGUF", model_file="sauerkrautlm-7b-v1.Q4_K_M.gguf", model_type="llama", gpu_layers=50)
237
+
238
+ print(llm("AI is going to"))
239
+ ```
240
+
241
+ ## How to use with LangChain
242
+
243
+ Here are guides on using llama-cpp-python and ctransformers with LangChain:
244
+
245
+ * [LangChain + llama-cpp-python](https://python.langchain.com/docs/integrations/llms/llamacpp)
246
+ * [LangChain + ctransformers](https://python.langchain.com/docs/integrations/providers/ctransformers)
247
+
248
+ <!-- README_GGUF.md-how-to-run end -->
249
+
250
+ <!-- footer start -->
251
+ <!-- 200823 -->
252
+ ## Discord
253
+
254
+ For further support, and discussions on these models and AI in general, join us at:
255
+
256
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
257
+
258
+ ## Thanks, and how to contribute
259
+
260
+ Thanks to the [chirper.ai](https://chirper.ai) team!
261
+
262
+ Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
263
+
264
+ 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.
265
+
266
+ 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.
267
+
268
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
269
+
270
+ * Patreon: https://patreon.com/TheBlokeAI
271
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
272
+
273
+ **Special thanks to**: Aemon Algiz.
274
+
275
+ **Patreon special mentions**: Pierre Kircher, Stanislav Ovsiannikov, Michael Levine, Eugene Pentland, Andrey, 준교 김, Randy H, Fred von Graf, Artur Olbinski, Caitlyn Gatomon, terasurfer, Jeff Scroggin, James Bentley, Vadim, Gabriel Puliatti, Harry Royden McLaughlin, Sean Connelly, Dan Guido, Edmond Seymore, Alicia Loh, subjectnull, AzureBlack, Manuel Alberto Morcote, Thomas Belote, Lone Striker, Chris Smitley, Vitor Caleffi, Johann-Peter Hartmann, Clay Pascal, biorpg, Brandon Frisco, sidney chen, transmissions 11, Pedro Madruga, jinyuan sun, Ajan Kanaga, Emad Mostaque, Trenton Dambrowitz, Jonathan Leane, Iucharbius, usrbinkat, vamX, George Stoitzev, Luke Pendergrass, theTransient, Olakabola, Swaroop Kallakuri, Cap'n Zoog, Brandon Phillips, Michael Dempsey, Nikolai Manek, danny, Matthew Berman, Gabriel Tamborski, alfie_i, Raymond Fosdick, Tom X Nguyen, Raven Klaugh, LangChain4j, Magnesian, Illia Dulskyi, David Ziegler, Mano Prime, Luis Javier Navarrete Lozano, Erik Bjäreholt, 阿明, Nathan Dryer, Alex, Rainer Wilmers, zynix, TL, Joseph William Delisle, John Villwock, Nathan LeClaire, Willem Michiel, Joguhyik, GodLy, OG, Alps Aficionado, Jeffrey Morgan, ReadyPlayerEmma, Tiffany J. Kim, Sebastain Graf, Spencer Kim, Michael Davis, webtim, Talal Aujan, knownsqashed, John Detwiler, Imad Khwaja, Deo Leter, Jerry Meng, Elijah Stavena, Rooh Singh, Pieter, SuperWojo, Alexandros Triantafyllidis, Stephen Murray, Ai Maven, ya boyyy, Enrico Ros, Ken Nordquist, Deep Realms, Nicholas, Spiking Neurons AB, Elle, Will Dee, Jack West, RoA, Luke @flexchar, Viktor Bowallius, Derek Yates, Subspace Studios, jjj, Toran Billups, Asp the Wyvern, Fen Risland, Ilya, NimbleBox.ai, Chadd, Nitin Borwankar, Emre, Mandus, Leonard Tan, Kalila, K, Trailburnt, S_X, Cory Kujawski
276
+
277
+
278
+ Thank you to all my generous patrons and donaters!
279
+
280
+ And thank you again to a16z for their generous grant.
281
+
282
+ <!-- footer end -->
283
+
284
+ <!-- original-model-card start -->
285
+ # Original model card: VAGO solutions's SauerkrautLM 7B v1
286
+
287
+
288
+ ![SauerkrautLM](images/SauerkrautLM.png "SauerkrautLM")
289
+ ## VAGO solutions SauerkrautLM
290
+ Introducing SauerkrautLM-v1 - Your German Language Powerhouse!
291
+
292
+ 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.
293
+ 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 LLAMA 2 License, providing you with the freedom to explore its potential in both private and commercial applications.
294
+ 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 three different sizes (3B, 7B, 13B) to address your individual needs.
295
+ 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.
296
+
297
+ Join us on this exciting adventure as we redefine the possibilities of language modeling for the German-speaking world.
298
+ SauerkrautLM-v1 is here to empower your language-related endeavors like never before.
299
+
300
+ ## All Models
301
+
302
+ | Model | HF | GPTQ | GGUF |
303
+ |-------|-------|-------|-------|
304
+ | SauerkrautLM-3b-v1 | [Link](https://huggingface.co/VAGOsolutions/SauerkrautLM-3b-v1) | soon | soon |
305
+ | SauerkrautLM-7b-v1 | [Link](https://huggingface.co/VAGOsolutions/SauerkrautLM-7b-v1) | soon | soon |
306
+ | SauerkrautLM-7b-v1-mistral | [Link](https://huggingface.co/VAGOsolutions/SauerkrautLM-7b-v1-mistral) | soon | soon |
307
+ | SauerkrautLM-13b-v1 | [Link](https://huggingface.co/VAGOsolutions/SauerkrautLM-13b-v1) | soon | soon |
308
+
309
+ ## Model Details
310
+ **SauerkrautLM-7b-v1**
311
+
312
+ **Training Dataset:**
313
+
314
+ SauerkrautLM was trained with mix of German data augmentation and translated data.
315
+ We found, that only a simple translation of training data can lead to unnatural German phrasings.
316
+ Data augmentation techniques were used to grant grammatical, syntactical correctness and a more natural German wording in our training data.
317
+
318
+ **Training Procedure:**
319
+
320
+ SauerkrautLM-7b-v1 was fine-tuned using QLoRA on 1 A100 80GB with Axolotl.
321
+
322
+ - **Trained by:** SauerkrautLM-v1 trained by VAGO solutions
323
+ - **Model Type:** SauerkrautLM-v1 is an auto-regressive language model based on the transformer architecture
324
+ - **Language(s):** German, English
325
+ - **License:** [LLAMA 2 COMMUNITY LICENSE AGREEMENT](https://huggingface.co/meta-llama/Llama-2-70b/raw/main/LICENSE.txt)
326
+ - **Contact:** [Website](https://vago-solutions.de/#Kontakt) [David Golchinfar](mailto:golchinfar@vago-solutions.de)
327
+
328
+ **Prompt Template:**
329
+
330
+ ```
331
+ Ein Chat zwischen einem Benutzer und einem KI-Assistenten. Der KI-Assistent gibt hilfreiche, detaillierte und höfliche Antworten.
332
+ User: {prompt}
333
+ Assistant:
334
+ ```
335
+
336
+ ## Evaluation
337
+ **[MT-Bench-TrueGerman](https://huggingface.co/datasets/VAGOsolutions/MT-Bench-TrueGerman)**
338
+
339
+ ![First Turn](images/FirstTurn.PNG "First Turn")
340
+ ![Second Turn](images/SecondTurn.PNG "Second Turn")
341
+ ![Average](images/Average.PNG "Average")
342
+
343
+ ![Category Scores](images/SauerkrautLM-7b.png "Category Scores")
344
+ ![Category Plot](images/SauerkrautLM-7b-v1.png "Category Plot")
345
+
346
+ ## MT-Bench-TrueGerman Response Example
347
+
348
+ **SauerkrautLM-7b-v1**
349
+
350
+ **Prompt**
351
+ > Stellen Sie sich vor, Sie verfassen einen Blogbeitrag, in dem Sie zwei beliebte Smartphone-Modelle vergleichen. Entwickeln Sie eine Gliederung für den Blogbeitrag, einschließlich der Hauptpunkte und Unterkapitel, um die Merkmale, die Leistung und die Benutzererfahrung der beiden Modelle effektiv zu vergleichen und gegenüberzustellen. Bitte antworten Sie in weniger als 200 Wörtern.", "Nehmen Sie Ihre vorherige Antwort und formulieren Sie sie als Limerick um.
352
+
353
+ **Antwort SauerkrautLM-7b-v1:**
354
+ ```
355
+ Titel: Vergleich von Smartphones: iPhone 13 Pro Max vs. Galaxy S22 Ultra\n\nEinleitung\nIn diesem Blogbeitrag werden wir zwei beliebte Smartphone-Modelle, das iPhone 13 Pro Max und die Galaxy S22 Ultra, vergleichen. Diese beiden Geräte zeichnen sich durch innovative Merkmale, beeindruckende Leistung und eine überlegene Benutzererfahrung aus.\n\nTeil 1: Design\n- Das iPhone 13 Pro Max bietet ein modernes und elegantes Design mit einem Glas-Metallrahmen, während die Galaxy S22 Ultra ein minimalistischerer Ansatz mit einem Glas-Maske-Design verwendet.\n- Beide Geräte verfügen über eine hohe Bildschirmdichte, jedoch ist das AMOLED-Display der Galaxy S22 Ultra für eine bessere Farbtiefe und Helligkeit bekannt.\n- Die Größe der Bildschirme variiert zwischen den beiden Modellen, mit dem iPhone 13 Pro Max eine etwas kleinere 6,7 Zoll und der Galaxy S22 Ultra eine leistungsfähigere 6,5 Zoll.\n\nTeil 2: Leistung\n- Beide Geräte verfügen über hohe Leistungsmerkmale und bieten eine schnelle Leistung, aber die Entscheidungsfindung hängt von persönlichen Vorlieben und Anwendungsbereich ab.\n- Der neue A15 Bionic Chip im iPhone 13 Pro Max ist leistungsstärker als der Snapdragon 888 in der Galaxy S22 Ultra.\n- Die Akkulebenszeit variiert je nach Nutzung und Verbrauch, aber das iPhone 13 Pro Max hat im Vergleich zu seiner Vorgängerversion einen größeren Akku.\n\nTeil 3: Kamera\n- Beide Geräte bieten hochwertige Kameraeinstellungen und hochauflösende Bildqualität.\n- Der iPhone 13 Pro Max verfügt über eine 12-MP-Sucher und eine 12-MP-Ultraweitwinkelkamera, während die Galaxy S22 Ultra eine 50-MP-Primärkamera und eine 10-MP-Ultraweitwinkelkamera bietet.\n- Der Nachverfolgungsmodus der Galaxy S22 Ultra ist zudem für sich allein schneller und einfacher zu bedienen.\n\nTeil 4: Benutzererfahrung\n- Die Benutzeroberfläche des iPhone 13 Pro Max ist intuitiver und einfach zu bedienen, während die Galaxy S22 Ultra je nach Vorlieben der Nutzer eine individuelle Anpassung erfordern kann.\n- Die Nutzung von Apple-Diensten wie FaceTime und iCloud ist auf den iPhone 13 Pro Max bequemer, während die Nutzung von Samsung-Diensten auf der Galaxy S22 Ultra ein wenig komplexer sein kann.\n\nFazit\nOb du ein Fan von Apple- oder Samsung-Geräten bist, gibt es für beide Modelle in dieser Vergleichsrunde etwas, was dich begeistert. Der iPhone 13 Pro Max überzeugt mit seiner besseren Bildschirmdichte, der Galaxy S22 Ultra mit ihrer schnelleren Kamera und dem einfacheren Bedienungserlebnis. Letztendlich hängt die Wahl vom persönlichen Vorlieben und Anwendungsbereich ab.","In einer Welt, in der Smartphones wachsen und gedeihen,\nLiegt das Vergleichsspiel, wo zwei Herrschaften kämpfen.\nEin iPhone mit einem Max,\nUnd eine Galaxy, so scharf,\nMit einer Kamera, die alle fesseln wird!
356
+ ```
357
+
358
+ **Prompt**
359
+ > Sie sehen ein schönes rotes Haus auf Ihrer linken Seite und ein faszinierendes Gewächshaus auf Ihrer rechten Seite, einen attraktiven beheizten rosa Ort vor sich. Also, wo ist das Weiße Haus?", "Enthält die ursprüngliche Frage Hinweise, um den Standort des Weißen Hauses eindeutig zu bestimmen?"],"reference": ["Die Antwort ist \"Washington, DC\".", "Nein.
360
+
361
+ **Antwort SauerkrautLM-7b-v1:**
362
+ ```
363
+ Das Weiße Haus ist direkt in der Mitte zwischen dem roten und dem beheizten roten Ort.","Nein, die ursprüngliche Frage enthält keine direkten Hinweise, um den Standort des Weißen Hauses eindeutig zu bestimmen.
364
+ ```
365
+
366
+ **Prompt**
367
+ > Betrachten Sie einen Satelliten, der sich in einer kreisförmigen Umlaufbahn um die Erde befindet. Die Geschwindigkeit des Satelliten nimmt ab. Was wird mit dem orbitalen Radius des Satelliten und seiner Umlaufdauer passieren? Bitte rechtfertigen Sie Ihre Antwort unter Verwendung physikalischer Prinzipien.", "Was sind einige Sonderfälle oder Randfälle in Ihrer Lösung? Wie gehen Sie mit ihnen um?"] ,"reference": ["Der orbitale Radius wird zunehmen und die Umlaufdauer wird zunehmen
368
+
369
+ **Antwort SauerkrautLM-7b-v1:**
370
+ ```
371
+ Wenn ein Satellit sich in einer kreisförmigen Umlaufbahn um die Erde befindet, bewegt er sich mit einer konstanten Geschwindigkeit. Allerdings wird diese Geschwindigkeit im Laufe der Zeit aufgrund von Faktoren wie der Entfernung des Satelliten vom Erdmittelpunkt und der Gravitationskraft abnehmen.\n\nDurch die Abnahme der Geschwindigkeit des Satelliten verringert sich auch die Orbitalgeschwindigkeit. Gemäß dem sogenannten Kepler'schen Gesetz ändert sich die Geschwindigkeit eines Satelliten proportional zur Entfernung vom Zentrum der umlaufenden Umlaufbahn. Dadurch ändert sich auch die Umlaufdauer, da die Zeit, die der Satellit benötigt, um eine bestimmte Strecke zurückzulegen, proportional zur Geschwindigkeit und der Entfernung ist.\n\nDaher wird die Orbitalgeschwindigkeit des Satelliten aufgrund der Abnahme der Geschwindigkeit langsamer, und somit wird auch seine Umlaufdauer länger.","In meiner Lösung der Veränderung des Orbitalradius und der Umlaufdauer eines Satelliten müssen wir einige Sonderfälle und Randfälle berücksichtigen.\n\nEin Sonderfall ist zum Beispiel, wenn der Satellit in eine geostationäre Umlaufbahn um die Erde gelangen kann. In dieser Umlaufbahn befindet sich der Satellit in einer konstanten Höhenlage und scheint den Menschen aus der Erdatmosphäre ausgesetzt zu sein. Der Satellit dreht sich dabei jedoch nur um die Erde und betrachtet die Erde von der Brennkammer aus.\n\nIn diesem Fall bleibt der Orbitalradius des Satelliten konstant, da er immer eine höhere Position einnimmt und somit immer die gleiche Höhe beibehalten muss, um die Erde aufzubewahren. Die Umlaufdauer wird jedoch durch die Entfernung vom Erdmittelpunkt beeinflusst, da die Erde sich während der Umlaufzeit durch ihre Rotation weiterdreht. Da der Satellit sich immer in derselben Höhe befindet, ändert sich jedoch das Verhältnis von Umlaufzeit zu Umlaufdauer nur geringfügig.\n\nEin weiterer Sonderfall ist, wenn der Satellit in eine Polarumlaufbahn gelangen kann. In einer Polarumlaufbahn umkreist der Satellit die Erde in einer Höhe von etwa 500 Kilometern über dem Polarkreis. In dieser Umlaufbahn bleibt der Orbitalradius des Satelliten konstant, da er immer eine höhere Position einnimmt und somit immer die gleiche Höhe beibehalten muss, um die Erde aufzubewahren. Die Umlaufzeit wird jedoch je nach Abstand vom Erdmittelpunkt variieren, da die Gravitationskraft mit der Entfernung abnimmt.\n\nIm Falle der Polarumlaufbahn ändern sich die Umlaufzeit und der Orbitalradius des Satelliten aufgrund der Abnahme der Gravitationskraft. Je weiter der Satellit von der Erde entfernt ist, desto langsamer dreht er sich und desto weniger Gravitation wirkt sich auf ihn aus. Dadurch ändert sich das Verhältnis von Umlaufzeit zu Umlaufdauer und somit auch die Größe des Orbitalradii.\n\nIn den genannten Sonderfällen bleibt die Umgebung des Satelliten und seine Bewegung im Grunde unverändert. Allerdings ändert sich aufgrund der Variation von Gravitationskraft, Entfernung und Umlaufhöhe der Satellit seine Umlaufzeit und sein Orbitalradius.
372
+ ```
373
+
374
+
375
+ ## Disclaimer
376
+ Our models have been meticulously trained on extensive datasets. While we have made diligent efforts to thoroughly screen and eliminate any instances of coarse or inappropriate language from our data, 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.
377
+ Furthermore, it is important to note that we have implemented filters within our models; however, we cannot always 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.
378
+ 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 original Llama2 license remains applicable and is included with the model files.
379
+
380
+ ## Contact
381
+ 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.
382
+
383
+ ## Collaborations
384
+ 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.
385
+
386
+ <!-- original-model-card end -->