TheBloke commited on
Commit
d17980b
1 Parent(s): 56816d0

Initial GPTQ model commit

Browse files
Files changed (1) hide show
  1. README.md +391 -0
README.md ADDED
@@ -0,0 +1,391 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
+ # Elinas' Chronos 13B GPTQ
21
+
22
+ These files are GPTQ 4bit model files for [Elinas' Chronos 13B](https://huggingface.co/elinas/chronos-13b) 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
+ GGML versions are not yet provided, as there is not yet support for SuperHOT in llama.cpp. This is being investigated and will hopefully come soon.
39
+
40
+ ## Repositories available
41
+
42
+ * [4-bit GPTQ models for GPU inference](https://huggingface.co/TheBloke/Chronos-13B-SuperHOT-8K-GPTQ)
43
+ * [Unquantised SuperHOT fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/TheBloke/Chronos-13B-SuperHOT-8K-fp16)
44
+ * [Unquantised base fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/elinas/chronos-13b)
45
+
46
+ ## How to easily download and use this model in text-generation-webui with ExLlama
47
+
48
+ Please make sure you're using the latest version of text-generation-webui
49
+
50
+ 1. Click the **Model tab**.
51
+ 2. Under **Download custom model or LoRA**, enter `TheBloke/Chronos-13B-SuperHOT-8K-GPTQ`.
52
+ 3. Click **Download**.
53
+ 4. The model will start downloading. Once it's finished it will say "Done"
54
+ 5. Untick **Autoload the model**
55
+ 6. In the top left, click the refresh icon next to **Model**.
56
+ 7. In the **Model** dropdown, choose the model you just downloaded: `Chronos-13B-SuperHOT-8K-GPTQ`
57
+ 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.
58
+ 9. Now click **Save Settings** followed by **Reload**
59
+ 10. The model will automatically load, and is now ready for use!
60
+ 11. Once you're ready, click the **Text Generation tab** and enter a prompt to get started!
61
+
62
+ ## How to use this GPTQ model from Python code with AutoGPTQ
63
+
64
+ First make sure you have AutoGPTQ and Einops installed:
65
+
66
+ ```
67
+ pip3 install einops auto-gptq
68
+ ```
69
+
70
+ 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.
71
+
72
+ 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.
73
+
74
+ ```python
75
+ from transformers import AutoTokenizer, pipeline, logging
76
+ from auto_gptq import AutoGPTQForCausalLM, BaseQuantizeConfig
77
+ import argparse
78
+
79
+ model_name_or_path = "TheBloke/Chronos-13B-SuperHOT-8K-GPTQ"
80
+ model_basename = "chronos-13b-superhot-8k-GPTQ-4bit-128g.no-act.order"
81
+
82
+ use_triton = False
83
+
84
+ tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, use_fast=True)
85
+
86
+ model = AutoGPTQForCausalLM.from_quantized(model_name_or_path,
87
+ model_basename=model_basename,
88
+ use_safetensors=True,
89
+ trust_remote_code=True,
90
+ device_map='auto',
91
+ use_triton=use_triton,
92
+ quantize_config=None)
93
+
94
+ model.seqlen = 8192
95
+
96
+ # Note: check the prompt template is correct for this model.
97
+ prompt = "Tell me about AI"
98
+ prompt_template=f'''USER: {prompt}
99
+ ASSISTANT:'''
100
+
101
+ print("\n\n*** Generate:")
102
+
103
+ input_ids = tokenizer(prompt_template, return_tensors='pt').input_ids.cuda()
104
+ output = model.generate(inputs=input_ids, temperature=0.7, max_new_tokens=512)
105
+ print(tokenizer.decode(output[0]))
106
+
107
+ # Inference can also be done using transformers' pipeline
108
+
109
+ # Prevent printing spurious transformers error when using pipeline with AutoGPTQ
110
+ logging.set_verbosity(logging.CRITICAL)
111
+
112
+ print("*** Pipeline:")
113
+ pipe = pipeline(
114
+ "text-generation",
115
+ model=model,
116
+ tokenizer=tokenizer,
117
+ max_new_tokens=512,
118
+ temperature=0.7,
119
+ top_p=0.95,
120
+ repetition_penalty=1.15
121
+ )
122
+
123
+ print(pipe(prompt_template)[0]['generated_text'])
124
+ ```
125
+
126
+ ## Using other UIs: monkey patch
127
+
128
+ Provided in the repo is `llama_rope_scaled_monkey_patch.py`, written by @kaiokendev.
129
+
130
+ 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.
131
+
132
+ ## Provided files
133
+
134
+ **chronos-13b-superhot-8k-GPTQ-4bit-128g.no-act.order.safetensors**
135
+
136
+ 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.
137
+
138
+ It was created with group_size 128 to increase inference accuracy, but without --act-order (desc_act) to increase compatibility and improve inference speed.
139
+
140
+ * `chronos-13b-superhot-8k-GPTQ-4bit-128g.no-act.order.safetensors`
141
+ * Works for use with ExLlama with increased context (4096 or 8192)
142
+ * Works with AutoGPTQ in Python code, including with increased context, if `trust_remote_code=True` is set.
143
+ * 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.
144
+ * Works with text-generation-webui, including one-click-installers.
145
+ * Parameters: Groupsize = 128. Act Order / desc_act = False.
146
+
147
+ <!-- footer start -->
148
+ ## Discord
149
+
150
+ For further support, and discussions on these models and AI in general, join us at:
151
+
152
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
153
+
154
+ ## Thanks, and how to contribute.
155
+
156
+ Thanks to the [chirper.ai](https://chirper.ai) team!
157
+
158
+ 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.
159
+
160
+ 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.
161
+
162
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
163
+
164
+ * Patreon: https://patreon.com/TheBlokeAI
165
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
166
+
167
+ **Special thanks to**: Luke from CarbonQuill, Aemon Algiz, Dmitriy Samsonov.
168
+
169
+ **Patreon special mentions**: Pyrater, WelcomeToTheClub, Kalila, Mano Prime, Trenton Dambrowitz, Spiking Neurons AB, Pierre Kircher, Fen Risland, Kevin Schuppel, Luke, Rainer Wilmers, vamX, Gabriel Puliatti, Alex , Karl Bernard, Ajan Kanaga, Talal Aujan, Space Cruiser, ya boyyy, biorpg, Johann-Peter Hartmann, Asp the Wyvern, Ai Maven, Ghost , Preetika Verma, Nikolai Manek, trip7s trip, John Detwiler, Fred von Graf, Artur Olbinski, subjectnull, John Villwock, Junyu Yang, Rod A, Lone Striker, Chris McCloskey, Iucharbius , Matthew Berman, Illia Dulskyi, Khalefa Al-Ahmad, Imad Khwaja, chris gileta, Willem Michiel, Greatston Gnanesh, Derek Yates, K, Alps Aficionado, Oscar Rangel, David Flickinger, Luke Pendergrass, Deep Realms, Eugene Pentland, Cory Kujawski, terasurfer , Jonathan Leane, senxiiz, Joseph William Delisle, Sean Connelly, webtim, zynix , Nathan LeClaire.
170
+
171
+ Thank you to all my generous patrons and donaters!
172
+
173
+ <!-- footer end -->
174
+
175
+ # Original model card: Kaio Ken's SuperHOT 8K
176
+
177
+ ### SuperHOT Prototype 2 w/ 8K Context
178
+
179
+ 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).
180
+ Tests have shown that the model does indeed leverage the extended context at 8K.
181
+
182
+ 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**
183
+
184
+ #### Looking for Merged & Quantized Models?
185
+ - 30B 4-bit CUDA: [tmpupload/superhot-30b-8k-4bit-safetensors](https://huggingface.co/tmpupload/superhot-30b-8k-4bit-safetensors)
186
+ - 30B 4-bit CUDA 128g: [tmpupload/superhot-30b-8k-4bit-128g-safetensors](https://huggingface.co/tmpupload/superhot-30b-8k-4bit-128g-safetensors)
187
+
188
+
189
+ #### Training Details
190
+ I trained the LoRA with the following configuration:
191
+ - 1200 samples (~400 samples over 2048 sequence length)
192
+ - learning rate of 3e-4
193
+ - 3 epochs
194
+ - The exported modules are:
195
+ - q_proj
196
+ - k_proj
197
+ - v_proj
198
+ - o_proj
199
+ - no bias
200
+ - Rank = 4
201
+ - Alpha = 8
202
+ - no dropout
203
+ - weight decay of 0.1
204
+ - AdamW beta1 of 0.9 and beta2 0.99, epsilon of 1e-5
205
+ - Trained on 4-bit base model
206
+
207
+ # Original model card: Elinas' Chronos 13B
208
+
209
+
210
+ # chronos-13b
211
+
212
+ This is the fp16 PyTorch / HF version of **chronos-13b**
213
+
214
+ This model is primarily focused on chat, roleplay, and storywriting, but can accomplish other tasks such as simple reasoning and coding.
215
+
216
+ Chronos generates very long outputs with coherent text, largely due to the human inputs it was trained on.
217
+
218
+ This model uses Alpaca formatting, so for optimal model performance, use:
219
+ ```
220
+ ### Instruction:
221
+ Your instruction or question here.
222
+ ### Response:
223
+ ```
224
+
225
+ [4bit Quantized version](https://huggingface.co/elinas/chronos-13b-4bit)
226
+
227
+ [GGML Version provided by @TheBloke](https://huggingface.co/TheBloke/chronos-13B-GGML)
228
+
229
+ <!--**Support My Development of New Models**
230
+ <a href='https://ko-fi.com/Q5Q6MB734' target='_blank'><img height='36' style='border:0px;height:36px;'
231
+ src='https://storage.ko-fi.com/cdn/kofi1.png?v=3' border='0' alt='Support Development' /></a>-->
232
+
233
+ --
234
+ license: other
235
+ ---
236
+ # LLaMA Model Card
237
+
238
+ ## Model details
239
+ **Organization developing the model**
240
+ The FAIR team of Meta AI.
241
+
242
+ **Model date**
243
+ LLaMA was trained between December. 2022 and Feb. 2023.
244
+
245
+ **Model version**
246
+ This is version 1 of the model.
247
+
248
+ **Model type**
249
+ LLaMA is an auto-regressive language model, based on the transformer architecture. The model comes in different sizes: 7B, 13B, 33B and 65B parameters.
250
+
251
+ **Paper or resources for more information**
252
+ More information can be found in the paper “LLaMA, Open and Efficient Foundation Language Models”, available at https://research.facebook.com/publications/llama-open-and-efficient-foundation-language-models/.
253
+
254
+ **Citations details**
255
+ https://research.facebook.com/publications/llama-open-and-efficient-foundation-language-models/
256
+
257
+ **License**
258
+ Non-commercial bespoke license
259
+
260
+ **Where to send questions or comments about the model**
261
+ Questions and comments about LLaMA can be sent via the [GitHub repository](https://github.com/facebookresearch/llama) of the project , by opening an issue.
262
+
263
+ ## Intended use
264
+ **Primary intended uses**
265
+ The primary use of LLaMA is research on large language models, including:
266
+ exploring potential applications such as question answering, natural language understanding or reading comprehension,
267
+ understanding capabilities and limitations of current language models, and developing techniques to improve those,
268
+ evaluating and mitigating biases, risks, toxic and harmful content generations, hallucinations.
269
+
270
+ **Primary intended users**
271
+ The primary intended users of the model are researchers in natural language processing, machine learning and artificial intelligence.
272
+
273
+ **Out-of-scope use cases**
274
+ LLaMA is a base, or foundational, model. As such, it should not be used on downstream applications without further risk evaluation and mitigation. In particular, our model has not been trained with human feedback, and can thus generate toxic or offensive content, incorrect information or generally unhelpful answers.
275
+
276
+ ## Factors
277
+ **Relevant factors**
278
+ One of the most relevant factors for which model performance may vary is which language is used. Although we included 20 languages in the training data, most of our dataset is made of English text, and we thus expect the model to perform better for English than other languages. Relatedly, it has been shown in previous studies that performance might vary for different dialects, and we expect that it will be the case for our model.
279
+
280
+ **Evaluation factors**
281
+ As our model is trained on data from the Web, we expect that it reflects biases from this source. We thus evaluated on RAI datasets to measure biases exhibited by the model for gender, religion, race, sexual orientation, age, nationality, disability, physical appearance and socio-economic status. We also measure the toxicity of model generations, depending on the toxicity of the context used to prompt the model.
282
+
283
+ ## Metrics
284
+ **Model performance measures**
285
+ We use the following measure to evaluate the model:
286
+ - Accuracy for common sense reasoning, reading comprehension, natural language understanding (MMLU), BIG-bench hard, WinoGender and CrowS-Pairs,
287
+ - Exact match for question answering,
288
+ - The toxicity score from Perspective API on RealToxicityPrompts.
289
+
290
+ **Decision thresholds**
291
+ Not applicable.
292
+
293
+ **Approaches to uncertainty and variability**
294
+ Due to the high computational requirements of training LLMs, we trained only one model of each size, and thus could not evaluate variability of pre-training.
295
+
296
+ ## Evaluation datasets
297
+ The model was evaluated on the following benchmarks: BoolQ, PIQA, SIQA, HellaSwag, WinoGrande, ARC, OpenBookQA, NaturalQuestions, TriviaQA, RACE, MMLU, BIG-bench hard, GSM8k, RealToxicityPrompts, WinoGender, CrowS-Pairs.
298
+
299
+ ## Training dataset
300
+ The model was trained using the following source of data: CCNet [67%], C4 [15%], GitHub [4.5%], Wikipedia [4.5%], Books [4.5%], ArXiv [2.5%], Stack Exchange[2%]. The Wikipedia and Books domains include data in the following languages: bg, ca, cs, da, de, en, es, fr, hr, hu, it, nl, pl, pt, ro, ru, sl, sr, sv, uk. See the paper for more details about the training set and corresponding preprocessing.
301
+
302
+ ## Quantitative analysis
303
+ Hyperparameters for the model architecture
304
+
305
+
306
+ <table>
307
+ <thead>
308
+ <tr>
309
+ <th >LLaMA</th> <th colspan=6>Model hyper parameters </th>
310
+ </tr>
311
+ <tr>
312
+ <th>Number of parameters</th><th>dimension</th><th>n heads</th><th>n layers</th><th>Learn rate</th><th>Batch size</th><th>n tokens</th>
313
+ </tr>
314
+ </thead>
315
+ <tbody>
316
+ <tr>
317
+ <th>7B</th> <th>4096</th> <th>32</th> <th>32</th> <th>3.0E-04</th><th>4M</th><th>1T
318
+ </tr>
319
+ <tr>
320
+ <th>13B</th><th>5120</th><th>40</th><th>40</th><th>3.0E-04</th><th>4M</th><th>1T
321
+ </tr>
322
+ <tr>
323
+ <th>33B</th><th>6656</th><th>52</th><th>60</th><th>1.5.E-04</th><th>4M</th><th>1.4T
324
+ </tr>
325
+ <tr>
326
+ <th>65B</th><th>8192</th><th>64</th><th>80</th><th>1.5.E-04</th><th>4M</th><th>1.4T
327
+ </tr>
328
+ </tbody>
329
+ </table>
330
+
331
+ *Table 1 - Summary of LLama Model Hyperparameters*
332
+
333
+ We present our results on eight standard common sense reasoning benchmarks in the table below.
334
+ <table>
335
+ <thead>
336
+ <tr>
337
+ <th>LLaMA</th> <th colspan=9>Reasoning tasks </th>
338
+ </tr>
339
+ <tr>
340
+ <th>Number of parameters</th> <th>BoolQ</th><th>PIQA</th><th>SIQA</th><th>HellaSwag</th><th>WinoGrande</th><th>ARC-e</th><th>ARC-c</th><th>OBQA</th><th>COPA</th>
341
+ </tr>
342
+ </thead>
343
+ <tbody>
344
+ <tr>
345
+ <th>7B</th><th>76.5</th><th>79.8</th><th>48.9</th><th>76.1</th><th>70.1</th><th>76.7</th><th>47.6</th><th>57.2</th><th>93
346
+ </th>
347
+ <tr><th>13B</th><th>78.1</th><th>80.1</th><th>50.4</th><th>79.2</th><th>73</th><th>78.1</th><th>52.7</th><th>56.4</th><th>94
348
+ </th>
349
+ <tr><th>33B</th><th>83.1</th><th>82.3</th><th>50.4</th><th>82.8</th><th>76</th><th>81.4</th><th>57.8</th><th>58.6</th><th>92
350
+ </th>
351
+ <tr><th>65B</th><th>85.3</th><th>82.8</th><th>52.3</th><th>84.2</th><th>77</th><th>81.5</th><th>56</th><th>60.2</th><th>94</th></tr>
352
+ </tbody>
353
+ </table>
354
+ *Table 2 - Summary of LLama Model Performance on Reasoning tasks*
355
+
356
+
357
+ We present our results on bias in the table below. Note that lower value is better indicating lower bias.
358
+
359
+
360
+ | No | Category | FAIR LLM |
361
+ | --- | -------------------- | -------- |
362
+ | 1 | Gender | 70.6 |
363
+ | 2 | Religion | 79 |
364
+ | 3 | Race/Color | 57 |
365
+ | 4 | Sexual orientation | 81 |
366
+ | 5 | Age | 70.1 |
367
+ | 6 | Nationality | 64.2 |
368
+ | 7 | Disability | 66.7 |
369
+ | 8 | Physical appearance | 77.8 |
370
+ | 9 | Socioeconomic status | 71.5 |
371
+ | | LLaMA Average | 66.6 |
372
+
373
+ *Table 3 - Summary bias of our model output*
374
+
375
+
376
+
377
+ ## Ethical considerations
378
+ **Data**
379
+ The data used to train the model is collected from various sources, mostly from the Web. As such, it contains offensive, harmful and biased content. We thus expect the model to exhibit such biases from the training data.
380
+
381
+ **Human life**
382
+ The model is not intended to inform decisions about matters central to human life, and should not be used in such a way.
383
+
384
+ **Mitigations**
385
+ We filtered the data from the Web based on its proximity to Wikipedia text and references. For this, we used a Kneser-Ney language model and a fastText linear classifier.
386
+
387
+ **Risks and harms**
388
+ Risks and harms of large language models include the generation of harmful, offensive or biased content. These models are often prone to generating incorrect information, sometimes referred to as hallucinations. We do not expect our model to be an exception in this regard.
389
+
390
+ **Use cases**
391
+ LLaMA is a foundational model, and as such, it should not be used for downstream applications without further investigation and mitigations of risks. These risks and potential fraught use cases include, but are not limited to: generation of misinformation and generation of harmful, biased or offensive content.