README.md

metadata

datasets:
  - tiiuae/falcon-refinedweb
language:
  - en
inference: false

https://discord.gg/UBgz4VXf

https://www.patreon.com/TheBlokeAI

Falcon-40B-Instruct GPTQ

This repo contains an experimantal GPTQ 4bit model for Falcon-40B-Instruct.

It is the result of quantising to 4bit using AutoGPTQ.

Need support? Want to discuss? I now have a Discord!

Join me at: https://discord.gg/UBgz4VXf

Want to support me and help pay my cloud computing bill? I also now have a Patreon! https://www.patreon.com/TheBlokeAI

EXPERIMENTAL

Please note this is an experimental first model. Support for it is currently quite limited.

To use it you will require:

1. AutoGPTQ, from the latest main branch and compiled with pip install .
2. pip install einops

You can then use it immediately from Python code - see example code below

text-generation-webui

There is also provisional AutoGPTQ support in text-generation-webui.

However at the time I'm writing this, a commit is needed to text-generation-webui to enable it to load this model.

I have opened a PR here; once this is merged, text-generation-webui will support this GPTQ model.

To get it working before the PR is merged, you will need to:

1. Edit text-generation-webui/modules/AutoGPTQ_loader.py
2. Make the following change:

Find the line that says:

'use_safetensors': use_safetensors,

And after it, add:

'trust_remote_code': shared.args.trust_remote_code,

Once you are done the file should look like this

3. Then save and close the file, and launch text-generation-webui as described below

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

1. Launch text-generation-webui with the following command-line arguments: --autogptq --trust_remote_code
2. Click the Model tab.
3. Under Download custom model or LoRA, enter TheBloke/falcon-7B-instruct-GPTQ.
4. Click Download.
5. Wait until it says it's finished downloading.
6. Click the Refresh icon next to Model in the top left.
7. In the Model drop-down: choose the model you just downloaded, falcon-7B-instruct-GPTQ.
8. Once it says it's loaded, click the Text Generation tab and enter a prompt!

About trust_remote_code

Please be aware that this command line argument causes Python code provided by Falcon to be executed on your machine.

This code is required at the moment because Falcon is too new to be supported by Hugging Face transformers. At some point in the future transformers will support the model natively, and then trust_remote_code will no longer be needed.

In this repo you can see two .py files - these are the files that get executed. They are copied from the base repo at Falcon-7B-Instruct.

Simple Python example code

To run this code you need to install AutoGPTQ from source:

git clone https://github.com/PanQiWei/AutoGPTQ
cd AutoGPTQ
pip install . # This step requires CUDA toolkit installed

And install einops:

pip install einops

You can then run this example code:

import torch
from transformers import AutoTokenizer
from auto_gptq import AutoGPTQForCausalLM

# Download the model from HF and store it locally, then reference its location here:
quantized_model_dir = "/path/to/falcon7b-instruct-gptq"

from transformers import AutoTokenizer
tokenizer = AutoTokenizer.from_pretrained(quantized_model_dir, use_fast=False)

model = AutoGPTQForCausalLM.from_quantized(quantized_model_dir, device="cuda:0", use_triton=False, use_safetensors=True, torch_dtype=torch.float32, trust_remote_code=True)

prompt = "Write a story about llamas"
prompt_template = f"### Instruction: {prompt}\n### Response:"

tokens = tokenizer(prompt_template, return_tensors="pt").to("cuda:0").input_ids
output = model.generate(input_ids=tokens, max_new_tokens=100, do_sample=True, temperature=0.8)
print(tokenizer.decode(output[0]))

Provided files

gptq_model-4bit-64g.safetensors

This will work with AutoGPTQ as of commit 3cb1bf5 (3cb1bf5a6d43a06dc34c6442287965d1838303d3)

It was created with groupsize 64 to give higher inference quality, and without desc_act (act-order) to increase inference speed.

• gptq_model-4bit-64g.safetensors
  • Works only with latest AutoGPTQ CUDA, compiled from source as of commit 3cb1bf5
    • At this time it does not work with AutoGPTQ Triton, but support will hopefully be added in time.
  • Works with text-generation-webui using --autogptq --trust_remote_code
    • At this time it does NOT work with one-click-installers
  • Does not work with any version of GPTQ-for-LLaMa
  • Parameters: Groupsize = 64. No act-order.

✨ Original model card: Falcon-40B-Instruct