TheBloke commited on
Commit
f26f988
1 Parent(s): 986e080

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +175 -73
README.md CHANGED
@@ -1,12 +1,18 @@
1
  ---
 
2
  datasets:
3
  - gozfarb/ShareGPT_Vicuna_unfiltered
4
- - Aeala/ShareGPT_Vicuna_unfiltered
5
  inference: false
6
  license: other
 
 
7
  model_type: llama
8
- tags:
9
- - uncensored
 
 
 
 
10
  ---
11
 
12
  <!-- header start -->
@@ -26,152 +32,194 @@ tags:
26
  <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
27
  <!-- header end -->
28
 
29
- # VicUnlocked-30B-LoRA GPTQ
 
 
30
 
31
- These files are GPTQ model files for [VicUnlocked-30B-LoRA](https://huggingface.co/Neko-Institute-of-Science/VicUnLocked-30b-LoRA).
 
32
 
33
- 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.
34
 
35
- These models were quantised using hardware kindly provided by [Latitude.sh](https://www.latitude.sh/accelerate).
36
 
 
 
37
  ## Repositories available
38
 
 
39
  * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/VicUnlocked-30B-LoRA-GPTQ)
40
- * [2, 3, 4, 5, 6 and 8-bit GGML models for CPU+GPU inference](https://huggingface.co/TheBloke/VicUnlocked-30B-LoRA-GGML)
41
- * [Unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/TheBloke/VicUnlocked-30B-LoRA-HF)
 
42
 
43
- ## Prompt template: Alpaca
 
44
 
45
  ```
46
- Below is an instruction that describes a task. Write a response that appropriately completes the request.
47
-
48
- ### Instruction: {prompt}
49
 
50
- ### Response:
51
  ```
52
 
53
- ## Provided files
 
 
 
 
 
 
 
 
 
 
 
54
 
55
  Multiple quantisation parameters are provided, to allow you to choose the best one for your hardware and requirements.
56
 
57
  Each separate quant is in a different branch. See below for instructions on fetching from different branches.
58
 
59
- | Branch | Bits | Group Size | Act Order (desc_act) | File Size | ExLlama Compatible? | Made With | Description |
60
- | ------ | ---- | ---------- | -------------------- | --------- | ------------------- | --------- | ----------- |
61
- | 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. |
62
- | 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. |
63
- | 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. |
64
- | 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. |
65
- | 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. |
66
- | 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. |
67
- | 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. |
68
- | 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. |
69
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
70
  ## How to download from branches
71
 
72
- - In text-generation-webui, you can add `:branch` to the end of the download name, eg `TheBloke/VicUnlocked-30B-LoRA-GPTQ:gptq-4bit-32g-actorder_True`
73
  - With Git, you can clone a branch with:
74
  ```
75
- git clone --branch gptq-4bit-32g-actorder_True https://huggingface.co/TheBloke/VicUnlocked-30B-LoRA-GPTQ`
76
  ```
77
  - In Python Transformers code, the branch is the `revision` parameter; see below.
78
-
 
79
  ## How to easily download and use this model in [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
80
 
81
  Please make sure you're using the latest version of [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
82
 
83
- It is strongly recommended to use the text-generation-webui one-click-installers unless you know how to make a manual install.
84
 
85
  1. Click the **Model tab**.
86
  2. Under **Download custom model or LoRA**, enter `TheBloke/VicUnlocked-30B-LoRA-GPTQ`.
87
- - To download from a specific branch, enter for example `TheBloke/VicUnlocked-30B-LoRA-GPTQ:gptq-4bit-32g-actorder_True`
88
  - see Provided Files above for the list of branches for each option.
89
  3. Click **Download**.
90
- 4. The model will start downloading. Once it's finished it will say "Done"
91
  5. In the top left, click the refresh icon next to **Model**.
92
  6. In the **Model** dropdown, choose the model you just downloaded: `VicUnlocked-30B-LoRA-GPTQ`
93
  7. The model will automatically load, and is now ready for use!
94
  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.
95
- * Note that you do not need to set GPTQ parameters any more. These are set automatically from the file `quantize_config.json`.
96
  9. Once you're ready, click the **Text Generation tab** and enter a prompt to get started!
 
97
 
 
98
  ## How to use this GPTQ model from Python code
99
 
100
- First make sure you have [AutoGPTQ](https://github.com/PanQiWei/AutoGPTQ) installed:
101
 
102
- `GITHUB_ACTIONS=true pip install auto-gptq`
103
 
104
- Then try the following example code:
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
105
 
106
  ```python
107
- from transformers import AutoTokenizer, pipeline, logging
108
- from auto_gptq import AutoGPTQForCausalLM, BaseQuantizeConfig
109
 
110
  model_name_or_path = "TheBloke/VicUnlocked-30B-LoRA-GPTQ"
111
- model_basename = "VicUnlocked-30B-GPTQ-4bit--1g.act.order"
112
-
113
- use_triton = False
 
 
 
114
 
115
  tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, use_fast=True)
116
 
117
- model = AutoGPTQForCausalLM.from_quantized(model_name_or_path,
118
- model_basename=model_basename
119
- use_safetensors=True,
120
- trust_remote_code=False,
121
- device="cuda:0",
122
- use_triton=use_triton,
123
- quantize_config=None)
124
-
125
- """
126
- To download from a specific branch, use the revision parameter, as in this example:
127
-
128
- model = AutoGPTQForCausalLM.from_quantized(model_name_or_path,
129
- revision="gptq-4bit-32g-actorder_True",
130
- model_basename=model_basename,
131
- use_safetensors=True,
132
- trust_remote_code=False,
133
- device="cuda:0",
134
- quantize_config=None)
135
- """
136
-
137
  prompt = "Tell me about AI"
138
- prompt_template=f'''Below is an instruction that describes a task. Write a response that appropriately completes the request.
139
-
140
- ### Instruction: {prompt}
141
 
142
- ### Response:
143
  '''
144
 
145
  print("\n\n*** Generate:")
146
 
147
  input_ids = tokenizer(prompt_template, return_tensors='pt').input_ids.cuda()
148
- output = model.generate(inputs=input_ids, temperature=0.7, max_new_tokens=512)
149
  print(tokenizer.decode(output[0]))
150
 
151
  # Inference can also be done using transformers' pipeline
152
 
153
- # Prevent printing spurious transformers error when using pipeline with AutoGPTQ
154
- logging.set_verbosity(logging.CRITICAL)
155
-
156
  print("*** Pipeline:")
157
  pipe = pipeline(
158
  "text-generation",
159
  model=model,
160
  tokenizer=tokenizer,
161
  max_new_tokens=512,
 
162
  temperature=0.7,
163
  top_p=0.95,
164
- repetition_penalty=1.15
 
165
  )
166
 
167
  print(pipe(prompt_template)[0]['generated_text'])
168
  ```
 
169
 
 
170
  ## Compatibility
171
 
172
- 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.
 
 
173
 
174
- ExLlama works with Llama models in 4-bit. Please see the Provided Files table above for per-file compatibility.
 
175
 
176
  <!-- footer start -->
177
  <!-- 200823 -->
@@ -181,10 +229,12 @@ For further support, and discussions on these models and AI in general, join us
181
 
182
  [TheBloke AI's Discord server](https://discord.gg/theblokeai)
183
 
184
- ## Thanks, and how to contribute.
185
 
186
  Thanks to the [chirper.ai](https://chirper.ai) team!
187
 
 
 
188
  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.
189
 
190
  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.
@@ -196,7 +246,7 @@ Donaters will get priority support on any and all AI/LLM/model questions and req
196
 
197
  **Special thanks to**: Aemon Algiz.
198
 
199
- **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
200
 
201
 
202
  Thank you to all my generous patrons and donaters!
@@ -207,6 +257,58 @@ And thank you again to a16z for their generous grant.
207
 
208
  # Original model card: VicUnlocked-30B-LoRA
209
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
210
  # Convert tools
211
  https://github.com/practicaldreamer/vicuna_to_alpaca
212
 
 
1
  ---
2
+ base_model: https://huggingface.co/Neko-Institute-of-Science/VicUnLocked-30b-LoRA
3
  datasets:
4
  - gozfarb/ShareGPT_Vicuna_unfiltered
 
5
  inference: false
6
  license: other
7
+ model_creator: Bonanza Unthread
8
+ model_name: Vicunlocked 30B Lora
9
  model_type: llama
10
+ prompt_template: 'A chat between a curious user and an artificial intelligence assistant.
11
+ The assistant gives helpful, detailed, and polite answers to the user''s questions.
12
+ USER: {prompt} ASSISTANT:
13
+
14
+ '
15
+ quantized_by: TheBloke
16
  ---
17
 
18
  <!-- header start -->
 
32
  <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
33
  <!-- header end -->
34
 
35
+ # Vicunlocked 30B Lora - GPTQ
36
+ - Model creator: [Bonanza Unthread](https://huggingface.co/Neko-Institute-of-Science)
37
+ - Original model: [Vicunlocked 30B Lora](https://huggingface.co/Neko-Institute-of-Science/VicUnLocked-30b-LoRA)
38
 
39
+ <!-- description start -->
40
+ ## Description
41
 
42
+ This repo contains GPTQ model files for [VicUnlocked-30B-LoRA](https://huggingface.co/Neko-Institute-of-Science/VicUnLocked-30b-LoRA).
43
 
44
+ 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.
45
 
46
+ <!-- description end -->
47
+ <!-- repositories-available start -->
48
  ## Repositories available
49
 
50
+ * [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/VicUnlocked-30B-LoRA-AWQ)
51
  * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/VicUnlocked-30B-LoRA-GPTQ)
52
+ * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/VicUnlocked-30B-LoRA-GGUF)
53
+ * [Bonanza Unthread's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/TheBloke/VicUnlocked-30B-LoRA-HF)
54
+ <!-- repositories-available end -->
55
 
56
+ <!-- prompt-template start -->
57
+ ## Prompt template: Vicuna
58
 
59
  ```
60
+ 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:
 
 
61
 
 
62
  ```
63
 
64
+ <!-- prompt-template end -->
65
+ <!-- licensing start -->
66
+ ## Licensing
67
+
68
+ The creator of the source model has listed its license as `other`, and this quantization has therefore used that same license.
69
+
70
+ 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.
71
+
72
+ In the meantime, any questions regarding licensing, and in particular how these two licenses might interact, should be directed to the original model repository: [VicUnlocked-30B-LoRA](https://huggingface.co/Neko-Institute-of-Science/VicUnLocked-30b-LoRA).
73
+ <!-- licensing end -->
74
+ <!-- README_GPTQ.md-provided-files start -->
75
+ ## Provided files and GPTQ parameters
76
 
77
  Multiple quantisation parameters are provided, to allow you to choose the best one for your hardware and requirements.
78
 
79
  Each separate quant is in a different branch. See below for instructions on fetching from different branches.
80
 
81
+ 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.
82
+
83
+ <details>
84
+ <summary>Explanation of GPTQ parameters</summary>
 
 
 
 
 
 
85
 
86
+ - Bits: The bit size of the quantised model.
87
+ - GS: GPTQ group size. Higher numbers use less VRAM, but have lower quantisation accuracy. "None" is the lowest possible value.
88
+ - 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.
89
+ - Damp %: A GPTQ parameter that affects how samples are processed for quantisation. 0.01 is default, but 0.1 results in slightly better accuracy.
90
+ - 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).
91
+ - 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.
92
+ - ExLlama Compatibility: Whether this file can be loaded with ExLlama, which currently only supports Llama models in 4-bit.
93
+
94
+ </details>
95
+
96
+ | Branch | Bits | GS | Act Order | Damp % | GPTQ Dataset | Seq Len | Size | ExLlama | Desc |
97
+ | ------ | ---- | -- | --------- | ------ | ------------ | ------- | ---- | ------- | ---- |
98
+ | [main](https://huggingface.co/TheBloke/VicUnlocked-30B-LoRA-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. |
99
+ | [gptq-4bit-32g-actorder_True](https://huggingface.co/TheBloke/VicUnlocked-30B-LoRA-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. |
100
+ | [gptq-4bit-64g-actorder_True](https://huggingface.co/TheBloke/VicUnlocked-30B-LoRA-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. |
101
+ | [gptq-4bit-128g-actorder_True](https://huggingface.co/TheBloke/VicUnlocked-30B-LoRA-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. |
102
+ | [gptq-8bit--1g-actorder_True](https://huggingface.co/TheBloke/VicUnlocked-30B-LoRA-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. |
103
+ | [gptq-8bit-128g-actorder_False](https://huggingface.co/TheBloke/VicUnlocked-30B-LoRA-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. |
104
+ | [gptq-3bit--1g-actorder_True](https://huggingface.co/TheBloke/VicUnlocked-30B-LoRA-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. |
105
+ | [gptq-3bit-128g-actorder_False](https://huggingface.co/TheBloke/VicUnlocked-30B-LoRA-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. |
106
+
107
+ <!-- README_GPTQ.md-provided-files end -->
108
+
109
+ <!-- README_GPTQ.md-download-from-branches start -->
110
  ## How to download from branches
111
 
112
+ - In text-generation-webui, you can add `:branch` to the end of the download name, eg `TheBloke/VicUnlocked-30B-LoRA-GPTQ:main`
113
  - With Git, you can clone a branch with:
114
  ```
115
+ git clone --single-branch --branch main https://huggingface.co/TheBloke/VicUnlocked-30B-LoRA-GPTQ
116
  ```
117
  - In Python Transformers code, the branch is the `revision` parameter; see below.
118
+ <!-- README_GPTQ.md-download-from-branches end -->
119
+ <!-- README_GPTQ.md-text-generation-webui start -->
120
  ## How to easily download and use this model in [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
121
 
122
  Please make sure you're using the latest version of [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
123
 
124
+ 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.
125
 
126
  1. Click the **Model tab**.
127
  2. Under **Download custom model or LoRA**, enter `TheBloke/VicUnlocked-30B-LoRA-GPTQ`.
128
+ - To download from a specific branch, enter for example `TheBloke/VicUnlocked-30B-LoRA-GPTQ:main`
129
  - see Provided Files above for the list of branches for each option.
130
  3. Click **Download**.
131
+ 4. The model will start downloading. Once it's finished it will say "Done".
132
  5. In the top left, click the refresh icon next to **Model**.
133
  6. In the **Model** dropdown, choose the model you just downloaded: `VicUnlocked-30B-LoRA-GPTQ`
134
  7. The model will automatically load, and is now ready for use!
135
  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.
136
+ * 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`.
137
  9. Once you're ready, click the **Text Generation tab** and enter a prompt to get started!
138
+ <!-- README_GPTQ.md-text-generation-webui end -->
139
 
140
+ <!-- README_GPTQ.md-use-from-python start -->
141
  ## How to use this GPTQ model from Python code
142
 
143
+ ### Install the necessary packages
144
 
145
+ Requires: Transformers 4.32.0 or later, Optimum 1.12.0 or later, and AutoGPTQ 0.4.2 or later.
146
 
147
+ ```shell
148
+ pip3 install transformers>=4.32.0 optimum>=1.12.0
149
+ pip3 install auto-gptq --extra-index-url https://huggingface.github.io/autogptq-index/whl/cu118/ # Use cu117 if on CUDA 11.7
150
+ ```
151
+
152
+ If you have problems installing AutoGPTQ using the pre-built wheels, install it from source instead:
153
+
154
+ ```shell
155
+ pip3 uninstall -y auto-gptq
156
+ git clone https://github.com/PanQiWei/AutoGPTQ
157
+ cd AutoGPTQ
158
+ pip3 install .
159
+ ```
160
+
161
+ ### For CodeLlama models only: you must use Transformers 4.33.0 or later.
162
+
163
+ If 4.33.0 is not yet released when you read this, you will need to install Transformers from source:
164
+ ```shell
165
+ pip3 uninstall -y transformers
166
+ pip3 install git+https://github.com/huggingface/transformers.git
167
+ ```
168
+
169
+ ### You can then use the following code
170
 
171
  ```python
172
+ from transformers import AutoModelForCausalLM, AutoTokenizer, pipeline
 
173
 
174
  model_name_or_path = "TheBloke/VicUnlocked-30B-LoRA-GPTQ"
175
+ # To use a different branch, change revision
176
+ # For example: revision="main"
177
+ model = AutoModelForCausalLM.from_pretrained(model_name_or_path,
178
+ device_map="auto",
179
+ trust_remote_code=False,
180
+ revision="main")
181
 
182
  tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, use_fast=True)
183
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
184
  prompt = "Tell me about AI"
185
+ 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:
 
 
186
 
 
187
  '''
188
 
189
  print("\n\n*** Generate:")
190
 
191
  input_ids = tokenizer(prompt_template, return_tensors='pt').input_ids.cuda()
192
+ output = model.generate(inputs=input_ids, temperature=0.7, do_sample=True, top_p=0.95, top_k=40, max_new_tokens=512)
193
  print(tokenizer.decode(output[0]))
194
 
195
  # Inference can also be done using transformers' pipeline
196
 
 
 
 
197
  print("*** Pipeline:")
198
  pipe = pipeline(
199
  "text-generation",
200
  model=model,
201
  tokenizer=tokenizer,
202
  max_new_tokens=512,
203
+ do_sample=True,
204
  temperature=0.7,
205
  top_p=0.95,
206
+ top_k=40,
207
+ repetition_penalty=1.1
208
  )
209
 
210
  print(pipe(prompt_template)[0]['generated_text'])
211
  ```
212
+ <!-- README_GPTQ.md-use-from-python end -->
213
 
214
+ <!-- README_GPTQ.md-compatibility start -->
215
  ## Compatibility
216
 
217
+ 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).
218
+
219
+ [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.
220
 
221
+ [Huggingface Text Generation Inference (TGI)](https://github.com/huggingface/text-generation-inference) is compatible with all GPTQ models.
222
+ <!-- README_GPTQ.md-compatibility end -->
223
 
224
  <!-- footer start -->
225
  <!-- 200823 -->
 
229
 
230
  [TheBloke AI's Discord server](https://discord.gg/theblokeai)
231
 
232
+ ## Thanks, and how to contribute
233
 
234
  Thanks to the [chirper.ai](https://chirper.ai) team!
235
 
236
+ Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
237
+
238
  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.
239
 
240
  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.
 
246
 
247
  **Special thanks to**: Aemon Algiz.
248
 
249
+ **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
250
 
251
 
252
  Thank you to all my generous patrons and donaters!
 
257
 
258
  # Original model card: VicUnlocked-30B-LoRA
259
 
260
+ <!-- header start -->
261
+ <div style="width: 100%;">
262
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
263
+ </div>
264
+ <div style="display: flex; justify-content: space-between; width: 100%;">
265
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
266
+ <p><a href="https://discord.gg/Jq4vkcDakD">Chat & support: my new Discord server</a></p>
267
+ </div>
268
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
269
+ <p><a href="https://www.patreon.com/TheBlokeAI">Want to contribute? TheBloke's Patreon page</a></p>
270
+ </div>
271
+ </div>
272
+ <!-- header end -->
273
+
274
+ # VicUnlocked-30B-LoRA GPTQ
275
+
276
+ This is an HF format float16 repo of [Neko Institute of Science's VicUnLocked 30B LoRA](https://huggingface.co/Neko-Institute-of-Science/VicUnLocked-30b-LoRA).
277
+
278
+ It is the result merging the above LoRA with the original LLaMA 30B.
279
+
280
+ ## Repositories available
281
+
282
+ * [4-bit, 5-bit and 8-bit GGML models for CPU (+CUDA) inference](https://huggingface.co/TheBloke/VicUnlocked-30B-LoRA-GGML).
283
+ * [4-bit GPTQ model for GPU inference](https://huggingface.co/TheBloke/VicUnlocked-30B-LoRA-GPTQ).
284
+ * [float16 HF format model for GPU inference and further conversions](https://huggingface.co/TheBloke/VicUnlocked-30B-LoRA-HF).
285
+
286
+ <!-- footer start -->
287
+ ## Discord
288
+
289
+ For further support, and discussions on these models and AI in general, join us at:
290
+
291
+ [TheBloke AI's Discord server](https://discord.gg/Jq4vkcDakD)
292
+
293
+ ## Thanks, and how to contribute.
294
+
295
+ Thanks to the [chirper.ai](https://chirper.ai) team!
296
+
297
+ 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.
298
+
299
+ 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.
300
+
301
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
302
+
303
+ * Patreon: https://patreon.com/TheBlokeAI
304
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
305
+
306
+ **Patreon special mentions**: Aemon Algiz, Dmitriy Samsonov, Nathan LeClaire, Trenton Dambrowitz, Mano Prime, David Flickinger, vamX, Nikolai Manek, senxiiz, Khalefa Al-Ahmad, Illia Dulskyi, Jonathan Leane, Talal Aujan, V. Lukas, Joseph William Delisle, Pyrater, Oscar Rangel, Lone Striker, Luke Pendergrass, Eugene Pentland, Sebastain Graf, Johann-Peter Hartman.
307
+
308
+ Thank you to all my generous patrons and donaters!
309
+ <!-- footer end -->
310
+ # Original model card
311
+
312
  # Convert tools
313
  https://github.com/practicaldreamer/vicuna_to_alpaca
314