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: LimaRP-Alpaca

### Instruction:
Character's Persona: bot character description

User's persona: user character description
  
Scenario: what happens in the story

Play the role of Character. You must engage in a roleplaying chat with User below this line. Do not write dialogues and narration for User. Character should respond with messages of medium length.

### Input:
User: {prompt}

### Response:
Character:

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	wikitext	4096	4.15 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/AshhLimaRP-Mistral-7B-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: AshhLimaRP-Mistral-7B-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/AshhLimaRP-Mistral-7B-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'''### Instruction:
Character's Persona: bot character description

User's persona: user character description
  
Scenario: what happens in the story

Play the role of Character. You must engage in a roleplaying chat with User below this line. Do not write dialogues and narration for User. Character should respond with messages of medium length.

### Input:
User: {prompt}

### Response:
Character: 
'''

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

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

llm = LLM(model="TheBloke/AshhLimaRP-Mistral-7B-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/AshhLimaRP-Mistral-7B-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'''### Instruction:
Character's Persona: bot character description

User's persona: user character description
  
Scenario: what happens in the story

Play the role of Character. You must engage in a roleplaying chat with User below this line. Do not write dialogues and narration for User. Character should respond with messages of medium length.

### Input:
User: {prompt}

### Response:
Character: 
'''

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/AshhLimaRP-Mistral-7B-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'''### Instruction:
Character's Persona: bot character description

User's persona: user character description
  
Scenario: what happens in the story

Play the role of Character. You must engage in a roleplaying chat with User below this line. Do not write dialogues and narration for User. Character should respond with messages of medium length.

### Input:
User: {prompt}

### Response:
Character: 
'''

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: 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

Thank you to all my generous patrons and donaters!

And thank you again to a16z for their generous grant.

Original model card: Suikamelon's AshhLimaRP Mistral 7B

AshhLimaRP-Mistral-7B (Alpaca, v1)

This is a version of LimaRP with 2000 training samples up to about 9k tokens length finetuned on Ashhwriter-Mistral-7B.

LimaRP is a longform-oriented, novel-style roleplaying chat model intended to replicate the experience of 1-on-1 roleplay on Internet forums. Short-form, IRC/Discord-style RP (aka "Markdown format") is not supported. The model does not include instruction tuning, only manually picked and slightly edited RP conversations with persona and scenario data.

Ashhwriter, the base, is a model entirely finetuned on human-written lewd stories.

Available versions

Float16 HF weights
LoRA Adapter (adapter_config.json and adapter_model.bin)
4bit AWQ
Q4_K_M GGUF
Q6_K GGUF

Prompt format

Extended Alpaca format, with ### Instruction:, ### Input: immediately preceding user inputs and ### Response: immediately preceding model outputs. While Alpaca wasn't originally intended for multi-turn responses, in practice this is not a problem; the format follows a pattern already used by other models.

### Instruction:
Character's Persona: {bot character description}

User's Persona: {user character description}

Scenario: {what happens in the story}

Play the role of Character. You must engage in a roleplaying chat with User below this line. Do not write dialogues and narration for User.

### Input:
User: {utterance}

### Response:
Character: {utterance}

### Input
User: {utterance}

### Response:
Character: {utterance}

(etc.)

You should:

Replace all text in curly braces (curly braces included) with your own text.
Replace User and Character with appropriate names.

Message length control

Inspired by the previously named "Roleplay" preset in SillyTavern, with this version of LimaRP it is possible to append a length modifier to the response instruction sequence, like this:

### Input
User: {utterance}

### Response: (length = medium)
Character: {utterance}

This has an immediately noticeable effect on bot responses. The lengths using during training are: micro, tiny, short, medium, long, massive, huge, enormous, humongous, unlimited. The recommended starting length is medium. Keep in mind that the AI can ramble or impersonate the user with very long messages.

The length control effect is reproducible, but the messages will not necessarily follow lengths very precisely, rather follow certain ranges on average, as seen in this table with data from tests made with one reply at the beginning of the conversation:

Response length control appears to work well also deep into the conversation. By omitting the modifier, the model will choose the most appropriate response length (although it might not necessarily be what the user desires).

Suggested settings

You can follow these instruction format settings in SillyTavern. Replace medium with your desired response length:

Text generation settings

These settings could be a good general starting point:

TFS = 0.90
Temperature = 0.70
Repetition penalty = ~1.11
Repetition penalty range = ~2048
top-k = 0 (disabled)
top-p = 1 (disabled)

Training procedure

Axolotl was used for training on 2x NVidia A40 GPUs.

The A40 GPUs have been graciously provided by Arc Compute.

Training hyperparameters

A lower learning rate than usual was employed. Due to an unforeseen issue the training was cut short and as a result 3 epochs were trained instead of the planned 4. Using 2 GPUs, the effective global batch size would have been 16.

Training was continued from the most recent LoRA adapter from Ashhwriter, using the same LoRA R and LoRA alpha.

lora_model_dir: /home/anon/bin/axolotl/OUT_mistral-stories/checkpoint-6000/
learning_rate: 0.00005
lr_scheduler: cosine
noisy_embedding_alpha: 3.5
num_epochs: 4
sequence_len: 8750
lora_r: 256
lora_alpha: 16
lora_dropout: 0.05
lora_target_linear: True
bf16: True
fp16: false
tf32: True
load_in_8bit: True
adapter: lora
micro_batch_size: 2
optimizer: adamw_bnb_8bit
warmup_steps: 10
optimizer: adamw_torch
flash_attention: true
sample_packing: true
pad_to_sequence_len: true

Loss graphs

Values are higher than typical because the training is performed on the entire sample, similar to unsupervised finetuning.

TheBloke/
AshhLimaRP-Mistral-7B-AWQ

AshhLimaRP Mistral 7B - AWQ

Description

About AWQ

Repositories available

Prompt template: LimaRP-Alpaca

Provided files, and AWQ parameters

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

Multi-user inference server: vLLM

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

Inference from Python code using AutoAWQ

Install the AutoAWQ package

AutoAWQ example code

Compatibility

Discord

Thanks, and how to contribute

Original model card: Suikamelon's AshhLimaRP Mistral 7B

AshhLimaRP-Mistral-7B (Alpaca, v1)

Available versions

Prompt format

Message length control

Suggested settings

Text generation settings

Training procedure

Training hyperparameters

Loss graphs

Train loss

Eval loss