Upload README.md

README.md

@@ -1,13 +1,24 @@
 ---
-license: other
+base_model: https://huggingface.co/ehartford/Wizard-Vicuna-13B-Uncensored
 datasets:
 - ehartford/wizard_vicuna_70k_unfiltered
+inference: false
 language:
 - en
+license: other
+model_creator: Eric Hartford
+model_name: Wizard Vicuna 13B Uncensored
+model_type: llama
+prompt_template: 'A chat between a curious user and an artificial intelligence assistant.
+  The assistant gives helpful, detailed, and polite answers to the user''s questions.
+  USER: {prompt} ASSISTANT:
+
+  '
+quantized_by: TheBloke
 tags:
 - uncensored
-inference: false
 ---
+
 <!-- header start -->
 <!-- 200823 -->
 <div style="width: auto; margin-left: auto; margin-right: auto">
@@ -25,74 +36,189 @@ inference: false
 <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
 <!-- header end -->
 
-# Wizard-Vicuna-13B-Uncensored GPTQ
+# Wizard Vicuna 13B Uncensored - GPTQ
+- Model creator: [Eric Hartford](https://huggingface.co/ehartford)
+- Original model: [Wizard Vicuna 13B Uncensored](https://huggingface.co/ehartford/Wizard-Vicuna-13B-Uncensored)
 
-This is GPTQ format quantised 4bit models of [Eric Hartford's 'uncensored' training of Wizard-Vicuna 13B](https://huggingface.co/ehartford/Wizard-Vicuna-13B-Uncensored).
+<!-- description start -->
+## Description
 
-It is the result of quantising to 4bit using [GPTQ-for-LLaMa](https://github.com/qwopqwop200/GPTQ-for-LLaMa).
+This repo contains GPTQ model files for [Eric Hartford's Wizard Vicuna 13B Uncensored](https://huggingface.co/ehartford/Wizard-Vicuna-13B-Uncensored).
 
+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
 
-* [4bit GPTQ models for GPU inference](https://huggingface.co/TheBloke/Wizard-Vicuna-13B-Uncensored-GPTQ).
-* [4bit and 5bit GGML models for CPU inference](https://huggingface.co/TheBloke/Wizard-Vicuna-13B-Uncensored-GGML).
-* [float16 HF format model for GPU inference and further conversions](https://huggingface.co/TheBloke/Wizard-Vicuna-13B-Uncensored-HF).
+* [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/Wizard-Vicuna-13B-Uncensored-AWQ)
+* [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/Wizard-Vicuna-13B-Uncensored-GPTQ)
+* [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/Wizard-Vicuna-13B-Uncensored-GGUF)
+* [Eric Hartford's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/ehartford/Wizard-Vicuna-13B-Uncensored)
+<!-- repositories-available end -->
+
+<!-- prompt-template start -->
+## Prompt template: Vicuna
+
+```
+A chat between a curious user and an artificial intelligence assistant. The assistant gives helpful, detailed, and polite answers to the user's questions. USER: {prompt} ASSISTANT:
+
+```
+
+<!-- prompt-template end -->
+<!-- licensing start -->
+## Licensing
+
+The creator of the source model has listed its license as `other`, and this quantization has therefore used that same license.
+
+As this model is based on Llama 2, it is also subject to the Meta Llama 2 license terms, and the license files for that are additionally included. It should therefore be considered as being claimed to be licensed under both licenses. I contacted Hugging Face for clarification on dual licensing but they do not yet have an official position. Should this change, or should Meta provide any feedback on this situation, I will update this section accordingly.
+
+In the meantime, any questions regarding licensing, and in particular how these two licenses might interact, should be directed to the original model repository: [Eric Hartford's Wizard Vicuna 13B Uncensored](https://huggingface.co/ehartford/Wizard-Vicuna-13B-Uncensored).
+<!-- licensing 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.
+
+Each separate quant is in a different branch.  See below for instructions on fetching from different branches.
+
+All recent GPTQ files are made with AutoGPTQ, and all files in non-main branches are made with AutoGPTQ. Files in the `main` branch which were uploaded before August 2023 were made with GPTQ-for-LLaMa.
+
+<details>
+  <summary>Explanation of GPTQ parameters</summary>
+
+- 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 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.
+- ExLlama Compatibility: Whether this file can be loaded with ExLlama, which currently only supports Llama models in 4-bit.
 
-## How to easily download and use this model in text-generation-webui
+</details>
 
-Open the text-generation-webui UI as normal.
+| Branch | Bits | GS | Act Order | Damp % | GPTQ Dataset | Seq Len | Size | ExLlama | Desc |
+| ------ | ---- | -- | --------- | ------ | ------------ | ------- | ---- | ------- | ---- |
+| [latest](https://huggingface.co/TheBloke/Wizard-Vicuna-13B-Uncensored-GPTQ/tree/latest) | 4 | 128 | Yes | 0.01 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 2048 | 8.11 GB | Yes | 4-bit, with Act Order and group size 128g. Uses even less VRAM than 64g, but with slightly lower accuracy. | 
+| [model_v1](https://huggingface.co/TheBloke/Wizard-Vicuna-13B-Uncensored-GPTQ/tree/model_v1) | 4 | 128 | No | 0.01 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 2048 | 8.11 GB | Yes | 4-bit, without Act Order and group size 128g. | 
+| [main](https://huggingface.co/TheBloke/Wizard-Vicuna-13B-Uncensored-GPTQ/tree/main) | 4 | 128 | No | 0.01 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 2048 | 8.11 GB | Yes | 4-bit, without Act Order and group size 128g. |
+
+<!-- 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/Wizard-Vicuna-13B-Uncensored-GPTQ:latest`
+- With Git, you can clone a branch with:
+```
+git clone --single-branch --branch latest https://huggingface.co/TheBloke/Wizard-Vicuna-13B-Uncensored-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're sure you know how to make a manual install.
 
 1. Click the **Model tab**.
 2. Under **Download custom model or LoRA**, enter `TheBloke/Wizard-Vicuna-13B-Uncensored-GPTQ`.
+  - To download from a specific branch, enter for example `TheBloke/Wizard-Vicuna-13B-Uncensored-GPTQ:latest`
+  - see Provided Files above for the list of branches for each option.
 3. Click **Download**.
-4. Wait until it says it's finished downloading.
-5. Click the **Refresh** icon next to **Model** in the top left.
-6. In the **Model drop-down**: choose the model you just downloaded, `Wizard-Vicuna-13B-Uncensored-GPTQ`.
-7. If you see an error in the bottom right, ignore it - it's temporary.
-8. Fill out the `GPTQ parameters` on the right: `Bits = 4`, `Groupsize = 128`, `model_type = Llama`
-9. Click **Save settings for this model** in the top right.
-10. Click **Reload the Model** in the top right.
-11. Once it says it's loaded, click the **Text Generation tab** and enter a prompt!
+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: `Wizard-Vicuna-13B-Uncensored-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`.
+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
+
+### Install the necessary packages
+
+Requires: Transformers 4.32.0 or later, Optimum 1.12.0 or later, and AutoGPTQ 0.4.2 or later.
+
+```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
+```
 
-## Provided files
+If you have problems installing AutoGPTQ using the pre-built wheels, install it from source instead:
 
-**Compatible file - Wizard-Vicuna-13B-Uncensored-GPTQ-4bit-128g.compat.no-act-order.safetensors**
+```shell
+pip3 uninstall -y auto-gptq
+git clone https://github.com/PanQiWei/AutoGPTQ
+cd AutoGPTQ
+pip3 install .
+```
 
-In the `main` branch - the default one - you will find `Wizard-Vicuna-13B-Uncensored-GPTQ-4bit-128g.compat.no-act-order.safetensors`
+### For CodeLlama models only: you must use Transformers 4.33.0 or later.
 
-This will work with all versions of GPTQ-for-LLaMa. It has maximum compatibility
+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
+```
 
-It was created without the `--act-order` parameter. It may have slightly lower inference quality compared to the other file, but is guaranteed to work on all versions of GPTQ-for-LLaMa and text-generation-webui.
+### You can then use the following code
 
-* `Wizard-Vicuna-13B-Uncensored-GPTQ-4bit-128g.compat.no-act-order.safetensors`
-  * Works with all versions of GPTQ-for-LLaMa code, both Triton and CUDA branches
-  * Works with AutoGPTQ.
-  * Works with text-generation-webui one-click-installers
-  * Parameters: Groupsize = 128g. No act-order.
-  * Command used to create the GPTQ:
-    ```
-    python llama.py ehartford_Wizard-Vicuna-13B-Uncensored c4 --wbits 4 --groupsize 128 --true-sequential --save_safetensors Wizard-Vicuna-13B-Uncensored-GPTQ-4bit-128g.compat.no-act-order.safetensors
-    ```
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer, pipeline
 
-**Latest file with act-order - Wizard-Vicuna-13B-Uncensored-GPTQ-4bit-128g.latest.act-order.safetensors**
+model_name_or_path = "TheBloke/Wizard-Vicuna-13B-Uncensored-GPTQ"
+# To use a different branch, change revision
+# For example: revision="latest"
+model = AutoModelForCausalLM.from_pretrained(model_name_or_path,
+                                             device_map="auto",
+                                             trust_remote_code=False,
+                                             revision="main")
 
-In the `latest` branch you will find `Wizard-Vicuna-13B-Uncensored-GPTQ-4bit-128g.latest.act-order.safetensors`
+tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, use_fast=True)
 
-This requires recent GPTQ-for-LLaMa code. It will not work with ooba's fork.
+prompt = "Tell me about AI"
+prompt_template=f'''A chat between a curious user and an artificial intelligence assistant. The assistant gives helpful, detailed, and polite answers to the user's questions. USER: {prompt} ASSISTANT:
 
-It was created with the `--act-order` parameter to maximise inference quality.
+'''
 
+print("\n\n*** Generate:")
 
-To download this branch in text-generation-webui, enter `TheBloke/Wizard-Vicuna-13B-Uncensored-GPTQ:latest` in the Download Model box.
+input_ids = tokenizer(prompt_template, return_tensors='pt').input_ids.cuda()
+output = model.generate(inputs=input_ids, temperature=0.7, do_sample=True, top_p=0.95, top_k=40, max_new_tokens=512)
+print(tokenizer.decode(output[0]))
 
-* `Wizard-Vicuna-13B-Uncensored-GPTQ-4bit-128g.latest.act-order.safetensors`
-  * Works only with recent GPTQ-for-LLaMa.
-  * Works with AutoGPTQ.
-  * Will not work with text-generation-webui one-click-installers
-  * Parameters: Groupsize = 128g. Act order.
-  * Command used to create the GPTQ:
-    ```
-    python llama.py ehartford_Wizard-Vicuna-13B-Uncensored c4 --wbits 4 --groupsize 128 --true-sequential --act-order --save_safetensors Wizard-Vicuna-13B-Uncensored-GPTQ-4bit-128g.latest.act-order.safetensors
-    ```
+# Inference can also be done using transformers' 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'])
+```
+<!-- README_GPTQ.md-use-from-python end -->
+
+<!-- README_GPTQ.md-compatibility start -->
+## Compatibility
+
+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.
+
+[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 -->
@@ -102,10 +228,12 @@ For further support, and discussions on these models and AI in general, join us
 
 [TheBloke AI's Discord server](https://discord.gg/theblokeai)
 
-## Thanks, and how to contribute.
+## Thanks, and how to contribute
 
 Thanks to the [chirper.ai](https://chirper.ai) team!
 
+Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
+
 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.
@@ -117,7 +245,7 @@ Donaters will get priority support on any and all AI/LLM/model questions and req
 
 **Special thanks to**: Aemon Algiz.
 
-**Patreon special mentions**: Sam, theTransient, Jonathan Leane, Steven Wood, webtim, Johann-Peter Hartmann, Geoffrey Montalvo, Gabriel Tamborski, Willem Michiel, John Villwock, Derek Yates, Mesiah Bishop, Eugene Pentland, Pieter, Chadd, Stephen Murray, Daniel P. Andersen, terasurfer, Brandon Frisco, Thomas Belote, Sid, Nathan LeClaire, Magnesian, Alps Aficionado, Stanislav Ovsiannikov, Alex, Joseph William Delisle, Nikolai Manek, Michael Davis, Junyu Yang, K, J, Spencer Kim, Stefan Sabev, Olusegun Samson, transmissions 11, Michael Levine, Cory Kujawski, Rainer Wilmers, zynix, Kalila, Luke @flexchar, Ajan Kanaga, Mandus, vamX, Ai Maven, Mano Prime, Matthew Berman, subjectnull, Vitor Caleffi, Clay Pascal, biorpg, alfie_i, 阿明, Jeffrey Morgan, ya boyyy, Raymond Fosdick, knownsqashed, Olakabola, Leonard Tan, ReadyPlayerEmma, Enrico Ros, Dave, Talal Aujan, Illia Dulskyi, Sean Connelly, senxiiz, Artur Olbinski, Elle, Raven Klaugh, Fen Risland, Deep Realms, Imad Khwaja, Fred von Graf, Will Dee, usrbinkat, SuperWojo, Alexandros Triantafyllidis, Swaroop Kallakuri, Dan Guido, John Detwiler, Pedro Madruga, Iucharbius, Viktor Bowallius, Asp the Wyvern, Edmond Seymore, Trenton Dambrowitz, Space Cruiser, Spiking Neurons AB, Pyrater, LangChain4j, Tony Hughes, Kacper Wikieł, Rishabh Srivastava, David Ziegler, Luke Pendergrass, Andrey, Gabriel Puliatti, Lone Striker, Sebastain Graf, Pierre Kircher, Randy H, NimbleBox.ai, Vadim, danny, Deo Leter
+**Patreon special mentions**: Alicia Loh, Stephen Murray, K, Ajan Kanaga, RoA, Magnesian, Deo Leter, Olakabola, Eugene Pentland, zynix, Deep Realms, Raymond Fosdick, Elijah Stavena, Iucharbius, Erik Bjäreholt, Luis Javier Navarrete Lozano, Nicholas, theTransient, John Detwiler, alfie_i, knownsqashed, Mano Prime, Willem Michiel, Enrico Ros, LangChain4j, OG, Michael Dempsey, Pierre Kircher, Pedro Madruga, James Bentley, Thomas Belote, Luke @flexchar, Leonard Tan, Johann-Peter Hartmann, Illia Dulskyi, Fen Risland, Chadd, S_X, Jeff Scroggin, Ken Nordquist, Sean Connelly, Artur Olbinski, Swaroop Kallakuri, Jack West, Ai Maven, David Ziegler, Russ Johnson, transmissions 11, John Villwock, Alps Aficionado, Clay Pascal, Viktor Bowallius, Subspace Studios, Rainer Wilmers, Trenton Dambrowitz, vamX, Michael Levine, 준교 김, Brandon Frisco, Kalila, Trailburnt, Randy H, Talal Aujan, Nathan Dryer, Vadim, 阿明, ReadyPlayerEmma, Tiffany J. Kim, George Stoitzev, Spencer Kim, Jerry Meng, Gabriel Tamborski, Cory Kujawski, Jeffrey Morgan, Spiking Neurons AB, Edmond Seymore, Alexandros Triantafyllidis, Lone Striker, Cap'n Zoog, Nikolai Manek, danny, ya boyyy, Derek Yates, usrbinkat, Mandus, TL, Nathan LeClaire, subjectnull, Imad Khwaja, webtim, Raven Klaugh, Asp the Wyvern, Gabriel Puliatti, Caitlyn Gatomon, Joseph William Delisle, Jonathan Leane, Luke Pendergrass, SuperWojo, Sebastain Graf, Will Dee, Fred von Graf, Andrey, Dan Guido, Daniel P. Andersen, Nitin Borwankar, Elle, Vitor Caleffi, biorpg, jjj, NimbleBox.ai, Pieter, Matthew Berman, terasurfer, Michael Davis, Alex, Stanislav Ovsiannikov
 
 
 Thank you to all my generous patrons and donaters!
@@ -125,15 +253,17 @@ Thank you to all my generous patrons and donaters!
 And thank you again to a16z for their generous grant.
 
 <!-- footer end -->
-# Original model card
+
+# Original model card: Eric Hartford's Wizard Vicuna 13B Uncensored
+
 
 This is [wizard-vicuna-13b](https://huggingface.co/junelee/wizard-vicuna-13b) trained with a subset of the dataset - responses that contained alignment / moralizing were removed. The intent is to train a WizardLM that doesn't have alignment built-in, so that alignment (of any sort) can be added separately with for example with a RLHF LoRA.
 
 Shout out to the open source AI/ML community, and everyone who helped me out.
 
-Note:
+Note:  
 
-An uncensored model has no guardrails.
+An uncensored model has no guardrails.  
 
 You are responsible for anything you do with the model, just as you are responsible for anything you do with any dangerous object such as a knife, gun, lighter, or car.