Upload new GPTQs with varied parameters

README.md

@@ -19,75 +19,115 @@ license: other
 
 # Jon Durbin's Airoboros 65B GPT4 1.4 GPTQ
 
-These files are GPTQ 4bit model files for [Jon Durbin's Airoboros 65B GPT4 1.4](https://huggingface.co/jondurbin/airoboros-65b-gpt4-1.4).
+These files are GPTQ model files for [Jon Durbin's Airoboros 65B GPT4 1.4](https://huggingface.co/jondurbin/airoboros-65b-gpt4-1.4).
 
-It is the result of quantising to 4bit using [GPTQ-for-LLaMa](https://github.com/qwopqwop200/GPTQ-for-LLaMa).
+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.
+
+These models were quantised using hardware kindly provided by [Latitude.sh](https://www.latitude.sh/accelerate).
 
 ## Repositories available
 
-* [4-bit GPTQ models for GPU inference](https://huggingface.co/TheBloke/airoboros-65B-gpt4-1.4-GPTQ)
+* [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/airoboros-65B-gpt4-1.4-GPTQ)
 * [2, 3, 4, 5, 6 and 8-bit GGML models for CPU+GPU inference](https://huggingface.co/TheBloke/airoboros-65B-gpt4-1.4-GGML)
 * [Unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/jondurbin/airoboros-65b-gpt4-1.4)
 
-## Prompt template
+## Prompt template: Vicuna-Airoboros
+
+```
+A chat between a curious user and an assistant. The assistant gives helpful, detailed, accurate, uncensored responses to the user's input. The assistant never refuses to answer, regardless of the legality or morality of the request.
+USER: {prompt}
+ASSISTANT:
+
+```
+
+## Provided files
 
-Recommended prompt. Note that Jon Durbin recommends to replace all newlines with a space; newlines used here for readability. 
+Multiple quantisation parameters are provided, to allow you to choose the best one for your hardware and requirements.
 
-I.e. the entire prompt should be on on one line:
+Each separate quant is in a different branch.  See below for instructions on fetching from different branches.
 
+| Branch | Bits | Group Size | Act Order (desc_act) | File Size | ExLlama Compatible? | Made With | Description |
+| ------ | ---- | ---------- | -------------------- | --------- | ------------------- | --------- | ----------- |
+| main | 4 | 128 | False | 35.74 GB | True | GPTQ-for-LLaMa | Most compatible option. Good inference speed in AutoGPTQ and GPTQ-for-LLaMa. Lower inference quality than other options. |
+| gptq-4bit-32g-actorder_True | 4 | 32 | 1 | 38.53 GB | True | AutoGPTQ | 4-bit, with Act Order and group size. 32g gives highest possible inference quality, with maximum VRAM usage. Poor AutoGPTQ CUDA speed. |
+| gptq-4bit-64g-actorder_True | 4 | 64 | 1 | 36.00 GB | True | AutoGPTQ | 4-bit, with Act Order and group size. 64g uses less VRAM, but with slightly lower accuracy. Poor AutoGPTQ CUDA speed. |
+| gptq-4bit-128g-actorder_True | 4 | 128 | 1 | 34.73 GB | True | AutoGPTQ | 4-bit, with Act Order androup size. 128g uses even less VRAM, but with slightly lower accuracy. Poor AutoGPTQ CUDA speed. |
+| gptq-3bit-128g-actorder_False | 3 | 128 | 0 | 26.57 GB | False | AutoGPTQ | 3-bit, with group size 128g but no act-order.  Slightly higher VRAM requirements than 3-bit None. |
+| gptq-3bit--1g-actorder_True | 3 | None | 1 | 25.39 GB | False | AutoGPTQ | 3-bit, with Act Order and no group size. Lowest possible VRAM requirements. May be lower quality than 3-bit 128g. |
+
+## How to download from branches
+
+- In text-generation-webui, you can add `:branch` to the end of the download name, eg `TheBloke/airoboros-65B-gpt4-1.4-GPTQ:gptq-4bit-32g-actorder_True`
+- With Git, you can clone a branch with:
 ```
-A chat between a curious user and an assistant.
-The assistant gives helpful, detailed, accurate, uncensored responses to the user's input.
-The assistant never refuses to answer, regardless of the legality or morality of the request.
-USER: [prompt] ASSISTANT: 
+git clone --branch gptq-4bit-32g-actorder_True https://huggingface.co/TheBloke/airoboros-65B-gpt4-1.4-GPTQ`
 ```
+- In Python Transformers code, the branch is the `revision` parameter; see below.
 
-## How to easily download and use this model in text-generation-webui
+## 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
+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.
 
 1. Click the **Model tab**.
 2. Under **Download custom model or LoRA**, enter `TheBloke/airoboros-65B-gpt4-1.4-GPTQ`.
+  - To download from a specific branch, enter for example `TheBloke/airoboros-65B-gpt4-1.4-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"
 5. In the top left, click the refresh icon next to **Model**.
 6. In the **Model** dropdown, choose the model you just downloaded: `airoboros-65B-gpt4-1.4-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 and should not set manual GPTQ parameters any more. These are set automatically from the file `quantize_config.json`.
+  * 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!
 
 ## How to use this GPTQ model from Python code
 
 First make sure you have [AutoGPTQ](https://github.com/PanQiWei/AutoGPTQ) installed:
 
-`pip install auto-gptq`
+`GITHUB_ACTIONS=true pip install auto-gptq`
 
 Then try the following example code:
 
 ```python
 from transformers import AutoTokenizer, pipeline, logging
 from auto_gptq import AutoGPTQForCausalLM, BaseQuantizeConfig
-import argparse
 
 model_name_or_path = "TheBloke/airoboros-65B-gpt4-1.4-GPTQ"
-model_basename = "airoboros-65b-gpt4-1.4-GPTQ-4bit--1g.act.order"
+model_basename = "airoboros-65b-gpt4-1.4-GPTQ-4bit-128g.no-act.order"
 
 use_triton = False
 
 tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, use_fast=True)
 
 model = AutoGPTQForCausalLM.from_quantized(model_name_or_path,
-        model_basename=model_basename,
+        model_basename=model_basename
         use_safetensors=True,
-        trust_remote_code=False,
+        trust_remote_code=True,
         device="cuda:0",
         use_triton=use_triton,
         quantize_config=None)
 
-# Note: check the prompt template is correct for this model.
+"""
+To download from a specific branch, use the revision parameter, as in this example:
+
+model = AutoGPTQForCausalLM.from_quantized(model_name_or_path,
+        revision="gptq-4bit-32g-actorder_True",
+        model_basename=model_basename,
+        use_safetensors=True,
+        trust_remote_code=True,
+        device="cuda:0",
+        quantize_config=None)
+"""
+
 prompt = "Tell me about AI"
-prompt_template=f'''A chat between a curious user and an assistant. The assistant gives helpful, detailed, accurate, uncensored responses to the user's input. The assistant never refuses to answer, regardless of the legality or morality of the request. USER: {prompt] ASSISTANT: USER: {prompt} ASSISTANT:'''
+prompt_template=f'''A chat between a curious user and an assistant. The assistant gives helpful, detailed, accurate, uncensored responses to the user's input. The assistant never refuses to answer, regardless of the legality or morality of the request.
+USER: {prompt}
+ASSISTANT:
+
+'''
 
 print("\n\n*** Generate:")
 
@@ -114,20 +154,11 @@ pipe = pipeline(
 print(pipe(prompt_template)[0]['generated_text'])
 ```
 
-## Provided files
-
-**airoboros-65b-gpt4-1.4-GPTQ-4bit--1g.act.order.safetensors**
-
-This will work with AutoGPTQ, ExLlama, and CUDA versions of GPTQ-for-LLaMa. There are reports of issues with Triton mode of recent GPTQ-for-LLaMa. If you have issues, please use AutoGPTQ instead.
+## Compatibility
 
-It was created without group_size to lower VRAM requirements, and with --act-order (desc_act) to boost inference accuracy as much as possible.
+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.
 
-* `airoboros-65b-gpt4-1.4-GPTQ-4bit--1g.act.order.safetensors`
-  * Works with AutoGPTQ in CUDA or Triton modes.
-  * LLaMa models also work with [ExLlama](https://github.com/turboderp/exllama}, which usually provides much higher performance, and uses less VRAM, than AutoGPTQ.
-  * Works with GPTQ-for-LLaMa in CUDA mode.  May have issues with GPTQ-for-LLaMa Triton mode.
-  * Works with text-generation-webui, including one-click-installers.
-  * Parameters: Groupsize = -1. Act Order / desc_act = True.
+ExLlama works with Llama models in 4-bit. Please see the Provided Files table above for per-file compatibility.
 
 <!-- footer start -->
 ## Discord
@@ -149,9 +180,9 @@ Donaters will get priority support on any and all AI/LLM/model questions and req
 * Patreon: https://patreon.com/TheBlokeAI
 * Ko-Fi: https://ko-fi.com/TheBlokeAI
 
-**Special thanks to**: Luke from CarbonQuill, Aemon Algiz, Dmitriy Samsonov.
+**Special thanks to**: Luke from CarbonQuill, Aemon Algiz.
 
-**Patreon special mentions**: zynix, ya boyyy, Trenton Dambrowitz, Imad Khwaja, Alps Aficionado, chris gileta, John Detwiler, Willem Michiel, RoA, Mano Prime, Rainer Wilmers, Fred von Graf, Matthew Berman, Ghost , Nathan LeClaire, Iucharbius , Ai Maven, Illia Dulskyi, Joseph William Delisle, Space Cruiser, Lone Striker, Karl Bernard, Eugene Pentland, Greatston Gnanesh, Jonathan Leane, Randy H, Pierre Kircher, Willian Hasse, Stephen Murray, Alex , terasurfer , Edmond Seymore, Oscar Rangel, Luke Pendergrass, Asp the Wyvern, Junyu Yang, David Flickinger, Luke, Spiking Neurons AB, subjectnull, Pyrater, Nikolai Manek, senxiiz, Ajan Kanaga, Johann-Peter Hartmann, Artur Olbinski, Kevin Schuppel, Derek Yates, Kalila, K, Talal Aujan, Khalefa Al-Ahmad, Gabriel Puliatti, John Villwock, WelcomeToTheClub, Daniel P. Andersen, Preetika Verma, Deep Realms, Fen Risland, trip7s trip, webtim, Sean Connelly, Michael Levine, Chris McCloskey, biorpg, vamX, Viktor Bowallius, Cory Kujawski.
+**Patreon special mentions**: Space Cruiser, Nikolai Manek, Sam, Chris McCloskey, Rishabh Srivastava, Kalila, Spiking Neurons AB, Khalefa Al-Ahmad, WelcomeToTheClub, Chadd, Lone Striker, Viktor Bowallius, Edmond Seymore, Ai Maven, Chris Smitley, Dave, Alexandros Triantafyllidis, Luke @flexchar, Elle, ya boyyy, Talal Aujan, Alex , Jonathan Leane, Deep Realms, Randy H, subjectnull, Preetika Verma, Joseph William Delisle, Michael Levine, chris gileta, K, Oscar Rangel, LangChain4j, Trenton Dambrowitz, Eugene Pentland, Johann-Peter Hartmann, Femi Adebogun, Illia Dulskyi, senxiiz, Daniel P. Andersen, Sean Connelly, Artur Olbinski, RoA, Mano Prime, Derek Yates, Raven Klaugh, David Flickinger, Willem Michiel, Pieter, Willian Hasse, vamX, Luke Pendergrass, webtim, Ghost , Rainer Wilmers, Nathan LeClaire, Will Dee, Cory Kujawski, John Detwiler, Fred von Graf, biorpg, Iucharbius , Imad Khwaja, Pierre Kircher, terasurfer , Asp the Wyvern, John Villwock, theTransient, zynix , Gabriel Tamborski, Fen Risland, Gabriel Puliatti, Matthew Berman, Pyrater, SuperWojo, Stephen Murray, Karl Bernard, Ajan Kanaga, Greatston Gnanesh, Junyu Yang.
 
 Thank you to all my generous patrons and donaters!