TheBloke commited on
Commit
bb14ed0
1 Parent(s): e0bf64e

Initial GPTQ model commit

Browse files
Files changed (1) hide show
  1. README.md +266 -0
README.md ADDED
@@ -0,0 +1,266 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ datasets:
3
+ - totally-not-an-llm/EverythingLM-data
4
+ inference: false
5
+ license: other
6
+ model_creator: Kai Howard
7
+ model_link: https://huggingface.co/totally-not-an-llm/EverythingLM-13b-16k
8
+ model_name: EverythingLM 13B 16K
9
+ model_type: llama
10
+ quantized_by: TheBloke
11
+ ---
12
+
13
+ <!-- header start -->
14
+ <div style="width: 100%;">
15
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
16
+ </div>
17
+ <div style="display: flex; justify-content: space-between; width: 100%;">
18
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
19
+ <p><a href="https://discord.gg/theblokeai">Chat & support: my new Discord server</a></p>
20
+ </div>
21
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
22
+ <p><a href="https://www.patreon.com/TheBlokeAI">Want to contribute? TheBloke's Patreon page</a></p>
23
+ </div>
24
+ </div>
25
+ <!-- header end -->
26
+
27
+ # EverythingLM 13B 16K - GPTQ
28
+ - Model creator: [Kai Howard](https://huggingface.co/totally-not-an-llm)
29
+ - Original model: [EverythingLM 13B 16K](https://huggingface.co/totally-not-an-llm/EverythingLM-13b-16k)
30
+
31
+ ## Description
32
+
33
+ This repo contains GPTQ model files for [Kai Howard's EverythingLM 13B 16K](https://huggingface.co/totally-not-an-llm/EverythingLM-13b-16k).
34
+
35
+ 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.
36
+
37
+ ## Repositories available
38
+
39
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/EverythingLM-13B-16K-GPTQ)
40
+ * [2, 3, 4, 5, 6 and 8-bit GGML models for CPU+GPU inference](https://huggingface.co/TheBloke/EverythingLM-13B-16K-GGML)
41
+ * [Kai Howard's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/totally-not-an-llm/EverythingLM-13b-16k)
42
+
43
+ ## Prompt template: Vicuna-Short
44
+
45
+ ```
46
+ You are a helpful AI assistant.
47
+
48
+ USER: {prompt}
49
+ ASSISTANT:
50
+ ```
51
+
52
+ ## Provided files and GPTQ parameters
53
+
54
+ Multiple quantisation parameters are provided, to allow you to choose the best one for your hardware and requirements.
55
+
56
+ Each separate quant is in a different branch. See below for instructions on fetching from different branches.
57
+
58
+ All GPTQ files are made with AutoGPTQ.
59
+
60
+ <details>
61
+ <summary>Explanation of GPTQ parameters</summary>
62
+
63
+ - Bits: The bit size of the quantised model.
64
+ - GS: GPTQ group size. Higher numbers use less VRAM, but have lower quantisation accuracy. "None" is the lowest possible value.
65
+ - 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.
66
+ - Damp %: A GPTQ parameter that affects how samples are processed for quantisation. 0.01 is default, but 0.1 results in slightly better accuracy.
67
+ - 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).
68
+ - 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.
69
+ - ExLlama Compatibility: Whether this file can be loaded with ExLlama, which currently only supports Llama models in 4-bit.
70
+
71
+ </details>
72
+
73
+ | Branch | Bits | GS | Act Order | Damp % | GPTQ Dataset | Seq Len | Size | ExLlama | Desc |
74
+ | ------ | ---- | -- | --------- | ------ | ------------ | ------- | ---- | ------- | ---- |
75
+ | [main](https://huggingface.co/TheBloke/EverythingLM-13B-16K-GPTQ/tree/main) | 4 | 128 | No | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 8192 | 7.26 GB | Yes | Most compatible option. Good inference speed in AutoGPTQ and GPTQ-for-LLaMa. Lower inference quality than other options. |
76
+ | [gptq-4bit-32g-actorder_True](https://huggingface.co/TheBloke/EverythingLM-13B-16K-GPTQ/tree/gptq-4bit-32g-actorder_True) | 4 | 32 | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 8192 | 8.00 GB | Yes | 4-bit, with Act Order and group size 32g. Gives highest possible inference quality, with maximum VRAM usage. Poor AutoGPTQ CUDA speed. |
77
+ | [gptq-4bit-64g-actorder_True](https://huggingface.co/TheBloke/EverythingLM-13B-16K-GPTQ/tree/gptq-4bit-64g-actorder_True) | 4 | 64 | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 8192 | 7.51 GB | Yes | 4-bit, with Act Order and group size 64g. Uses less VRAM than 32g, but with slightly lower accuracy. Poor AutoGPTQ CUDA speed. |
78
+ | [gptq-4bit-128g-actorder_True](https://huggingface.co/TheBloke/EverythingLM-13B-16K-GPTQ/tree/gptq-4bit-128g-actorder_True) | 4 | 128 | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 8192 | 7.26 GB | Yes | 4-bit, with Act Order and group size 128g. Uses even less VRAM than 64g, but with slightly lower accuracy. Poor AutoGPTQ CUDA speed. |
79
+ | [gptq-8bit--1g-actorder_True](https://huggingface.co/TheBloke/EverythingLM-13B-16K-GPTQ/tree/gptq-8bit--1g-actorder_True) | 8 | None | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 8192 | 13.36 GB | No | 8-bit, with Act Order. No group size, to lower VRAM requirements and to improve AutoGPTQ speed. |
80
+ | [gptq-8bit-128g-actorder_True](https://huggingface.co/TheBloke/EverythingLM-13B-16K-GPTQ/tree/gptq-8bit-128g-actorder_True) | 8 | 128 | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 8192 | 13.65 GB | No | 8-bit, with group size 128g for higher inference quality and with Act Order for even higher accuracy. Poor AutoGPTQ CUDA speed. |
81
+
82
+ ## How to download from branches
83
+
84
+ - In text-generation-webui, you can add `:branch` to the end of the download name, eg `TheBloke/EverythingLM-13B-16K-GPTQ:gptq-4bit-32g-actorder_True`
85
+ - With Git, you can clone a branch with:
86
+ ```
87
+ git clone --single-branch --branch gptq-4bit-32g-actorder_True https://huggingface.co/TheBloke/EverythingLM-13B-16K-GPTQ
88
+ ```
89
+ - In Python Transformers code, the branch is the `revision` parameter; see below.
90
+
91
+ ## How to easily download and use this model in [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
92
+
93
+ Please make sure you're using the latest version of [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
94
+
95
+ It is strongly recommended to use the text-generation-webui one-click-installers unless you know how to make a manual install.
96
+
97
+ 1. Click the **Model tab**.
98
+ 2. Under **Download custom model or LoRA**, enter `TheBloke/EverythingLM-13B-16K-GPTQ`.
99
+ - To download from a specific branch, enter for example `TheBloke/EverythingLM-13B-16K-GPTQ:gptq-4bit-32g-actorder_True`
100
+ - see Provided Files above for the list of branches for each option.
101
+ 3. Click **Download**.
102
+ 4. The model will start downloading. Once it's finished it will say "Done"
103
+ 5. In the top left, click the refresh icon next to **Model**.
104
+ 6. In the **Model** dropdown, choose the model you just downloaded: `EverythingLM-13B-16K-GPTQ`
105
+ 7. The model will automatically load, and is now ready for use!
106
+ 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.
107
+ * Note that you do not need to set GPTQ parameters any more. These are set automatically from the file `quantize_config.json`.
108
+ 9. Once you're ready, click the **Text Generation tab** and enter a prompt to get started!
109
+
110
+ ## How to use this GPTQ model from Python code
111
+
112
+ First make sure you have [AutoGPTQ](https://github.com/PanQiWei/AutoGPTQ) 0.3.1 or later installed:
113
+
114
+ ```
115
+ pip3 install auto-gptq
116
+ ```
117
+
118
+ If you have problems installing AutoGPTQ, please build from source instead:
119
+ ```
120
+ pip3 uninstall -y auto-gptq
121
+ git clone https://github.com/PanQiWei/AutoGPTQ
122
+ cd AutoGPTQ
123
+ pip3 install .
124
+ ```
125
+
126
+ Then try the following example code:
127
+
128
+ ```python
129
+ from transformers import AutoTokenizer, pipeline, logging
130
+ from auto_gptq import AutoGPTQForCausalLM, BaseQuantizeConfig
131
+
132
+ model_name_or_path = "TheBloke/EverythingLM-13B-16K-GPTQ"
133
+
134
+ use_triton = False
135
+
136
+ tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, use_fast=True)
137
+
138
+ model = AutoGPTQForCausalLM.from_quantized(model_name_or_path,
139
+ use_safetensors=True,
140
+ trust_remote_code=False,
141
+ device="cuda:0",
142
+ use_triton=use_triton,
143
+ quantize_config=None)
144
+
145
+ """
146
+ # To download from a specific branch, use the revision parameter, as in this example:
147
+ # Note that `revision` requires AutoGPTQ 0.3.1 or later!
148
+
149
+ model = AutoGPTQForCausalLM.from_quantized(model_name_or_path,
150
+ revision="gptq-4bit-32g-actorder_True",
151
+ use_safetensors=True,
152
+ trust_remote_code=False,
153
+ device="cuda:0",
154
+ quantize_config=None)
155
+ """
156
+
157
+ prompt = "Tell me about AI"
158
+ prompt_template=f'''You are a helpful AI assistant.
159
+
160
+ USER: {prompt}
161
+ ASSISTANT:
162
+ '''
163
+
164
+ print("\n\n*** Generate:")
165
+
166
+ input_ids = tokenizer(prompt_template, return_tensors='pt').input_ids.cuda()
167
+ output = model.generate(inputs=input_ids, temperature=0.7, max_new_tokens=512)
168
+ print(tokenizer.decode(output[0]))
169
+
170
+ # Inference can also be done using transformers' pipeline
171
+
172
+ # Prevent printing spurious transformers error when using pipeline with AutoGPTQ
173
+ logging.set_verbosity(logging.CRITICAL)
174
+
175
+ print("*** Pipeline:")
176
+ pipe = pipeline(
177
+ "text-generation",
178
+ model=model,
179
+ tokenizer=tokenizer,
180
+ max_new_tokens=512,
181
+ temperature=0.7,
182
+ top_p=0.95,
183
+ repetition_penalty=1.15
184
+ )
185
+
186
+ print(pipe(prompt_template)[0]['generated_text'])
187
+ ```
188
+
189
+ ## Compatibility
190
+
191
+ 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.
192
+
193
+ ExLlama works with Llama models in 4-bit. Please see the Provided Files table above for per-file compatibility.
194
+
195
+ <!-- footer start -->
196
+ ## Discord
197
+
198
+ For further support, and discussions on these models and AI in general, join us at:
199
+
200
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
201
+
202
+ ## Thanks, and how to contribute.
203
+
204
+ Thanks to the [chirper.ai](https://chirper.ai) team!
205
+
206
+ 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.
207
+
208
+ 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.
209
+
210
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
211
+
212
+ * Patreon: https://patreon.com/TheBlokeAI
213
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
214
+
215
+ **Special thanks to**: Luke from CarbonQuill, Aemon Algiz.
216
+
217
+ **Patreon special mentions**: Ajan Kanaga, David Ziegler, Raymond Fosdick, SuperWojo, Sam, webtim, Steven Wood, knownsqashed, Tony Hughes, Junyu Yang, J, Olakabola, Dan Guido, Stephen Murray, John Villwock, vamX, William Sang, Sean Connelly, LangChain4j, Olusegun Samson, Fen Risland, Derek Yates, Karl Bernard, transmissions 11, Trenton Dambrowitz, Pieter, Preetika Verma, Swaroop Kallakuri, Andrey, Slarti, Jonathan Leane, Michael Levine, Kalila, Joseph William Delisle, Rishabh Srivastava, Deo Leter, Luke Pendergrass, Spencer Kim, Geoffrey Montalvo, Thomas Belote, Jeffrey Morgan, Mandus, ya boyyy, Matthew Berman, Magnesian, Ai Maven, senxiiz, Alps Aficionado, Luke @flexchar, Raven Klaugh, Imad Khwaja, Gabriel Puliatti, Johann-Peter Hartmann, usrbinkat, Spiking Neurons AB, Artur Olbinski, chris gileta, danny, Willem Michiel, WelcomeToTheClub, Deep Realms, alfie_i, Dave, Leonard Tan, NimbleBox.ai, Randy H, Daniel P. Andersen, Pyrater, Will Dee, Elle, Space Cruiser, Gabriel Tamborski, Asp the Wyvern, Illia Dulskyi, Nikolai Manek, Sid, Brandon Frisco, Nathan LeClaire, Edmond Seymore, Enrico Ros, Pedro Madruga, Eugene Pentland, John Detwiler, Mano Prime, Stanislav Ovsiannikov, Alex, Vitor Caleffi, K, biorpg, Michael Davis, Lone Striker, Pierre Kircher, theTransient, Fred von Graf, Sebastain Graf, Vadim, Iucharbius, Clay Pascal, Chadd, Mesiah Bishop, terasurfer, Rainer Wilmers, Alexandros Triantafyllidis, Stefan Sabev, Talal Aujan, Cory Kujawski, Viktor Bowallius, subjectnull, ReadyPlayerEmma, zynix
218
+
219
+
220
+ Thank you to all my generous patrons and donaters!
221
+
222
+ <!-- footer end -->
223
+
224
+ # Original model card: Kai Howard's EverythingLM 13B 16K
225
+
226
+
227
+ # EverythingLM-13b-16k
228
+
229
+ Introducing EverythingLM, a llama-2 based, general-purpose 13b model with 16k context thanks to LlongMa. The model is trained on the EverythingLM dataset, more info can be found on the dataset page.
230
+
231
+ The model is completely uncensored.
232
+
233
+ This model is an early test of the EverythingLM dataset and some new experimental principles, so don't consider it SOTA.
234
+
235
+ ### Notable features:
236
+ - Automatically triggered CoT reasoning.
237
+ - Verbose and detailed replies.
238
+ - Creative stories.
239
+ - Better prompt understanding.
240
+
241
+ ### Prompt format:
242
+ It is a modified Vicuna format, the same used in many of ehartford's models.
243
+ ```
244
+ You are a helpful AI assistant.
245
+
246
+ USER: <prompt>
247
+ ASSISTANT:
248
+ ```
249
+
250
+ Training took about 1 hour using QLoRa on 1xA100, so this model can be recreated for about $3. QLoRa model can be found here: https://huggingface.co/totally-not-an-llm/EverythingLM-13b-peft.
251
+
252
+ ### Model quirks:
253
+ - Due to the nature of the dataset, it does better with more detail. I've found it gives much better stories when I provide more requirements.
254
+ - It really likes to use numbered lists. I don't necessarilly have a problem with this but it's something to note when training on the dataset.
255
+ - It likes to write fairy tales over anything else, which is strange. This can easily be fixed by prompting.
256
+ - Occasionally it will fall into repetition, this seems to be a commmon issue with llama-2 models.
257
+ - Haven't tested pushing it all the way to 16k context.
258
+
259
+ ### Future plans:
260
+ - Native finetune.
261
+ - Other model sizes.
262
+ - Improve dataset by:
263
+ - Regenerating using gpt-4.
264
+ - A bit more data with more diversity.
265
+ - Refactor dataset generation script.
266
+ - Test some model merges using this model.