TheBloke commited on
Commit
cc16d12
·
1 Parent(s): 8faf7d6

Initial GPTQ model commit

Browse files
Files changed (1) hide show
  1. README.md +310 -0
README.md ADDED
@@ -0,0 +1,310 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ inference: false
3
+ license: other
4
+ ---
5
+
6
+ <!-- header start -->
7
+ <div style="width: 100%;">
8
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
9
+ </div>
10
+ <div style="display: flex; justify-content: space-between; width: 100%;">
11
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
12
+ <p><a href="https://discord.gg/theblokeai">Chat & support: my new Discord server</a></p>
13
+ </div>
14
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
15
+ <p><a href="https://www.patreon.com/TheBlokeAI">Want to contribute? TheBloke's Patreon page</a></p>
16
+ </div>
17
+ </div>
18
+ <!-- header end -->
19
+
20
+ # Koala 13B GPTQ
21
+
22
+ These files are GPTQ 4bit model files for [Koala 13B](https://huggingface.co/TheBloke/koala-13b-HF) merged with [Kaio Ken's SuperHOT 8K](https://huggingface.co/kaiokendev/superhot-13b-8k-no-rlhf-test).
23
+
24
+ It is the result of quantising to 4bit using [GPTQ-for-LLaMa](https://github.com/qwopqwop200/GPTQ-for-LLaMa).
25
+
26
+ **This is an experimental new GPTQ which offers up to 8K context size**
27
+
28
+ The increased context is tested to work with [ExLlama](https://github.com/turboderp/exllama), via the latest release of [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
29
+
30
+ It has also been tested from Python code using AutoGPTQ, and `trust_remote_code=True`.
31
+
32
+ Code credits:
33
+ - Original concept and code for increasing context length: [kaiokendev](https://huggingface.co/kaiokendev)
34
+ - Updated Llama modelling code that includes this automatically via trust_remote_code: [emozilla](https://huggingface.co/emozilla).
35
+
36
+ Please read carefully below to see how to use it.
37
+
38
+ ## Repositories available
39
+
40
+ * [4-bit GPTQ models for GPU inference](https://huggingface.co/TheBloke/Koala-13B-SuperHOT-8K-GPTQ)
41
+ * [2, 3, 4, 5, 6 and 8-bit GGML models for CPU inference](https://huggingface.co/TheBloke/Koala-13B-SuperHOT-8K-GGML)
42
+ * [Unquantised SuperHOT fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/TheBloke/Koala-13B-SuperHOT-8K-fp16)
43
+ * [Unquantised base fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/young-geng/koala)
44
+
45
+ ## How to easily download and use this model in text-generation-webui with ExLlama
46
+
47
+ Please make sure you're using the latest version of text-generation-webui
48
+
49
+ 1. Click the **Model tab**.
50
+ 2. Under **Download custom model or LoRA**, enter `TheBloke/Koala-13B-SuperHOT-8K-GPTQ`.
51
+ 3. Click **Download**.
52
+ 4. The model will start downloading. Once it's finished it will say "Done"
53
+ 5. Untick **Autoload the model**
54
+ 6. In the top left, click the refresh icon next to **Model**.
55
+ 7. In the **Model** dropdown, choose the model you just downloaded: `Koala-13B-SuperHOT-8K-GPTQ`
56
+ 8. To use the increased context, set the **Loader** to **ExLlama**, set **max_seq_len** to 8192 or 4096, and set **compress_pos_emb** to **4** for 8192 context, or to **2** for 4096 context.
57
+ 9. Now click **Save Settings** followed by **Reload**
58
+ 10. The model will automatically load, and is now ready for use!
59
+ 11. Once you're ready, click the **Text Generation tab** and enter a prompt to get started!
60
+
61
+ ## How to use this GPTQ model from Python code with AutoGPTQ
62
+
63
+ First make sure you have AutoGPTQ and Einops installed:
64
+
65
+ ```
66
+ pip3 install einops auto-gptq
67
+ ```
68
+
69
+ Then run the following code. Note that in order to get this to work, `config.json` has been hardcoded to a sequence length of 8192.
70
+
71
+ If you want to try 4096 instead to reduce VRAM usage, please manually edit `config.json` to set `max_position_embeddings` to the value you want.
72
+
73
+ ```python
74
+ from transformers import AutoTokenizer, pipeline, logging
75
+ from auto_gptq import AutoGPTQForCausalLM, BaseQuantizeConfig
76
+ import argparse
77
+
78
+ model_name_or_path = "TheBloke/Koala-13B-SuperHOT-8K-GPTQ"
79
+ model_basename = "koala-13b-superhot-8k-GPTQ-4bit-128g.no-act.order"
80
+
81
+ use_triton = False
82
+
83
+ tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, use_fast=True)
84
+
85
+ model = AutoGPTQForCausalLM.from_quantized(model_name_or_path,
86
+ model_basename=model_basename,
87
+ use_safetensors=True,
88
+ trust_remote_code=True,
89
+ device_map='auto',
90
+ use_triton=use_triton,
91
+ quantize_config=None)
92
+
93
+ model.seqlen = 8192
94
+
95
+ # Note: check the prompt template is correct for this model.
96
+ prompt = "Tell me about AI"
97
+ prompt_template=f'''USER: {prompt}
98
+ ASSISTANT:'''
99
+
100
+ print("\n\n*** Generate:")
101
+
102
+ input_ids = tokenizer(prompt_template, return_tensors='pt').input_ids.cuda()
103
+ output = model.generate(inputs=input_ids, temperature=0.7, max_new_tokens=512)
104
+ print(tokenizer.decode(output[0]))
105
+
106
+ # Inference can also be done using transformers' pipeline
107
+
108
+ # Prevent printing spurious transformers error when using pipeline with AutoGPTQ
109
+ logging.set_verbosity(logging.CRITICAL)
110
+
111
+ print("*** Pipeline:")
112
+ pipe = pipeline(
113
+ "text-generation",
114
+ model=model,
115
+ tokenizer=tokenizer,
116
+ max_new_tokens=512,
117
+ temperature=0.7,
118
+ top_p=0.95,
119
+ repetition_penalty=1.15
120
+ )
121
+
122
+ print(pipe(prompt_template)[0]['generated_text'])
123
+ ```
124
+
125
+ ## Using other UIs: monkey patch
126
+
127
+ Provided in the repo is `llama_rope_scaled_monkey_patch.py`, written by @kaiokendev.
128
+
129
+ It can be theoretically be added to any Python UI or custom code to enable the same result as `trust_remote_code=True`. I have not tested this, and it should be superseded by using `trust_remote_code=True`, but I include it for completeness and for interest.
130
+
131
+ ## Provided files
132
+
133
+ **koala-13b-superhot-8k-GPTQ-4bit-128g.no-act.order.safetensors**
134
+
135
+ This will work with AutoGPTQ, ExLlama, and CUDA versions of GPTQ-for-LLaMa. There are reports of issues with Triton mode of recent GPTQ-for-LLaMa. If you have issues, please use AutoGPTQ instead.
136
+
137
+ It was created with group_size 128 to increase inference accuracy, but without --act-order (desc_act) to increase compatibility and improve inference speed.
138
+
139
+ * `koala-13b-superhot-8k-GPTQ-4bit-128g.no-act.order.safetensors`
140
+ * Works for use with ExLlama with increased context (4096 or 8192)
141
+ * Works with AutoGPTQ in Python code, including with increased context, if `trust_remote_code=True` is set.
142
+ * Should work with GPTQ-for-LLaMa in CUDA mode, but unknown if increased context works - TBC. May have issues with GPTQ-for-LLaMa Triton mode.
143
+ * Works with text-generation-webui, including one-click-installers.
144
+ * Parameters: Groupsize = 128. Act Order / desc_act = False.
145
+
146
+ <!-- footer start -->
147
+ ## Discord
148
+
149
+ For further support, and discussions on these models and AI in general, join us at:
150
+
151
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
152
+
153
+ ## Thanks, and how to contribute.
154
+
155
+ Thanks to the [chirper.ai](https://chirper.ai) team!
156
+
157
+ 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.
158
+
159
+ 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.
160
+
161
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
162
+
163
+ * Patreon: https://patreon.com/TheBlokeAI
164
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
165
+
166
+ **Special thanks to**: Luke from CarbonQuill, Aemon Algiz.
167
+
168
+ **Patreon special mentions**: RoA, Lone Striker, Gabriel Puliatti, Derek Yates, Randy H, Jonathan Leane, Eugene Pentland, Karl Bernard, Viktor Bowallius, senxiiz, Daniel P. Andersen, Pierre Kircher, Deep Realms, Cory Kujawski, Oscar Rangel, Fen Risland, Ajan Kanaga, LangChain4j, webtim, Nikolai Manek, Trenton Dambrowitz, Raven Klaugh, Kalila, Khalefa Al-Ahmad, Chris McCloskey, Luke @flexchar, Ai Maven, Dave, Asp the Wyvern, Sean Connelly, Imad Khwaja, Space Cruiser, Rainer Wilmers, subjectnull, Alps Aficionado, Willian Hasse, Fred von Graf, Artur Olbinski, Johann-Peter Hartmann, WelcomeToTheClub, Willem Michiel, Michael Levine, Iucharbius , Spiking Neurons AB, K, biorpg, John Villwock, Pyrater, Greatston Gnanesh, Mano Prime, Junyu Yang, Stephen Murray, John Detwiler, Luke Pendergrass, terasurfer , Pieter, zynix , Edmond Seymore, theTransient, Nathan LeClaire, vamX, Kevin Schuppel, Preetika Verma, ya boyyy, Alex , SuperWojo, Ghost , Joseph William Delisle, Matthew Berman, Talal Aujan, chris gileta, Illia Dulskyi.
169
+
170
+ Thank you to all my generous patrons and donaters!
171
+
172
+ <!-- footer end -->
173
+
174
+ # Original model card: Kaio Ken's SuperHOT 8K
175
+
176
+ ### SuperHOT Prototype 2 w/ 8K Context
177
+
178
+ This is a second prototype of SuperHOT, this time 30B with 8K context and no RLHF, using the same technique described in [the github blog](https://kaiokendev.github.io/til#extending-context-to-8k).
179
+ Tests have shown that the model does indeed leverage the extended context at 8K.
180
+
181
+ You will need to **use either the monkeypatch** or, if you are already using the monkeypatch, **change the scaling factor to 0.25 and the maximum sequence length to 8192**
182
+
183
+ #### Looking for Merged & Quantized Models?
184
+ - 30B 4-bit CUDA: [tmpupload/superhot-30b-8k-4bit-safetensors](https://huggingface.co/tmpupload/superhot-30b-8k-4bit-safetensors)
185
+ - 30B 4-bit CUDA 128g: [tmpupload/superhot-30b-8k-4bit-128g-safetensors](https://huggingface.co/tmpupload/superhot-30b-8k-4bit-128g-safetensors)
186
+
187
+
188
+ #### Training Details
189
+ I trained the LoRA with the following configuration:
190
+ - 1200 samples (~400 samples over 2048 sequence length)
191
+ - learning rate of 3e-4
192
+ - 3 epochs
193
+ - The exported modules are:
194
+ - q_proj
195
+ - k_proj
196
+ - v_proj
197
+ - o_proj
198
+ - no bias
199
+ - Rank = 4
200
+ - Alpha = 8
201
+ - no dropout
202
+ - weight decay of 0.1
203
+ - AdamW beta1 of 0.9 and beta2 0.99, epsilon of 1e-5
204
+ - Trained on 4-bit base model
205
+
206
+ # Original model card: Koala 13B
207
+
208
+ <!-- header start -->
209
+ <div style="width: 100%;">
210
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
211
+ </div>
212
+ <div style="display: flex; justify-content: space-between; width: 100%;">
213
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
214
+ <p><a href="https://discord.gg/Jq4vkcDakD">Chat & support: my new Discord server</a></p>
215
+ </div>
216
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
217
+ <p><a href="https://www.patreon.com/TheBlokeAI">Want to contribute? TheBloke's Patreon page</a></p>
218
+ </div>
219
+ </div>
220
+ <!-- header end -->
221
+
222
+ # Koala: A Dialogue Model for Academic Research
223
+ This repo contains the weights of the Koala 13B model produced at Berkeley. It is the result of combining the diffs from https://huggingface.co/young-geng/koala with the original Llama 13B model.
224
+
225
+ This version has then been converted to HF format.
226
+
227
+ ## My Koala repos
228
+ I have the following Koala model repositories available:
229
+
230
+ **13B models:**
231
+ * [Unquantized 13B model in HF format](https://huggingface.co/TheBloke/koala-13B-HF)
232
+ * [GPTQ quantized 4bit 13B model in `pt` and `safetensors` formats](https://huggingface.co/TheBloke/koala-13B-GPTQ-4bit-128g)
233
+ * [4-bit, 5-bit and 8-bit GGML models for `llama.cpp`](https://huggingface.co/TheBloke/koala-13B-GGML)
234
+
235
+ **7B models:**
236
+ * [Unquantized 7B model in HF format](https://huggingface.co/TheBloke/koala-7B-HF)
237
+ * [Unquantized 7B model in GGML format for llama.cpp](https://huggingface.co/TheBloke/koala-7b-ggml-unquantized)
238
+ * [GPTQ quantized 4bit 7B model in `pt` and `safetensors` formats](https://huggingface.co/TheBloke/koala-7B-GPTQ-4bit-128g)
239
+ * [4-bit, 5-bit and 8-bit GGML models for `llama.cpp`](https://huggingface.co/TheBloke/koala-7B-GGML)
240
+
241
+ ## How the Koala delta weights were merged
242
+
243
+ The Koala delta weights were merged using the following commands:
244
+ ```
245
+ git clone https://github.com/young-geng/EasyLM
246
+
247
+ git clone https://huggingface.co/TheBloke/llama-13b
248
+
249
+ mkdir koala_diffs && cd koala_diffs && wget https://huggingface.co/young-geng/koala/resolve/main/koala_13b_diff_v2
250
+
251
+ cd EasyLM
252
+
253
+ PYTHON_PATH="${PWD}:$PYTHONPATH" python \
254
+ -m EasyLM.models.llama.convert_torch_to_easylm \
255
+ --checkpoint_dir=/content/llama-13b \
256
+ --output_file=/content/llama-13b-LM \
257
+ --streaming=True
258
+
259
+ PYTHON_PATH="${PWD}:$PYTHONPATH" python \
260
+ -m EasyLM.scripts.diff_checkpoint --recover_diff=True \
261
+ --load_base_checkpoint='params::/content/llama-13b-LM' \
262
+ --load_target_checkpoint='params::/content/koala_diffs/koala_13b_diff_v2' \
263
+ --output_file=/content/koala_13b.diff.weights \
264
+ --streaming=True
265
+
266
+ PYTHON_PATH="${PWD}:$PYTHONPATH" python \
267
+ -m EasyLM.models.llama.convert_easylm_to_hf --model_size=13b \
268
+ --output_dir=/content/koala-13B-HF \
269
+ --load_checkpoint='params::/content/koala_13b.diff.weights' \
270
+ --tokenizer_path=/content/llama-13b/tokenizer.model
271
+ ```
272
+
273
+ <!-- footer start -->
274
+ ## Discord
275
+
276
+ For further support, and discussions on these models and AI in general, join us at:
277
+
278
+ [TheBloke AI's Discord server](https://discord.gg/Jq4vkcDakD)
279
+
280
+ ## Thanks, and how to contribute.
281
+
282
+ Thanks to the [chirper.ai](https://chirper.ai) team!
283
+
284
+ 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.
285
+
286
+ 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.
287
+
288
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
289
+
290
+ * Patreon: https://patreon.com/TheBlokeAI
291
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
292
+
293
+ **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.
294
+
295
+ Thank you to all my generous patrons and donaters!
296
+ <!-- footer end -->
297
+
298
+ ## Further info
299
+ Check out the following links to learn more about the Berkeley Koala model.
300
+ * [Blog post](https://bair.berkeley.edu/blog/2023/04/03/koala/)
301
+ * [Online demo](https://koala.lmsys.org/)
302
+ * [EasyLM: training and serving framework on GitHub](https://github.com/young-geng/EasyLM)
303
+ * [Documentation for running Koala locally](https://github.com/young-geng/EasyLM/blob/main/docs/koala.md)
304
+
305
+ ## License
306
+ The model weights are intended for academic research only, subject to the
307
+ [model License of LLaMA](https://github.com/facebookresearch/llama/blob/main/MODEL_CARD.md),
308
+ [Terms of Use of the data generated by OpenAI](https://openai.com/policies/terms-of-use),
309
+ and [Privacy Practices of ShareGPT](https://chrome.google.com/webstore/detail/sharegpt-share-your-chatg/daiacboceoaocpibfodeljbdfacokfjb).
310
+ Any other usage of the model weights, including but not limited to commercial usage, is strictly prohibited.