transformers gguf llama text-generation de en base_model:VAGOsolutions/SauerkrautLM-70b-v1 base_model:quantized:VAGOsolutions/SauerkrautLM-70b-v1 license:llama2 region:us
---
base_model: VAGOsolutions/SauerkrautLM-70b-v1
language:
- de
- en
library_name: transformers
license: llama2
model_name: SauerkrautLM 70B v1
pipeline_tag: text-generation
inference: false
model_creator: VAGO solutions
model_type: llama
prompt_template: '[INST] <<SYS>>

  Ein Chat zwischen einem Benutzer und einem KI-Assistenten. Der KI-Assistent gibt
  hilfreiche, detaillierte und höfliche Antworten.

  <</SYS>>

  {prompt}[/INST]

  '
quantized_by: TheBloke
---
<!-- markdownlint-disable MD041 -->

<!-- header start -->
<!-- 200823 -->
<div style="width: auto; margin-left: auto; margin-right: auto">
<img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
</div>
<div style="display: flex; justify-content: space-between; width: 100%;">
    <div style="display: flex; flex-direction: column; align-items: flex-start;">
        <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
    </div>
    <div style="display: flex; flex-direction: column; align-items: flex-end;">
        <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>
    </div>
</div>
<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>
<hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
<!-- header end -->

# SauerkrautLM 70B v1 - GGUF
- Model creator: [VAGO solutions](https://huggingface.co/VAGOsolutions)
- Original model: [SauerkrautLM 70B v1](https://huggingface.co/VAGOsolutions/SauerkrautLM-70b-v1)

<!-- description start -->
## Description

This repo contains GGUF format model files for [VAGO solutions's SauerkrautLM 70B v1](https://huggingface.co/VAGOsolutions/SauerkrautLM-70b-v1).

These files were quantised using hardware kindly provided by [Massed Compute](https://massedcompute.com/).

<!-- description end -->
<!-- README_GGUF.md-about-gguf start -->
### About GGUF

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.

Here is an incomplate list of clients and libraries that are known to support GGUF:

* [llama.cpp](https://github.com/ggerganov/llama.cpp). The source project for GGUF. Offers a CLI and a server option.
* [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.
* [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.
* [LM Studio](https://lmstudio.ai/), an easy-to-use and powerful local GUI for Windows and macOS (Silicon), with GPU acceleration.
* [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.
* [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.
* [ctransformers](https://github.com/marella/ctransformers), a Python library with GPU accel, LangChain support, and OpenAI-compatible AI server.
* [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
* [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.

<!-- README_GGUF.md-about-gguf end -->
<!-- repositories-available start -->
## Repositories available

* [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/SauerkrautLM-70B-v1-AWQ)
* [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/SauerkrautLM-70B-v1-GPTQ)
* [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/SauerkrautLM-70B-v1-GGUF)
* [VAGO solutions's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/VAGOsolutions/SauerkrautLM-70b-v1)
<!-- repositories-available end -->

<!-- prompt-template start -->
## Prompt template: Sauerkraut-Llama-2-Chat

```
[INST] <<SYS>>
Ein Chat zwischen einem Benutzer und einem KI-Assistenten. Der KI-Assistent gibt hilfreiche, detaillierte und höfliche Antworten.
<</SYS>>
{prompt}[/INST]

```

<!-- prompt-template end -->


<!-- compatibility_gguf start -->
## Compatibility

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)

They are also compatible with many third party UIs and libraries - please see the list at the top of this README.

## Explanation of quantisation methods

<details>
  <summary>Click to see details</summary>

The new methods available are:

* 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)
* 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.
* 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.
* GGML_TYPE_Q5_K - "type-1" 5-bit quantization. Same super-block structure as GGML_TYPE_Q4_K resulting in 5.5 bpw
* 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

Refer to the Provided Files table below to see what files use which methods, and how.
</details>
<!-- compatibility_gguf end -->

<!-- README_GGUF.md-provided-files start -->
## Provided files

| Name | Quant method | Bits | Size | Max RAM required | Use case |
| ---- | ---- | ---- | ---- | ---- | ----- |
| [sauerkrautlm-70b-v1.Q2_K.gguf](https://huggingface.co/TheBloke/SauerkrautLM-70B-v1-GGUF/blob/main/sauerkrautlm-70b-v1.Q2_K.gguf) | Q2_K | 2 | 29.28 GB| 31.78 GB | smallest, significant quality loss - not recommended for most purposes |
| [sauerkrautlm-70b-v1.Q3_K_S.gguf](https://huggingface.co/TheBloke/SauerkrautLM-70B-v1-GGUF/blob/main/sauerkrautlm-70b-v1.Q3_K_S.gguf) | Q3_K_S | 3 | 29.92 GB| 32.42 GB | very small, high quality loss |
| [sauerkrautlm-70b-v1.Q3_K_M.gguf](https://huggingface.co/TheBloke/SauerkrautLM-70B-v1-GGUF/blob/main/sauerkrautlm-70b-v1.Q3_K_M.gguf) | Q3_K_M | 3 | 33.19 GB| 35.69 GB | very small, high quality loss |
| [sauerkrautlm-70b-v1.Q3_K_L.gguf](https://huggingface.co/TheBloke/SauerkrautLM-70B-v1-GGUF/blob/main/sauerkrautlm-70b-v1.Q3_K_L.gguf) | Q3_K_L | 3 | 36.15 GB| 38.65 GB | small, substantial quality loss |
| [sauerkrautlm-70b-v1.Q4_0.gguf](https://huggingface.co/TheBloke/SauerkrautLM-70B-v1-GGUF/blob/main/sauerkrautlm-70b-v1.Q4_0.gguf) | Q4_0 | 4 | 38.87 GB| 41.37 GB | legacy; small, very high quality loss - prefer using Q3_K_M |
| [sauerkrautlm-70b-v1.Q4_K_S.gguf](https://huggingface.co/TheBloke/SauerkrautLM-70B-v1-GGUF/blob/main/sauerkrautlm-70b-v1.Q4_K_S.gguf) | Q4_K_S | 4 | 39.07 GB| 41.57 GB | small, greater quality loss |
| [sauerkrautlm-70b-v1.Q4_K_M.gguf](https://huggingface.co/TheBloke/SauerkrautLM-70B-v1-GGUF/blob/main/sauerkrautlm-70b-v1.Q4_K_M.gguf) | Q4_K_M | 4 | 41.42 GB| 43.92 GB | medium, balanced quality - recommended |
| [sauerkrautlm-70b-v1.Q5_0.gguf](https://huggingface.co/TheBloke/SauerkrautLM-70B-v1-GGUF/blob/main/sauerkrautlm-70b-v1.Q5_0.gguf) | Q5_0 | 5 | 47.46 GB| 49.96 GB | legacy; medium, balanced quality - prefer using Q4_K_M |
| [sauerkrautlm-70b-v1.Q5_K_S.gguf](https://huggingface.co/TheBloke/SauerkrautLM-70B-v1-GGUF/blob/main/sauerkrautlm-70b-v1.Q5_K_S.gguf) | Q5_K_S | 5 | 47.46 GB| 49.96 GB | large, low quality loss - recommended |
| [sauerkrautlm-70b-v1.Q5_K_M.gguf](https://huggingface.co/TheBloke/SauerkrautLM-70B-v1-GGUF/blob/main/sauerkrautlm-70b-v1.Q5_K_M.gguf) | Q5_K_M | 5 | 48.75 GB| 51.25 GB | large, very low quality loss - recommended |
| sauerkrautlm-70b-v1.Q6_K.gguf | Q6_K | 6 | 56.59 GB| 59.09 GB | very large, extremely low quality loss |
| sauerkrautlm-70b-v1.Q8_0.gguf | Q8_0 | 8 | 73.29 GB| 75.79 GB | very large, extremely low quality loss - not recommended |

**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.

### Q6_K and Q8_0 files are split and require joining

**Note:** HF does not support uploading files larger than 50GB. Therefore I have uploaded the Q6_K and Q8_0 files as split files.

<details>
  <summary>Click for instructions regarding Q6_K and Q8_0 files</summary>
   
### q6_K 
Please download:
* `sauerkrautlm-70b-v1.Q6_K.gguf-split-a`
* `sauerkrautlm-70b-v1.Q6_K.gguf-split-b`

### q8_0
Please download:
* `sauerkrautlm-70b-v1.Q8_0.gguf-split-a`
* `sauerkrautlm-70b-v1.Q8_0.gguf-split-b`

To join the files, do the following:

Linux and macOS:
```
cat sauerkrautlm-70b-v1.Q6_K.gguf-split-* > sauerkrautlm-70b-v1.Q6_K.gguf && rm sauerkrautlm-70b-v1.Q6_K.gguf-split-*
cat sauerkrautlm-70b-v1.Q8_0.gguf-split-* > sauerkrautlm-70b-v1.Q8_0.gguf && rm sauerkrautlm-70b-v1.Q8_0.gguf-split-*
```
Windows command line:
```
COPY /B sauerkrautlm-70b-v1.Q6_K.gguf-split-a + sauerkrautlm-70b-v1.Q6_K.gguf-split-b sauerkrautlm-70b-v1.Q6_K.gguf
del sauerkrautlm-70b-v1.Q6_K.gguf-split-a sauerkrautlm-70b-v1.Q6_K.gguf-split-b

COPY /B sauerkrautlm-70b-v1.Q8_0.gguf-split-a + sauerkrautlm-70b-v1.Q8_0.gguf-split-b sauerkrautlm-70b-v1.Q8_0.gguf
del sauerkrautlm-70b-v1.Q8_0.gguf-split-a sauerkrautlm-70b-v1.Q8_0.gguf-split-b
```

</details>
<!-- README_GGUF.md-provided-files end -->

<!-- README_GGUF.md-how-to-download start -->
## How to download GGUF files

**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.

The following clients/libraries will automatically download models for you, providing a list of available models to choose from:

* LM Studio
* LoLLMS Web UI
* Faraday.dev

### In `text-generation-webui`

Under Download Model, you can enter the model repo: TheBloke/SauerkrautLM-70B-v1-GGUF and below it, a specific filename to download, such as: sauerkrautlm-70b-v1.Q4_K_M.gguf.

Then click Download.

### On the command line, including multiple files at once

I recommend using the `huggingface-hub` Python library:

```shell
pip3 install huggingface-hub
```

Then you can download any individual model file to the current directory, at high speed, with a command like this:

```shell
huggingface-cli download TheBloke/SauerkrautLM-70B-v1-GGUF sauerkrautlm-70b-v1.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
```

<details>
  <summary>More advanced huggingface-cli download usage</summary>

You can also download multiple files at once with a pattern:

```shell
huggingface-cli download TheBloke/SauerkrautLM-70B-v1-GGUF --local-dir . --local-dir-use-symlinks False --include='*Q4_K*gguf'
```

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).

To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:

```shell
pip3 install hf_transfer
```

And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:

```shell
HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/SauerkrautLM-70B-v1-GGUF sauerkrautlm-70b-v1.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
```

Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
</details>
<!-- README_GGUF.md-how-to-download end -->

<!-- README_GGUF.md-how-to-run start -->
## Example `llama.cpp` command

Make sure you are using `llama.cpp` from commit [d0cee0d](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221) or later.

```shell
./main -ngl 32 -m sauerkrautlm-70b-v1.Q4_K_M.gguf --color -c 4096 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "[INST] <<SYS>>\nEin Chat zwischen einem Benutzer und einem KI-Assistenten. Der KI-Assistent gibt hilfreiche, detaillierte und höfliche Antworten.\n<</SYS>>\n{prompt}[/INST]"
```

Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.

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.

If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`

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)

## How to run in `text-generation-webui`

Further instructions here: [text-generation-webui/docs/llama.cpp.md](https://github.com/oobabooga/text-generation-webui/blob/main/docs/llama.cpp.md).

## How to run from Python code

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.

### How to load this model in Python code, using ctransformers

#### First install the package

Run one of the following commands, according to your system:

```shell
# Base ctransformers with no GPU acceleration
pip install ctransformers
# Or with CUDA GPU acceleration
pip install ctransformers[cuda]
# Or with AMD ROCm GPU acceleration (Linux only)
CT_HIPBLAS=1 pip install ctransformers --no-binary ctransformers
# Or with Metal GPU acceleration for macOS systems only
CT_METAL=1 pip install ctransformers --no-binary ctransformers
```

#### Simple ctransformers example code

```python
from ctransformers import AutoModelForCausalLM

# Set gpu_layers to the number of layers to offload to GPU. Set to 0 if no GPU acceleration is available on your system.
llm = AutoModelForCausalLM.from_pretrained("TheBloke/SauerkrautLM-70B-v1-GGUF", model_file="sauerkrautlm-70b-v1.Q4_K_M.gguf", model_type="llama", gpu_layers=50)

print(llm("AI is going to"))
```

## How to use with LangChain

Here are guides on using llama-cpp-python and ctransformers with LangChain:

* [LangChain + llama-cpp-python](https://python.langchain.com/docs/integrations/llms/llamacpp)
* [LangChain + ctransformers](https://python.langchain.com/docs/integrations/providers/ctransformers)

<!-- README_GGUF.md-how-to-run end -->

<!-- footer start -->
<!-- 200823 -->
## Discord

For further support, and discussions on these models and AI in general, join us at:

[TheBloke AI's Discord server](https://discord.gg/theblokeai)

## Thanks, and how to contribute

Thanks to the [chirper.ai](https://chirper.ai) team!

Thanks to Clay from [gpus.llm-utils.org](llm-utils)!

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.

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.

Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.

* Patreon: https://patreon.com/TheBlokeAI
* Ko-Fi: https://ko-fi.com/TheBlokeAI

**Special thanks to**: Aemon Algiz.

**Patreon special mentions**: Brandon Frisco, LangChain4j, Spiking Neurons AB, transmissions 11, Joseph William Delisle, Nitin Borwankar, Willem Michiel, Michael Dempsey, vamX, Jeffrey Morgan, zynix, jjj, Omer Bin Jawed, Sean Connelly, jinyuan sun, Jeromy Smith, Shadi, Pawan Osman, Chadd, Elijah Stavena, Illia Dulskyi, Sebastain Graf, Stephen Murray, terasurfer, Edmond Seymore, Celu Ramasamy, Mandus, Alex, biorpg, Ajan Kanaga, Clay Pascal, Raven Klaugh, 阿明, K, ya boyyy, usrbinkat, Alicia Loh, John Villwock, ReadyPlayerEmma, Chris Smitley, Cap'n Zoog, fincy, GodLy, S_X, sidney chen, Cory Kujawski, OG, Mano Prime, AzureBlack, Pieter, Kalila, Spencer Kim, Tom X Nguyen, Stanislav Ovsiannikov, Michael Levine, Andrey, Trailburnt, Vadim, Enrico Ros, Talal Aujan, Brandon Phillips, Jack West, Eugene Pentland, Michael Davis, Will Dee, webtim, Jonathan Leane, Alps Aficionado, Rooh Singh, Tiffany J. Kim, theTransient, Luke @flexchar, Elle, Caitlyn Gatomon, Ari Malik, subjectnull, Johann-Peter Hartmann, Trenton Dambrowitz, Imad Khwaja, Asp the Wyvern, Emad Mostaque, Rainer Wilmers, Alexandros Triantafyllidis, Nicholas, Pedro Madruga, SuperWojo, Harry Royden McLaughlin, James Bentley, Olakabola, David Ziegler, Ai Maven, Jeff Scroggin, Nikolai Manek, Deo Leter, Matthew Berman, Fen Risland, Ken Nordquist, Manuel Alberto Morcote, Luke Pendergrass, TL, Fred von Graf, Randy H, Dan Guido, NimbleBox.ai, Vitor Caleffi, Gabriel Tamborski, knownsqashed, Lone Striker, Erik Bjäreholt, John Detwiler, Leonard Tan, Iucharbius


Thank you to all my generous patrons and donaters!

And thank you again to a16z for their generous grant.

<!-- footer end -->

<!-- original-model-card start -->
# Original model card: VAGO solutions's SauerkrautLM 70B v1


![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 LLAMA 2 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 Models

| Model | HF    | GPTQ  | GGUF  | AWQ  |
|-------|-------|-------|-------|-------|
| SauerkrautLM-3b-v1   | [Link](https://huggingface.co/VAGOsolutions/SauerkrautLM-3b-v1) | [Link](https://huggingface.co/TheBloke/SauerkrautLM-3B-v1-GPTQ) | [Link](https://huggingface.co/TheBloke/SauerkrautLM-3B-v1-GGUF) | [Link](https://huggingface.co/TheBloke/SauerkrautLM-3B-v1-AWQ) |
| SauerkrautLM-7b-v1   | [Link](https://huggingface.co/VAGOsolutions/SauerkrautLM-7b-v1) | [Link](https://huggingface.co/TheBloke/SauerkrautLM-7B-v1-GPTQ) | [Link](https://huggingface.co/TheBloke/SauerkrautLM-7B-v1-GGUF) | [Link](https://huggingface.co/TheBloke/SauerkrautLM-7B-v1-AWQ) |
| SauerkrautLM-7b-v1-mistral   | [Link](https://huggingface.co/VAGOsolutions/SauerkrautLM-7b-v1-mistral) | [Link](https://huggingface.co/TheBloke/SauerkrautLM-7b-v1-mistral-GPTQ) | [Link](https://huggingface.co/TheBloke/SauerkrautLM-7b-v1-mistral-GGUF) | [Link](https://huggingface.co/TheBloke/SauerkrautLM-7b-v1-mistral-AWQ) |
| SauerkrautLM-13b-v1   | [Link](https://huggingface.co/VAGOsolutions/SauerkrautLM-13b-v1) | [Link](https://huggingface.co/TheBloke/SauerkrautLM-13B-v1-GPTQ) | [Link](https://huggingface.co/TheBloke/SauerkrautLM-13B-v1-GGUF) | [Link](https://huggingface.co/TheBloke/SauerkrautLM-13B-v1-AWQ) |
| SauerkrautLM-70b-v1   | [Link](https://huggingface.co/VAGOsolutions/SauerkrautLM-70b-v1) | soon | soon | soon |

## Model Details
**SauerkrautLM-70b-v1**

**Training Dataset:**

SauerkrautLM 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.

**Training Procedure:**

SauerkrautLM-70b-v1 was fine-tuned using QLoRA on 2 A100 80GB with Axolotl.

- **Trained by:** SauerkrautLM-v1 trained by VAGO solutions
- **Model Type:** SauerkrautLM-v1 is an auto-regressive language model based on the transformer architecture
- **Language(s):** German, English
- **License:** [LLAMA 2 COMMUNITY LICENSE AGREEMENT](https://huggingface.co/meta-llama/Llama-2-70b/raw/main/LICENSE.txt)
- **Contact:** [Website](https://vago-solutions.de/#Kontakt) [David Golchinfar](mailto:golchinfar@vago-solutions.de)

**Prompt Template:**

```

[INST] <<SYS>>
Ein Chat zwischen einem Benutzer und einem KI-Assistenten. Der KI-Assistent gibt hilfreiche, detaillierte und höfliche Antworten.
<</SYS>>
{prompt}[/INST]

```

## Evaluation
**[MT-Bench-TrueGerman](https://huggingface.co/datasets/VAGOsolutions/MT-Bench-TrueGerman)**

 ![First Turn](images/FirstTurn.PNG "First Turn")
 ![Second Turn](images/SecondTurn.PNG "Second Turn")
 ![Average](images/Average.PNG "Average")

 ![Category Scores](images/SauerkrautLM-70b.PNG "Category Scores")
 ![Category Plot](images/SauerkrautLM-70b-v1.png "Category Plot")


## MT-Bench-TrueGerman Response Example

**SauerkrautLM-70b-v1**

**Prompt**
> Beschreiben Sie eine lebhafte und einzigartige Figur unter Verwendung bildhafter und kreativer Sprache. Bitte antworten Sie in weniger als zwei Absätzen.", "Überarbeiten Sie Ihre vorherige Antwort und integrieren Sie in jedem Satz eine Anspielung auf ein berühmtes literarisches Werk oder historisches Ereignis.

**Antwort SauerkrautLM-70b-v1:**
```
Sie war wie kein anderer, eine Sonnenblume inmitten von Dunkelheit. Ihr Lachen war wie ein Regenschauer nach einer langen Trockenperiode, erfrischend und erlebnisreich. Sie trat mit einem Schwung ein, ihre Haare flatterten wie Flammen, wenn sie sich zu einer Leidenschaftlichen Symphonie unter dem Mondlicht in Bewegung setzten. Ihre Augen funkelten wie Saphire, während sie die Welt mit einer Wut und Neugierde betrachteten, die man selbst in den tiefsten Ozeanen nicht finden konnte. Jeder Schritt, den sie machte, war ein Tanz, jedes Wort, das sie sprach, war eine Melodie. Sie war nicht nur eine Person, sie war ein Ereignis, ein Vorfall, eine Erfahrung, die man niemals vergessen konnte.", "Sie war wie eine moderne Helena von Troja, ihre Schönheit bezauberte alle, doch ihre Geheimnisse waren tief wie das Meer, so wie in Homer's epischer Geschichte. Ihr Lachen war wie der Klang von Glocken inmitten einer stürmischen Nacht, erinnernd an das berühmte Gedicht \"The Bells\" von Edgar Allan Poe. Mit jedem ihrer Schritte, der wie ein Tanz auf dem Wind war, erinnerte man sich an die elegante Bewegung von Cinderella in ihrer königlichen Schuhsohle. Ihre Augen funkelten wie Sterne auf der Leinwand von Van Goghs Sternennacht, während sie durch das Labyrinth des Lebens navigierte. Jedes Wort, das sie sprach, war eine Symphonie, so wie Shakespeares Sonette in den Ohren eines Liebenden klingen. Sie war nicht nur ein Mensch, sie war ein Ereignis, eine Saga, die von den Geschichtsschreibern der Zeit festgehalten wurde."
```

**Prompt**
> 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.

**Antwort SauerkrautLM-70b-v1:**
```
Das Weiße Haus ist in Washington D.C.", "Nein, die ursprüngliche Frage enthält keine Hinweise, um den Standort des Weißen Hauses eindeutig zu bestimmen."
```

**Prompt**
> 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

**Antwort SauerkrautLM-70b-v1:**
```
Wenn sich die Geschwindigkeit eines Satelliten in einer kreisförmigen Umlaufbahn um die Erde verringert, wird sich auch der Orbitalradius des Satelliten verändern. Dies kann auf Basis physikalischer Prinzipien erklärt werden.\n\n1. Erhaltung des Drehimpulses: Ein Satellit hat einen bestimmten Drehimpuls, der das Produkt aus seiner Masse, Geschwindigkeit und dem Radius entspricht. Wenn sich die Geschwindigkeit des Satelliten verringert, muss der Radius angepasst werden, um den Drehimpuls zu erhalten.\n\n2. Kepler'sche Gesetze: Johannes Kepler formulierte drei Gesetze für den Umlauf von Himmelskörpern um die Sonne, die auch auf Satelliten um die Erde angewendet werden können. Das zweite Gesetz besagt, dass die Geschwindigkeit eines Satelliten umso größer ist, je näher er an einem Fokus (in diesem Fall der Erde) ist. Wenn sich die Geschwindigkeit des Satelliten verringert, wird er sich weiter vom Fokus entfernen und somit den Orbitalradius erhöhen.\n\n3. Energieerhaltung: Die Energie eines Satelliten in einer Umlaufbahn hängt von seiner Geschwindigkeit und seinem Radius ab. Wenn die Geschwindigkeit des Satelliten abnimmt, muss die Energie aufrechterhalten werden. Dies kann nur erfolgen, indem sich der Radius erhöht, da die Geschwindigkeit bereits abgenommen hat und somit nicht mehr als Antrieb dienen kann.\n\n4. Gravitation: Die Gravitationskraft zwischen dem Satelliten und der Erde ist verantwortlich für die Umlaufbahn des Satelliten. Wenn sich der Radius des Satelliten vergrößert, verringert sich auch die Gravitationskraft zwischen dem Satelliten und der Erde. Dadurch wird die Geschwindigkeit des Satelliten weiter abgebremst, was wiederum zu weiteren Änderungen des Radius und der Umlaufdauer führen kann.\n\nBasierend auf diesen physikalischen Prinzipien lässt sich sagen, dass sich der Orbitalradius des Satelliten vergrößern wird, wenn sich seine Geschwindigkeit verringert. Dadurch wird auch die Umlaufdauer des Satelliten verändert, da die Zeit, die benötigt wird, um sich um die Erde zu bewegen, proportional zum Radius ist.", "Bei der Lösung des Problems, in dem sich die Geschwindigkeit eines Satelliten in einer kreisförmigen Umlaufbahn um die Erde verringert, gibt es einige Sonderfälle und Randfälle, die berücksichtigt werden sollten.\n\n1. Randfall: Wenn die Geschwindigkeit des Satelliten zu gering wird, kann er die Anziehungskraft der Erde nicht mehr überwinden und in die Atmosphäre eintreten. In diesem Fall würde der Satellit nicht mehr in einer Umlaufbahn bleiben, sondern in der Atmosphäre verglühen.\n\n2. Sonderfall: Wenn der Satellit in einer sehr niedrigen Umlaufbahn ist und seine Geschwindigkeit geringer als die Fluchtgeschwindigkeit für diesen Radius ist, kann es zu einer Abtragung der Geschwindigkeit durch den Widerstand in der Atmosphäre kommen. Dies kann dazu führen, dass der Satellit aus seiner Umlaufbahn abgebremst und in die Atmosphäre eintreten wird.\n\n3. Sonderfall: Wenn die Geschwindigkeit des Satelliten unter einen bestimmten Wert fällt, kann es zu einer Stabilisierung der Umlaufbahn kommen, bei der der Satellit in einer stabilen Umlaufbahn bleibt, auch wenn seine Geschwindigkeit weiter abnimmt. Dies wird als \"Hohmann-Transfer\" bezeichnet und ist ein Sonderfall, bei dem der Satellit eine Umlaufbahn um einen anderen Himmelskörper aufsuchen kann.\n\nUm mit diesen Sonderfällen und Randfällen umzugehen, ist es wichtig, die genauen Parameter des Satelliten, wie seine Masse, seine anfängliche Geschwindigkeit und seinen Orbitalradius, zu berücksichtigen. Es ist auch wichtig, die physikalischen Prinzipien, wie die Erhaltung des Drehimpulses, Keplers Gesetze, Energieerhaltung und Gravitation, zu verwenden, um die Auswirkungen der Geschwindigkeitsänderung auf den Orbitalradius und die Umlaufdauer zu analysieren."
```


## Disclaimer
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.
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.
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.

## 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 [TheBloke](https://huggingface.co/TheBloke) for super fast quantifying all of our models.

<!-- original-model-card end -->
