TheBloke commited on
Commit
fd8741f
1 Parent(s): 85b7b49

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +122 -67
README.md CHANGED
@@ -1,11 +1,20 @@
1
  ---
 
2
  datasets:
3
  - ehartford/WizardLM_evol_instruct_V2_196k_unfiltered_merged_split
4
  inference: false
5
  language:
6
  - en
7
  license: other
 
 
8
  model_type: llama
 
 
 
 
 
 
9
  ---
10
 
11
  <!-- header start -->
@@ -25,150 +34,194 @@ model_type: llama
25
  <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
26
  <!-- header end -->
27
 
28
- # Eric Hartford's WizardLM 33B V1.0 Uncensored GPTQ
 
 
29
 
30
- These files are GPTQ model files for [Eric Hartford's WizardLM 33B V1.0 Uncensored](https://huggingface.co/ehartford/WizardLM-33b-V1.0-Uncensored).
 
31
 
32
- 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.
33
 
34
- These models were quantised using hardware kindly provided by [Latitude.sh](https://www.latitude.sh/accelerate).
35
 
 
 
36
  ## Repositories available
37
 
 
38
  * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/WizardLM-33B-V1.0-Uncensored-GPTQ)
39
- * [2, 3, 4, 5, 6 and 8-bit GGML models for CPU+GPU inference](https://huggingface.co/TheBloke/WizardLM-33B-V1.0-Uncensored-GGML)
40
- * [Unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/ehartford/WizardLM-33b-V1.0-Uncensored)
 
41
 
 
42
  ## Prompt template: Vicuna
43
 
44
  ```
45
- A chat between a curious user and an artificial intelligence assistant. The assistant gives helpful, detailed, and polite answers to the user's questions.
46
 
47
- USER: {prompt}
48
- ASSISTANT:
49
  ```
50
 
51
- ## Provided files
 
 
 
 
 
 
 
 
 
 
 
52
 
53
  Multiple quantisation parameters are provided, to allow you to choose the best one for your hardware and requirements.
54
 
55
  Each separate quant is in a different branch. See below for instructions on fetching from different branches.
56
 
57
- | Branch | Bits | Group Size | Act Order (desc_act) | File Size | ExLlama Compatible? | Made With | Description |
58
- | ------ | ---- | ---------- | -------------------- | --------- | ------------------- | --------- | ----------- |
59
- | main | 4 | None | True | 16.94 GB | True | GPTQ-for-LLaMa | Most compatible option. Good inference speed in AutoGPTQ and GPTQ-for-LLaMa. Lower inference quality than other options. |
60
- | gptq-4bit-32g-actorder_True | 4 | 32 | True | 19.44 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. |
61
- | gptq-4bit-64g-actorder_True | 4 | 64 | True | 18.18 GB | True | AutoGPTQ | 4-bit, with Act Order and group size. 64g uses less VRAM than 32g, but with slightly lower accuracy. Poor AutoGPTQ CUDA speed. |
62
- | gptq-4bit-128g-actorder_True | 4 | 128 | True | 17.55 GB | True | AutoGPTQ | 4-bit, with Act Order and group size. 128g uses even less VRAM, but with slightly lower accuracy. Poor AutoGPTQ CUDA speed. |
63
- | gptq-8bit--1g-actorder_True | 8 | None | True | 32.99 GB | False | AutoGPTQ | 8-bit, with Act Order. No group size, to lower VRAM requirements and to improve AutoGPTQ speed. |
64
- | gptq-8bit-128g-actorder_False | 8 | 128 | False | 33.73 GB | False | AutoGPTQ | 8-bit, with group size 128g for higher inference quality and without Act Order to improve AutoGPTQ speed. |
65
- | gptq-3bit--1g-actorder_True | 3 | None | True | 12.92 GB | False | AutoGPTQ | 3-bit, with Act Order and no group size. Lowest possible VRAM requirements. May be lower quality than 3-bit 128g. |
66
- | gptq-3bit-128g-actorder_False | 3 | 128 | False | 13.51 GB | False | AutoGPTQ | 3-bit, with group size 128g but no act-order. Slightly higher VRAM requirements than 3-bit None. |
67
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
68
  ## How to download from branches
69
 
70
- - In text-generation-webui, you can add `:branch` to the end of the download name, eg `TheBloke/WizardLM-33B-V1.0-Uncensored-GPTQ:gptq-4bit-32g-actorder_True`
71
  - With Git, you can clone a branch with:
72
  ```
73
- git clone --branch gptq-4bit-32g-actorder_True https://huggingface.co/TheBloke/WizardLM-33B-V1.0-Uncensored-GPTQ`
74
  ```
75
  - In Python Transformers code, the branch is the `revision` parameter; see below.
76
-
 
77
  ## How to easily download and use this model in [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
78
 
79
  Please make sure you're using the latest version of [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
80
 
81
- It is strongly recommended to use the text-generation-webui one-click-installers unless you know how to make a manual install.
82
 
83
  1. Click the **Model tab**.
84
  2. Under **Download custom model or LoRA**, enter `TheBloke/WizardLM-33B-V1.0-Uncensored-GPTQ`.
85
- - To download from a specific branch, enter for example `TheBloke/WizardLM-33B-V1.0-Uncensored-GPTQ:gptq-4bit-32g-actorder_True`
86
  - see Provided Files above for the list of branches for each option.
87
  3. Click **Download**.
88
- 4. The model will start downloading. Once it's finished it will say "Done"
89
  5. In the top left, click the refresh icon next to **Model**.
90
  6. In the **Model** dropdown, choose the model you just downloaded: `WizardLM-33B-V1.0-Uncensored-GPTQ`
91
  7. The model will automatically load, and is now ready for use!
92
  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.
93
- * Note that you do not need to set GPTQ parameters any more. These are set automatically from the file `quantize_config.json`.
94
  9. Once you're ready, click the **Text Generation tab** and enter a prompt to get started!
 
95
 
 
96
  ## How to use this GPTQ model from Python code
97
 
98
- First make sure you have [AutoGPTQ](https://github.com/PanQiWei/AutoGPTQ) installed:
99
 
100
- `GITHUB_ACTIONS=true pip install auto-gptq`
101
 
102
- Then try the following example code:
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
103
 
104
  ```python
105
- from transformers import AutoTokenizer, pipeline, logging
106
- from auto_gptq import AutoGPTQForCausalLM, BaseQuantizeConfig
107
 
108
  model_name_or_path = "TheBloke/WizardLM-33B-V1.0-Uncensored-GPTQ"
109
- model_basename = "wizardlm-33b-v1.0-uncensored-GPTQ-4bit--1g.act.order"
110
-
111
- use_triton = False
 
 
 
112
 
113
  tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, use_fast=True)
114
 
115
- model = AutoGPTQForCausalLM.from_quantized(model_name_or_path,
116
- model_basename=model_basename
117
- use_safetensors=True,
118
- trust_remote_code=False,
119
- device="cuda:0",
120
- use_triton=use_triton,
121
- quantize_config=None)
122
-
123
- """
124
- To download from a specific branch, use the revision parameter, as in this example:
125
-
126
- model = AutoGPTQForCausalLM.from_quantized(model_name_or_path,
127
- revision="gptq-4bit-32g-actorder_True",
128
- model_basename=model_basename,
129
- use_safetensors=True,
130
- trust_remote_code=False,
131
- device="cuda:0",
132
- quantize_config=None)
133
- """
134
-
135
  prompt = "Tell me about AI"
136
- 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.
137
 
138
- USER: {prompt}
139
- ASSISTANT:
140
  '''
141
 
142
  print("\n\n*** Generate:")
143
 
144
  input_ids = tokenizer(prompt_template, return_tensors='pt').input_ids.cuda()
145
- output = model.generate(inputs=input_ids, temperature=0.7, max_new_tokens=512)
146
  print(tokenizer.decode(output[0]))
147
 
148
  # Inference can also be done using transformers' pipeline
149
 
150
- # Prevent printing spurious transformers error when using pipeline with AutoGPTQ
151
- logging.set_verbosity(logging.CRITICAL)
152
-
153
  print("*** Pipeline:")
154
  pipe = pipeline(
155
  "text-generation",
156
  model=model,
157
  tokenizer=tokenizer,
158
  max_new_tokens=512,
 
159
  temperature=0.7,
160
  top_p=0.95,
161
- repetition_penalty=1.15
 
162
  )
163
 
164
  print(pipe(prompt_template)[0]['generated_text'])
165
  ```
 
166
 
 
167
  ## Compatibility
168
 
169
- 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.
 
 
170
 
171
- ExLlama works with Llama models in 4-bit. Please see the Provided Files table above for per-file compatibility.
 
172
 
173
  <!-- footer start -->
174
  <!-- 200823 -->
@@ -178,10 +231,12 @@ For further support, and discussions on these models and AI in general, join us
178
 
179
  [TheBloke AI's Discord server](https://discord.gg/theblokeai)
180
 
181
- ## Thanks, and how to contribute.
182
 
183
  Thanks to the [chirper.ai](https://chirper.ai) team!
184
 
 
 
185
  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.
186
 
187
  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.
@@ -193,7 +248,7 @@ Donaters will get priority support on any and all AI/LLM/model questions and req
193
 
194
  **Special thanks to**: Aemon Algiz.
195
 
196
- **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
197
 
198
 
199
  Thank you to all my generous patrons and donaters!
 
1
  ---
2
+ base_model: https://huggingface.co/ehartford/WizardLM-33b-V1.0-Uncensored
3
  datasets:
4
  - ehartford/WizardLM_evol_instruct_V2_196k_unfiltered_merged_split
5
  inference: false
6
  language:
7
  - en
8
  license: other
9
+ model_creator: Eric Hartford
10
+ model_name: WizardLM 33B V1.0 Uncensored
11
  model_type: llama
12
+ prompt_template: 'A chat between a curious user and an artificial intelligence assistant.
13
+ The assistant gives helpful, detailed, and polite answers to the user''s questions.
14
+ USER: {prompt} ASSISTANT:
15
+
16
+ '
17
+ quantized_by: TheBloke
18
  ---
19
 
20
  <!-- header start -->
 
34
  <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
35
  <!-- header end -->
36
 
37
+ # WizardLM 33B V1.0 Uncensored - GPTQ
38
+ - Model creator: [Eric Hartford](https://huggingface.co/ehartford)
39
+ - Original model: [WizardLM 33B V1.0 Uncensored](https://huggingface.co/ehartford/WizardLM-33b-V1.0-Uncensored)
40
 
41
+ <!-- description start -->
42
+ ## Description
43
 
44
+ This repo contains GPTQ model files for [Eric Hartford's WizardLM 33B V1.0 Uncensored](https://huggingface.co/ehartford/WizardLM-33b-V1.0-Uncensored).
45
 
46
+ 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.
47
 
48
+ <!-- description end -->
49
+ <!-- repositories-available start -->
50
  ## Repositories available
51
 
52
+ * [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/WizardLM-33B-V1.0-Uncensored-AWQ)
53
  * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/WizardLM-33B-V1.0-Uncensored-GPTQ)
54
+ * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/WizardLM-33B-V1.0-Uncensored-GGUF)
55
+ * [Eric Hartford's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/ehartford/WizardLM-33b-V1.0-Uncensored)
56
+ <!-- repositories-available end -->
57
 
58
+ <!-- prompt-template start -->
59
  ## Prompt template: Vicuna
60
 
61
  ```
62
+ 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:
63
 
 
 
64
  ```
65
 
66
+ <!-- prompt-template end -->
67
+ <!-- licensing start -->
68
+ ## Licensing
69
+
70
+ The creator of the source model has listed its license as `other`, and this quantization has therefore used that same license.
71
+
72
+ 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.
73
+
74
+ 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 WizardLM 33B V1.0 Uncensored](https://huggingface.co/ehartford/WizardLM-33b-V1.0-Uncensored).
75
+ <!-- licensing end -->
76
+ <!-- README_GPTQ.md-provided-files start -->
77
+ ## Provided files and GPTQ parameters
78
 
79
  Multiple quantisation parameters are provided, to allow you to choose the best one for your hardware and requirements.
80
 
81
  Each separate quant is in a different branch. See below for instructions on fetching from different branches.
82
 
83
+ 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.
 
 
 
 
 
 
 
 
 
84
 
85
+ <details>
86
+ <summary>Explanation of GPTQ parameters</summary>
87
+
88
+ - Bits: The bit size of the quantised model.
89
+ - GS: GPTQ group size. Higher numbers use less VRAM, but have lower quantisation accuracy. "None" is the lowest possible value.
90
+ - 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.
91
+ - Damp %: A GPTQ parameter that affects how samples are processed for quantisation. 0.01 is default, but 0.1 results in slightly better accuracy.
92
+ - 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).
93
+ - 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.
94
+ - ExLlama Compatibility: Whether this file can be loaded with ExLlama, which currently only supports Llama models in 4-bit.
95
+
96
+ </details>
97
+
98
+ | Branch | Bits | GS | Act Order | Damp % | GPTQ Dataset | Seq Len | Size | ExLlama | Desc |
99
+ | ------ | ---- | -- | --------- | ------ | ------------ | ------- | ---- | ------- | ---- |
100
+ | [main](https://huggingface.co/TheBloke/WizardLM-33B-V1.0-Uncensored-GPTQ/tree/main) | 4 | None | Yes | 0.01 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 2048 | 16.94 GB | Yes | 4-bit, with Act Order. No group size, to lower VRAM requirements. |
101
+ | [gptq-4bit-32g-actorder_True](https://huggingface.co/TheBloke/WizardLM-33B-V1.0-Uncensored-GPTQ/tree/gptq-4bit-32g-actorder_True) | 4 | 32 | Yes | 0.01 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 2048 | 19.44 GB | Yes | 4-bit, with Act Order and group size 32g. Gives highest possible inference quality, with maximum VRAM usage. |
102
+ | [gptq-4bit-64g-actorder_True](https://huggingface.co/TheBloke/WizardLM-33B-V1.0-Uncensored-GPTQ/tree/gptq-4bit-64g-actorder_True) | 4 | 64 | Yes | 0.01 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 2048 | 18.18 GB | Yes | 4-bit, with Act Order and group size 64g. Uses less VRAM than 32g, but with slightly lower accuracy. |
103
+ | [gptq-4bit-128g-actorder_True](https://huggingface.co/TheBloke/WizardLM-33B-V1.0-Uncensored-GPTQ/tree/gptq-4bit-128g-actorder_True) | 4 | 128 | Yes | 0.01 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 2048 | 17.55 GB | Yes | 4-bit, with Act Order and group size 128g. Uses even less VRAM than 64g, but with slightly lower accuracy. |
104
+ | [gptq-8bit--1g-actorder_True](https://huggingface.co/TheBloke/WizardLM-33B-V1.0-Uncensored-GPTQ/tree/gptq-8bit--1g-actorder_True) | 8 | None | Yes | 0.01 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 2048 | 32.99 GB | No | 8-bit, with Act Order. No group size, to lower VRAM requirements. |
105
+ | [gptq-8bit-128g-actorder_False](https://huggingface.co/TheBloke/WizardLM-33B-V1.0-Uncensored-GPTQ/tree/gptq-8bit-128g-actorder_False) | 8 | 128 | No | 0.01 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 2048 | 33.73 GB | No | 8-bit, with group size 128g for higher inference quality and without Act Order to improve AutoGPTQ speed. |
106
+ | [gptq-3bit--1g-actorder_True](https://huggingface.co/TheBloke/WizardLM-33B-V1.0-Uncensored-GPTQ/tree/gptq-3bit--1g-actorder_True) | 3 | None | Yes | 0.01 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 2048 | 12.92 GB | No | 3-bit, with Act Order and no group size. Lowest possible VRAM requirements. May be lower quality than 3-bit 128g. |
107
+ | [gptq-3bit-128g-actorder_False](https://huggingface.co/TheBloke/WizardLM-33B-V1.0-Uncensored-GPTQ/tree/gptq-3bit-128g-actorder_False) | 3 | 128 | No | 0.01 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 2048 | 13.51 GB | No | 3-bit, with group size 128g but no act-order. Slightly higher VRAM requirements than 3-bit None. |
108
+
109
+ <!-- README_GPTQ.md-provided-files end -->
110
+
111
+ <!-- README_GPTQ.md-download-from-branches start -->
112
  ## How to download from branches
113
 
114
+ - In text-generation-webui, you can add `:branch` to the end of the download name, eg `TheBloke/WizardLM-33B-V1.0-Uncensored-GPTQ:main`
115
  - With Git, you can clone a branch with:
116
  ```
117
+ git clone --single-branch --branch main https://huggingface.co/TheBloke/WizardLM-33B-V1.0-Uncensored-GPTQ
118
  ```
119
  - In Python Transformers code, the branch is the `revision` parameter; see below.
120
+ <!-- README_GPTQ.md-download-from-branches end -->
121
+ <!-- README_GPTQ.md-text-generation-webui start -->
122
  ## How to easily download and use this model in [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
123
 
124
  Please make sure you're using the latest version of [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
125
 
126
+ 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.
127
 
128
  1. Click the **Model tab**.
129
  2. Under **Download custom model or LoRA**, enter `TheBloke/WizardLM-33B-V1.0-Uncensored-GPTQ`.
130
+ - To download from a specific branch, enter for example `TheBloke/WizardLM-33B-V1.0-Uncensored-GPTQ:main`
131
  - see Provided Files above for the list of branches for each option.
132
  3. Click **Download**.
133
+ 4. The model will start downloading. Once it's finished it will say "Done".
134
  5. In the top left, click the refresh icon next to **Model**.
135
  6. In the **Model** dropdown, choose the model you just downloaded: `WizardLM-33B-V1.0-Uncensored-GPTQ`
136
  7. The model will automatically load, and is now ready for use!
137
  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.
138
+ * 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`.
139
  9. Once you're ready, click the **Text Generation tab** and enter a prompt to get started!
140
+ <!-- README_GPTQ.md-text-generation-webui end -->
141
 
142
+ <!-- README_GPTQ.md-use-from-python start -->
143
  ## How to use this GPTQ model from Python code
144
 
145
+ ### Install the necessary packages
146
 
147
+ Requires: Transformers 4.32.0 or later, Optimum 1.12.0 or later, and AutoGPTQ 0.4.2 or later.
148
 
149
+ ```shell
150
+ pip3 install transformers>=4.32.0 optimum>=1.12.0
151
+ pip3 install auto-gptq --extra-index-url https://huggingface.github.io/autogptq-index/whl/cu118/ # Use cu117 if on CUDA 11.7
152
+ ```
153
+
154
+ If you have problems installing AutoGPTQ using the pre-built wheels, install it from source instead:
155
+
156
+ ```shell
157
+ pip3 uninstall -y auto-gptq
158
+ git clone https://github.com/PanQiWei/AutoGPTQ
159
+ cd AutoGPTQ
160
+ pip3 install .
161
+ ```
162
+
163
+ ### For CodeLlama models only: you must use Transformers 4.33.0 or later.
164
+
165
+ If 4.33.0 is not yet released when you read this, you will need to install Transformers from source:
166
+ ```shell
167
+ pip3 uninstall -y transformers
168
+ pip3 install git+https://github.com/huggingface/transformers.git
169
+ ```
170
+
171
+ ### You can then use the following code
172
 
173
  ```python
174
+ from transformers import AutoModelForCausalLM, AutoTokenizer, pipeline
 
175
 
176
  model_name_or_path = "TheBloke/WizardLM-33B-V1.0-Uncensored-GPTQ"
177
+ # To use a different branch, change revision
178
+ # For example: revision="main"
179
+ model = AutoModelForCausalLM.from_pretrained(model_name_or_path,
180
+ device_map="auto",
181
+ trust_remote_code=False,
182
+ revision="main")
183
 
184
  tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, use_fast=True)
185
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
186
  prompt = "Tell me about AI"
187
+ 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:
188
 
 
 
189
  '''
190
 
191
  print("\n\n*** Generate:")
192
 
193
  input_ids = tokenizer(prompt_template, return_tensors='pt').input_ids.cuda()
194
+ output = model.generate(inputs=input_ids, temperature=0.7, do_sample=True, top_p=0.95, top_k=40, max_new_tokens=512)
195
  print(tokenizer.decode(output[0]))
196
 
197
  # Inference can also be done using transformers' pipeline
198
 
 
 
 
199
  print("*** Pipeline:")
200
  pipe = pipeline(
201
  "text-generation",
202
  model=model,
203
  tokenizer=tokenizer,
204
  max_new_tokens=512,
205
+ do_sample=True,
206
  temperature=0.7,
207
  top_p=0.95,
208
+ top_k=40,
209
+ repetition_penalty=1.1
210
  )
211
 
212
  print(pipe(prompt_template)[0]['generated_text'])
213
  ```
214
+ <!-- README_GPTQ.md-use-from-python end -->
215
 
216
+ <!-- README_GPTQ.md-compatibility start -->
217
  ## Compatibility
218
 
219
+ 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).
220
+
221
+ [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.
222
 
223
+ [Huggingface Text Generation Inference (TGI)](https://github.com/huggingface/text-generation-inference) is compatible with all GPTQ models.
224
+ <!-- README_GPTQ.md-compatibility end -->
225
 
226
  <!-- footer start -->
227
  <!-- 200823 -->
 
231
 
232
  [TheBloke AI's Discord server](https://discord.gg/theblokeai)
233
 
234
+ ## Thanks, and how to contribute
235
 
236
  Thanks to the [chirper.ai](https://chirper.ai) team!
237
 
238
+ Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
239
+
240
  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.
241
 
242
  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.
 
248
 
249
  **Special thanks to**: Aemon Algiz.
250
 
251
+ **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
252
 
253
 
254
  Thank you to all my generous patrons and donaters!