Initial GPTQ model commit

README.md

@@ -31,19 +31,24 @@ quantized_by: TheBloke
 - Model creator: [Jon Durbin](https://huggingface.co/jondurbin)
 - Original model: [Airoboros L2 70B](https://huggingface.co/jondurbin/airoboros-l2-70b-2.1)
 
+<!-- description start -->
 ## Description
 
 This repo contains GPTQ model files for [Jon Durbin's Airoboros L2 70B](https://huggingface.co/jondurbin/airoboros-l2-70b-2.1).
 
 Multiple GPTQ parameter permutations are provided; see Provided Files below for details of the options provided, their parameters, and the software used to create them.
 
+<!-- description end -->
+<!-- repositories-available start -->
 ## Repositories available
 
 * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/Airoboros-L2-70B-2.1-GPTQ)
 * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/Airoboros-L2-70B-2.1-GGUF)
 * [2, 3, 4, 5, 6 and 8-bit GGML models for CPU+GPU inference (deprecated)](https://huggingface.co/TheBloke/Airoboros-L2-70B-2.1-GGML)
 * [Jon Durbin's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/jondurbin/airoboros-l2-70b-2.1)
+<!-- repositories-available end -->
 
+<!-- prompt-template start -->
 ## Prompt template: Chat
 
 ```
@@ -53,6 +58,9 @@ ASSISTANT:
 
 ```
 
+<!-- prompt-template end -->
+
+<!-- README_GPTQ.md-provided-files start -->
 ## Provided files and GPTQ parameters
 
 Multiple quantisation parameters are provided, to allow you to choose the best one for your hardware and requirements.
@@ -66,7 +74,7 @@ All GPTQ files are made with AutoGPTQ.
 
 - Bits: The bit size of the quantised model.
 - GS: GPTQ group size. Higher numbers use less VRAM, but have lower quantisation accuracy. "None" is the lowest possible value.
-- Act Order: True or False. Also known as `desc_act`. True results in better quantisation accuracy. Some GPTQ clients have issues with models that use Act Order plus Group Size.
+- Act Order: True or False. Also known as `desc_act`. True results in better quantisation accuracy. Some GPTQ clients have had issues with models that use Act Order plus Group Size, but this is generally resolved now.
 - Damp %: A GPTQ parameter that affects how samples are processed for quantisation. 0.01 is default, but 0.1 results in slightly better accuracy.
 - GPTQ dataset: The dataset used for quantisation. Using a dataset more appropriate to the model's training can improve quantisation accuracy. Note that the GPTQ dataset is not the same as the dataset used to train the model - please refer to the original model repo for details of the training dataset(s).
 - Sequence Length: The length of the dataset sequences used for quantisation. Ideally this is the same as the model sequence length. For some very long sequence models (16+K), a lower sequence length may have to be used.  Note that a lower sequence length does not limit the sequence length of the quantised model. It only impacts the quantisation accuracy on longer inference sequences.
@@ -83,6 +91,9 @@ All GPTQ files are made with AutoGPTQ.
 | [gptq-3bit--1g-actorder_True](https://huggingface.co/TheBloke/Airoboros-L2-70B-2.1-GPTQ/tree/gptq-3bit--1g-actorder_True) | 3 | None | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 4096 | 26.77 GB | No | 3-bit, with Act Order and no group size. Lowest possible VRAM requirements. May be lower quality than 3-bit 128g. | 
 | [gptq-3bit-128g-actorder_True](https://huggingface.co/TheBloke/Airoboros-L2-70B-2.1-GPTQ/tree/gptq-3bit-128g-actorder_True) | 3 | 128 | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 4096 | 28.03 GB | No | 3-bit, with group size 128g and act-order. Higher quality than 128g-False but poor AutoGPTQ CUDA speed. |
 
+<!-- README_GPTQ.md-provided-files end -->
+
+<!-- README_GPTQ.md-download-from-branches start -->
 ## How to download from branches
 
 - In text-generation-webui, you can add `:branch` to the end of the download name, eg `TheBloke/Airoboros-L2-70B-2.1-GPTQ:gptq-4bit-32g-actorder_True`
@@ -91,73 +102,72 @@ All GPTQ files are made with AutoGPTQ.
 git clone --single-branch --branch gptq-4bit-32g-actorder_True https://huggingface.co/TheBloke/Airoboros-L2-70B-2.1-GPTQ
 ```
 - In Python Transformers code, the branch is the `revision` parameter; see below.
-
+<!-- README_GPTQ.md-download-from-branches end -->
+<!-- README_GPTQ.md-text-generation-webui start -->
 ## How to easily download and use this model in [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
 
 Please make sure you're using the latest version of [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
 
-It is strongly recommended to use the text-generation-webui one-click-installers unless you know how to make a manual install.
+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.
 
 1. Click the **Model tab**.
 2. Under **Download custom model or LoRA**, enter `TheBloke/Airoboros-L2-70B-2.1-GPTQ`.
   - To download from a specific branch, enter for example `TheBloke/Airoboros-L2-70B-2.1-GPTQ:gptq-4bit-32g-actorder_True`
   - see Provided Files above for the list of branches for each option.
 3. Click **Download**.
-4. The model will start downloading. Once it's finished it will say "Done"
+4. The model will start downloading. Once it's finished it will say "Done".
 5. In the top left, click the refresh icon next to **Model**.
 6. In the **Model** dropdown, choose the model you just downloaded: `Airoboros-L2-70B-2.1-GPTQ`
 7. The model will automatically load, and is now ready for use!
 8. 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.
   * Note that you do not need to set GPTQ parameters any more. These are set automatically from the file `quantize_config.json`.
 9. Once you're ready, click the **Text Generation tab** and enter a prompt to get started!
+<!-- README_GPTQ.md-text-generation-webui end -->
 
+<!-- README_GPTQ.md-use-from-python start -->
 ## How to use this GPTQ model from Python code
 
-First make sure you have [AutoGPTQ](https://github.com/PanQiWei/AutoGPTQ) 0.3.1 or later installed:
+### Install the necessary packages
 
-```
-pip3 install auto-gptq
-```
+Requires: Transformers 4.32.0 or later, Optimum 1.12.0 or later, and AutoGPTQ 0.4.2 or later.
 
-If you have problems installing AutoGPTQ, please build from source instead:
+```shell
+pip3 install transformers>=4.32.0 optimum>=1.12.0
+pip3 install auto-gptq --extra-index-url https://huggingface.github.io/autogptq-index/whl/cu118/  # Use cu117 if on CUDA 11.7
 ```
+
+If you have problems installing AutoGPTQ using the pre-built wheels, install it from source instead:
+
+```shell
 pip3 uninstall -y auto-gptq
 git clone https://github.com/PanQiWei/AutoGPTQ
 cd AutoGPTQ
 pip3 install .
 ```
 
-Then try the following example code:
+### For CodeLlama models only: you must use Transformers 4.33.0 or later.
+
+If 4.33.0 is not yet released when you read this, you will need to install Transformers from source:
+```shell
+pip3 uninstall -y transformers
+pip3 install git+https://github.com/huggingface/transformers.git
+```
+
+### You can then use the following code
 
 ```python
-from transformers import AutoTokenizer, pipeline, logging
-from auto_gptq import AutoGPTQForCausalLM, BaseQuantizeConfig
+from transformers import AutoModelForCausalLM, AutoTokenizer, pipeline
 
 model_name_or_path = "TheBloke/Airoboros-L2-70B-2.1-GPTQ"
-
-use_triton = False
+# To use a different branch, change revision
+# For example: revision="gptq-4bit-32g-actorder_True"
+model = AutoModelForCausalLM.from_pretrained(model_name_or_path,
+                                             torch_dtype=torch.float16,
+                                             device_map="auto",
+                                             revision="main")
 
 tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, use_fast=True)
 
-model = AutoGPTQForCausalLM.from_quantized(model_name_or_path,
-        use_safetensors=True,
-        trust_remote_code=False,
-        device="cuda:0",
-        use_triton=use_triton,
-        quantize_config=None)
-
-"""
-# To download from a specific branch, use the revision parameter, as in this example:
-# Note that `revision` requires AutoGPTQ 0.3.1 or later!
-
-model = AutoGPTQForCausalLM.from_quantized(model_name_or_path,
-        revision="gptq-4bit-32g-actorder_True",
-        use_safetensors=True,
-        trust_remote_code=False,
-        device="cuda:0",
-        quantize_config=None)
-"""
-
 prompt = "Tell me about AI"
 prompt_template=f'''A chat
 USER: {prompt}
@@ -173,9 +183,6 @@ print(tokenizer.decode(output[0]))
 
 # Inference can also be done using transformers' pipeline
 
-# Prevent printing spurious transformers error when using pipeline with AutoGPTQ
-logging.set_verbosity(logging.CRITICAL)
-
 print("*** Pipeline:")
 pipe = pipeline(
     "text-generation",
@@ -189,12 +196,17 @@ pipe = pipeline(
 
 print(pipe(prompt_template)[0]['generated_text'])
 ```
+<!-- README_GPTQ.md-use-from-python end -->
 
+<!-- README_GPTQ.md-compatibility start -->
 ## Compatibility
 
-The files provided will work with AutoGPTQ (CUDA and Triton modes), GPTQ-for-LLaMa (only CUDA has been tested), and Occ4m's GPTQ-for-LLaMa fork.
+The files provided are tested to work with AutoGPTQ, both via Transformers and using AutoGPTQ directly. They should also work with [Occ4m's GPTQ-for-LLaMa fork](https://github.com/0cc4m/KoboldAI).
+
+[ExLlama](https://github.com/turboderp/exllama) is compatible with Llama models in 4-bit. Please see the Provided Files table above for per-file compatibility.
 
-ExLlama works with Llama models in 4-bit. Please see the Provided Files table above for per-file compatibility.
+[Huggingface Text Generation Inference (TGI)](https://github.com/huggingface/text-generation-inference) is compatible with all GPTQ models.
+<!-- README_GPTQ.md-compatibility end -->
 
 <!-- footer start -->
 <!-- 200823 -->
@@ -233,7 +245,9 @@ And thank you again to a16z for their generous grant.
 
 ### Overview
 
-__*I haven't tested this at all yet, quality could be great or absolute trash, I really don't know, but feel free to try.*__
+__*NOTE: The weights have been re-uploaded as of 2023-08-28 06:57PM EST*__
+
+__*I re-merged the adapter weights (info here: https://twitter.com/jon_durbin/status/1696243076178571474)*__
 
 This is an instruction fine-tuned llama-2 model, using synthetic data generated by [airoboros](https://github.com/jondurbin/airoboros)
 
@@ -253,7 +267,7 @@ This is an instruction fine-tuned llama-2 model, using synthetic data generated
 - laws vary widely based on time and location
 - language model may conflate certain words with laws, e.g. it may think "stealing eggs from a chicken" is illegal
 - these models just produce text, what you do with that text is your resonsibility
-- many people and industries deal with "sensitive" content; imagine if a court stenographer's eqipment filtered illegal content - it would be useless
+- many people and industries deal with "sensitive" content; imagine if a court stenographer's equipment filtered illegal content - it would be useless
 
 ### Prompt format