AWQ is an efficient, accurate and blazing-fast low-bit weight quantization method, currently supporting 4-bit quantization. Compared to GPTQ, it offers faster Transformers-based inference with equivalent or better quality compared to the most commonly used GPTQ settings.

It is supported by:

Text Generation Webui - using Loader: AutoAWQ
vLLM - Llama and Mistral models only
Hugging Face Text Generation Inference (TGI)
AutoAWQ - for use from Python code

Repositories available

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]

Provided files, and AWQ parameters

For my first release of AWQ models, I am releasing 128g models only. I will consider adding 32g as well if there is interest, and once I have done perplexity and evaluation comparisons, but at this time 32g models are still not fully tested with AutoAWQ and vLLM.

Models are released as sharded safetensors files.

Branch	Bits	GS	AWQ Dataset	Seq Len	Size
main	4	128	German Quad	4096	36.61 GB

How to easily download and use this model in text-generation-webui

Please make sure you're using the latest version of text-generation-webui.

It is strongly recommended to use the text-generation-webui one-click-installers unless you're sure you know how to make a manual install.

Click the Model tab.
Under Download custom model or LoRA, enter TheBloke/SauerkrautLM-70B-v1-AWQ.
Click Download.
The model will start downloading. Once it's finished it will say "Done".
In the top left, click the refresh icon next to Model.
In the Model dropdown, choose the model you just downloaded: SauerkrautLM-70B-v1-AWQ
Select Loader: AutoAWQ.
Click Load, and the model will load and is now ready for use.
If you want any custom settings, set them and then click Save settings for this model followed by Reload the Model in the top right.
Once you're ready, click the Text Generation tab and enter a prompt to get started!

Multi-user inference server: vLLM

Documentation on installing and using vLLM can be found here.

Please ensure you are using vLLM version 0.2 or later.
When using vLLM as a server, pass the --quantization awq parameter.

For example:

python3 python -m vllm.entrypoints.api_server --model TheBloke/SauerkrautLM-70B-v1-AWQ --quantization awq

When using vLLM from Python code, again set quantization=awq.

For example:

python

from vllm import LLM, SamplingParams

prompts = [
    "Tell me about AI",
    "Write a story about llamas",
    "What is 291 - 150?",
    "How much wood would a woodchuck chuck if a woodchuck could chuck wood?",
]
prompt_template=f'''[INST] <<SYS>>
Ein Chat zwischen einem Benutzer und einem KI-Assistenten. Der KI-Assistent gibt hilfreiche, detaillierte und höfliche Antworten.
<</SYS>>
{prompt}[/INST]
'''

prompts = [prompt_template.format(prompt=prompt) for prompt in prompts]

sampling_params = SamplingParams(temperature=0.8, top_p=0.95)

llm = LLM(model="TheBloke/SauerkrautLM-70B-v1-AWQ", quantization="awq", dtype="auto")

outputs = llm.generate(prompts, sampling_params)

# Print the outputs.
for output in outputs:
    prompt = output.prompt
    generated_text = output.outputs[0].text
    print(f"Prompt: {prompt!r}, Generated text: {generated_text!r}")

Multi-user inference server: Hugging Face Text Generation Inference (TGI)

Use TGI version 1.1.0 or later. The official Docker container is: ghcr.io/huggingface/text-generation-inference:1.1.0

Example Docker parameters:

--model-id TheBloke/SauerkrautLM-70B-v1-AWQ --port 3000 --quantize awq --max-input-length 3696 --max-total-tokens 4096 --max-batch-prefill-tokens 4096

Example Python code for interfacing with TGI (requires huggingface-hub 0.17.0 or later):

pip3 install huggingface-hub

python

from huggingface_hub import InferenceClient

endpoint_url = "https://your-endpoint-url-here"

prompt = "Tell me about AI"
prompt_template=f'''[INST] <<SYS>>
Ein Chat zwischen einem Benutzer und einem KI-Assistenten. Der KI-Assistent gibt hilfreiche, detaillierte und höfliche Antworten.
<</SYS>>
{prompt}[/INST]
'''

client = InferenceClient(endpoint_url)
response = client.text_generation(prompt,
                                  max_new_tokens=128,
                                  do_sample=True,
                                  temperature=0.7,
                                  top_p=0.95,
                                  top_k=40,
                                  repetition_penalty=1.1)

print(f"Model output: ", response)

Inference from Python code using AutoAWQ

Install the AutoAWQ package

Requires: AutoAWQ 0.1.1 or later.

pip3 install autoawq

If you have problems installing AutoAWQ using the pre-built wheels, install it from source instead:

shell

pip3 uninstall -y autoawq
git clone https://github.com/casper-hansen/AutoAWQ
cd AutoAWQ
pip3 install .

AutoAWQ example code

python

from awq import AutoAWQForCausalLM
from transformers import AutoTokenizer

model_name_or_path = "TheBloke/SauerkrautLM-70B-v1-AWQ"

# Load tokenizer
tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, trust_remote_code=False)
# Load model
model = AutoAWQForCausalLM.from_quantized(model_name_or_path, fuse_layers=True,
                                          trust_remote_code=False, safetensors=True)

prompt = "Tell me about AI"
prompt_template=f'''[INST] <<SYS>>
Ein Chat zwischen einem Benutzer und einem KI-Assistenten. Der KI-Assistent gibt hilfreiche, detaillierte und höfliche Antworten.
<</SYS>>
{prompt}[/INST]
'''

print("*** Running model.generate:")

token_input = tokenizer(
    prompt_template,
    return_tensors='pt'
).input_ids.cuda()

# Generate output
generation_output = model.generate(
    token_input,
    do_sample=True,
    temperature=0.7,
    top_p=0.95,
    top_k=40,
    max_new_tokens=512
)

# Get the tokens from the output, decode them, print them
token_output = generation_output[0]
text_output = tokenizer.decode(token_output)
print("LLM output: ", text_output)

"""
# Inference should be possible with transformers pipeline as well in future
# But currently this is not yet supported by AutoAWQ (correct as of September 25th 2023)
from transformers import pipeline

print("*** Pipeline:")
pipe = pipeline(
    "text-generation",
    model=model,
    tokenizer=tokenizer,
    max_new_tokens=512,
    do_sample=True,
    temperature=0.7,
    top_p=0.95,
    top_k=40,
    repetition_penalty=1.1
)

print(pipe(prompt_template)[0]['generated_text'])
"""

Compatibility

The files provided are tested to work with:

text-generation-webui using Loader: AutoAWQ.
vLLM version 0.2.0 and later.
Hugging Face Text Generation Inference (TGI) version 1.1.0 and later.
AutoAWQ version 0.1.1 and later.

Discord

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

TheBloke AI's Discord server

Thanks, and how to contribute

Thanks to the chirper.ai team!

Thanks to Clay from gpus.llm-utils.org!

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.

Original model card: VAGO solutions's SauerkrautLM 70B v1

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	Link	Link	Link
SauerkrautLM-7b-v1	Link	Link	Link	Link
SauerkrautLM-7b-v1-mistral	Link	Link	Link	Link
SauerkrautLM-13b-v1	Link	Link	Link	Link
SauerkrautLM-70b-v1	Link	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
Contact: Website David Golchinfar

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

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. 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 for super fast quantifying all of our models.