TheBloke commited on
Commit
931ad67
·
1 Parent(s): 452918b

Initial GPTQ model commit

Browse files
Files changed (1) hide show
  1. README.md +325 -0
README.md ADDED
@@ -0,0 +1,325 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ inference: false
3
+ language:
4
+ - en
5
+ license: llama2
6
+ model_creator: nRuaif
7
+ model_link: https://huggingface.co/nRuaif/fiction.live-Kimiko-V2-70B
8
+ model_name: Fiction Live Kimiko V2 70B
9
+ model_type: llama
10
+ pipeline_tag: text-generation
11
+ quantized_by: TheBloke
12
+ ---
13
+
14
+ <!-- header start -->
15
+ <!-- 200823 -->
16
+ <div style="width: auto; margin-left: auto; margin-right: auto">
17
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
18
+ </div>
19
+ <div style="display: flex; justify-content: space-between; width: 100%;">
20
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
21
+ <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
22
+ </div>
23
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
24
+ <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://www.patreon.com/TheBlokeAI">Want to contribute? TheBloke's Patreon page</a></p>
25
+ </div>
26
+ </div>
27
+ <div style="text-align:center; margin-top: 0em; margin-bottom: 0em"><p style="margin-top: 0.25em; margin-bottom: 0em;">TheBloke's LLM work is generously supported by a grant from <a href="https://a16z.com">andreessen horowitz (a16z)</a></p></div>
28
+ <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
29
+ <!-- header end -->
30
+
31
+ # Fiction Live Kimiko V2 70B - GPTQ
32
+ - Model creator: [nRuaif](https://huggingface.co/nRuaif)
33
+ - Original model: [Fiction Live Kimiko V2 70B](https://huggingface.co/nRuaif/fiction.live-Kimiko-V2-70B)
34
+
35
+ <!-- description start -->
36
+ ## Description
37
+
38
+ This repo contains GPTQ model files for [nRuaif's Fiction Live Kimiko V2 70B](https://huggingface.co/nRuaif/fiction.live-Kimiko-V2-70B).
39
+
40
+ 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.
41
+
42
+ <!-- description end -->
43
+ <!-- repositories-available start -->
44
+ ## Repositories available
45
+
46
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/fiction.live-Kimiko-V2-70B-GPTQ)
47
+ * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/fiction.live-Kimiko-V2-70B-GGUF)
48
+ * [2, 3, 4, 5, 6 and 8-bit GGML models for CPU+GPU inference (deprecated)](https://huggingface.co/TheBloke/fiction.live-Kimiko-V2-70B-GGML)
49
+ * [Unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/TheBloke/fiction.live-Kimiko-V2-70B-fp16)
50
+ * [nRuaif's original LoRA adapter, which can be merged on to the base model.](https://huggingface.co/nRuaif/fiction.live-Kimiko-V2-70B)
51
+ <!-- repositories-available end -->
52
+
53
+ <!-- prompt-template start -->
54
+ ## Prompt template: Vicuna
55
+
56
+ ```
57
+ 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:
58
+
59
+ ```
60
+
61
+ <!-- prompt-template end -->
62
+
63
+ <!-- README_GPTQ.md-provided-files start -->
64
+ ## Provided files and GPTQ parameters
65
+
66
+ Multiple quantisation parameters are provided, to allow you to choose the best one for your hardware and requirements.
67
+
68
+ Each separate quant is in a different branch. See below for instructions on fetching from different branches.
69
+
70
+ All GPTQ files are made with AutoGPTQ.
71
+
72
+ <details>
73
+ <summary>Explanation of GPTQ parameters</summary>
74
+
75
+ - Bits: The bit size of the quantised model.
76
+ - GS: GPTQ group size. Higher numbers use less VRAM, but have lower quantisation accuracy. "None" is the lowest possible value.
77
+ - 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.
78
+ - Damp %: A GPTQ parameter that affects how samples are processed for quantisation. 0.01 is default, but 0.1 results in slightly better accuracy.
79
+ - 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).
80
+ - 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.
81
+ - ExLlama Compatibility: Whether this file can be loaded with ExLlama, which currently only supports Llama models in 4-bit.
82
+
83
+ </details>
84
+
85
+ | Branch | Bits | GS | Act Order | Damp % | GPTQ Dataset | Seq Len | Size | ExLlama | Desc |
86
+ | ------ | ---- | -- | --------- | ------ | ------------ | ------- | ---- | ------- | ---- |
87
+ | [main](https://huggingface.co/TheBloke/fiction.live-Kimiko-V2-70B-GPTQ/tree/main) | 4 | None | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 4096 | 35.33 GB | Yes | Most compatible option. Good inference speed in AutoGPTQ and GPTQ-for-LLaMa. Lower inference quality than other options. |
88
+ | [gptq-4bit-32g-actorder_True](https://huggingface.co/TheBloke/fiction.live-Kimiko-V2-70B-GPTQ/tree/gptq-4bit-32g-actorder_True) | 4 | 32 | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 4096 | 40.66 GB | Yes | 4-bit, with Act Order and group size 32g. Gives highest possible inference quality, with maximum VRAM usage. Poor AutoGPTQ CUDA speed. |
89
+ | [gptq-4bit-64g-actorder_True](https://huggingface.co/TheBloke/fiction.live-Kimiko-V2-70B-GPTQ/tree/gptq-4bit-64g-actorder_True) | 4 | 64 | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 4096 | 37.99 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. |
90
+ | [gptq-4bit-128g-actorder_True](https://huggingface.co/TheBloke/fiction.live-Kimiko-V2-70B-GPTQ/tree/gptq-4bit-128g-actorder_True) | 4 | 128 | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 4096 | 36.65 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. |
91
+ | [gptq-3bit--1g-actorder_True](https://huggingface.co/TheBloke/fiction.live-Kimiko-V2-70B-GPTQ/tree/gptq-3bit--1g-actorder_True) | 3 | None | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 4096 | 26.77 GB | No | 3-bit, with Act Order and no group size. Lowest possible VRAM requirements. May be lower quality than 3-bit 128g. |
92
+ | [gptq-3bit-128g-actorder_True](https://huggingface.co/TheBloke/fiction.live-Kimiko-V2-70B-GPTQ/tree/gptq-3bit-128g-actorder_True) | 3 | 128 | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 4096 | 28.03 GB | No | 3-bit, with group size 128g and act-order. Higher quality than 128g-False but poor AutoGPTQ CUDA speed. |
93
+
94
+ <!-- README_GPTQ.md-provided-files end -->
95
+
96
+ <!-- README_GPTQ.md-download-from-branches start -->
97
+ ## How to download from branches
98
+
99
+ - In text-generation-webui, you can add `:branch` to the end of the download name, eg `TheBloke/fiction.live-Kimiko-V2-70B-GPTQ:gptq-4bit-32g-actorder_True`
100
+ - With Git, you can clone a branch with:
101
+ ```
102
+ git clone --single-branch --branch gptq-4bit-32g-actorder_True https://huggingface.co/TheBloke/fiction.live-Kimiko-V2-70B-GPTQ
103
+ ```
104
+ - In Python Transformers code, the branch is the `revision` parameter; see below.
105
+ <!-- README_GPTQ.md-download-from-branches end -->
106
+ <!-- README_GPTQ.md-text-generation-webui start -->
107
+ ## How to easily download and use this model in [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
108
+
109
+ Please make sure you're using the latest version of [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
110
+
111
+ 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.
112
+
113
+ 1. Click the **Model tab**.
114
+ 2. Under **Download custom model or LoRA**, enter `TheBloke/fiction.live-Kimiko-V2-70B-GPTQ`.
115
+ - To download from a specific branch, enter for example `TheBloke/fiction.live-Kimiko-V2-70B-GPTQ:gptq-4bit-32g-actorder_True`
116
+ - see Provided Files above for the list of branches for each option.
117
+ 3. Click **Download**.
118
+ 4. The model will start downloading. Once it's finished it will say "Done".
119
+ 5. In the top left, click the refresh icon next to **Model**.
120
+ 6. In the **Model** dropdown, choose the model you just downloaded: `fiction.live-Kimiko-V2-70B-GPTQ`
121
+ 7. The model will automatically load, and is now ready for use!
122
+ 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.
123
+ * Note that you do not need to set GPTQ parameters any more. These are set automatically from the file `quantize_config.json`.
124
+ 9. Once you're ready, click the **Text Generation tab** and enter a prompt to get started!
125
+ <!-- README_GPTQ.md-text-generation-webui end -->
126
+
127
+ <!-- README_GPTQ.md-use-from-python start -->
128
+ ## How to use this GPTQ model from Python code
129
+
130
+ ### Install the necessary packages
131
+
132
+ Requires: Transformers 4.32.0 or later, Optimum 1.12.0 or later, and AutoGPTQ 0.4.2 or later.
133
+
134
+ ```shell
135
+ pip3 install transformers>=4.32.0 optimum>=1.12.0
136
+ pip3 install auto-gptq --extra-index-url https://huggingface.github.io/autogptq-index/whl/cu118/ # Use cu117 if on CUDA 11.7
137
+ ```
138
+
139
+ If you have problems installing AutoGPTQ using the pre-built wheels, install it from source instead:
140
+
141
+ ```shell
142
+ pip3 uninstall -y auto-gptq
143
+ git clone https://github.com/PanQiWei/AutoGPTQ
144
+ cd AutoGPTQ
145
+ pip3 install .
146
+ ```
147
+
148
+ ### For CodeLlama models only: you must use Transformers 4.33.0 or later.
149
+
150
+ If 4.33.0 is not yet released when you read this, you will need to install Transformers from source:
151
+ ```shell
152
+ pip3 uninstall -y transformers
153
+ pip3 install git+https://github.com/huggingface/transformers.git
154
+ ```
155
+
156
+ ### You can then use the following code
157
+
158
+ ```python
159
+ from transformers import AutoModelForCausalLM, AutoTokenizer, pipeline
160
+
161
+ model_name_or_path = "TheBloke/fiction.live-Kimiko-V2-70B-GPTQ"
162
+ # To use a different branch, change revision
163
+ # For example: revision="gptq-4bit-32g-actorder_True"
164
+ model = AutoModelForCausalLM.from_pretrained(model_name_or_path,
165
+ torch_dtype=torch.float16,
166
+ device_map="auto",
167
+ revision="main")
168
+
169
+ tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, use_fast=True)
170
+
171
+ prompt = "Tell me about AI"
172
+ 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:
173
+
174
+ '''
175
+
176
+ print("\n\n*** Generate:")
177
+
178
+ input_ids = tokenizer(prompt_template, return_tensors='pt').input_ids.cuda()
179
+ output = model.generate(inputs=input_ids, temperature=0.7, max_new_tokens=512)
180
+ print(tokenizer.decode(output[0]))
181
+
182
+ # Inference can also be done using transformers' pipeline
183
+
184
+ print("*** Pipeline:")
185
+ pipe = pipeline(
186
+ "text-generation",
187
+ model=model,
188
+ tokenizer=tokenizer,
189
+ max_new_tokens=512,
190
+ temperature=0.7,
191
+ top_p=0.95,
192
+ repetition_penalty=1.15
193
+ )
194
+
195
+ print(pipe(prompt_template)[0]['generated_text'])
196
+ ```
197
+ <!-- README_GPTQ.md-use-from-python end -->
198
+
199
+ <!-- README_GPTQ.md-compatibility start -->
200
+ ## Compatibility
201
+
202
+ 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).
203
+
204
+ [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.
205
+
206
+ [Huggingface Text Generation Inference (TGI)](https://github.com/huggingface/text-generation-inference) is compatible with all GPTQ models.
207
+ <!-- README_GPTQ.md-compatibility end -->
208
+
209
+ <!-- footer start -->
210
+ <!-- 200823 -->
211
+ ## Discord
212
+
213
+ For further support, and discussions on these models and AI in general, join us at:
214
+
215
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
216
+
217
+ ## Thanks, and how to contribute.
218
+
219
+ Thanks to the [chirper.ai](https://chirper.ai) team!
220
+
221
+ 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.
222
+
223
+ 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.
224
+
225
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
226
+
227
+ * Patreon: https://patreon.com/TheBlokeAI
228
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
229
+
230
+ **Special thanks to**: Aemon Algiz.
231
+
232
+ **Patreon special mentions**: Kacper Wikieł, knownsqashed, Leonard Tan, Asp the Wyvern, Daniel P. Andersen, Luke Pendergrass, Stanislav Ovsiannikov, RoA, Dave, Ai Maven, Kalila, Will Dee, Imad Khwaja, Nitin Borwankar, Joseph William Delisle, Tony Hughes, Cory Kujawski, Rishabh Srivastava, Russ Johnson, Stephen Murray, Lone Striker, Johann-Peter Hartmann, Elle, J, Deep Realms, SuperWojo, Raven Klaugh, Sebastain Graf, ReadyPlayerEmma, Alps Aficionado, Mano Prime, Derek Yates, Gabriel Puliatti, Mesiah Bishop, Magnesian, Sean Connelly, biorpg, Iucharbius, Olakabola, Fen Risland, Space Cruiser, theTransient, Illia Dulskyi, Thomas Belote, Spencer Kim, Pieter, John Detwiler, Fred von Graf, Michael Davis, Swaroop Kallakuri, subjectnull, Clay Pascal, Subspace Studios, Chris Smitley, Enrico Ros, usrbinkat, Steven Wood, alfie_i, David Ziegler, Willem Michiel, Matthew Berman, Andrey, Pyrater, Jeffrey Morgan, vamX, LangChain4j, Luke @flexchar, Trenton Dambrowitz, Pierre Kircher, Alex, Sam, James Bentley, Edmond Seymore, Eugene Pentland, Pedro Madruga, Rainer Wilmers, Dan Guido, Nathan LeClaire, Spiking Neurons AB, Talal Aujan, zynix, Artur Olbinski, Michael Levine, 阿明, K, John Villwock, Nikolai Manek, Femi Adebogun, senxiiz, Deo Leter, NimbleBox.ai, Viktor Bowallius, Geoffrey Montalvo, Mandus, Ajan Kanaga, ya boyyy, Jonathan Leane, webtim, Brandon Frisco, danny, Alexandros Triantafyllidis, Gabriel Tamborski, Randy H, terasurfer, Vadim, Junyu Yang, Vitor Caleffi, Chadd, transmissions 11
233
+
234
+
235
+ Thank you to all my generous patrons and donaters!
236
+
237
+ And thank you again to a16z for their generous grant.
238
+
239
+ <!-- footer end -->
240
+
241
+ # Original model card: nRuaif's Fiction Live Kimiko V2 70B
242
+
243
+ ## Sponsor
244
+ Thanks to fiction.live for sponsoring this finetune and make this a reality.
245
+
246
+
247
+
248
+ ## Model Details
249
+ [<img src="https://raw.githubusercontent.com/OpenAccess-AI-Collective/axolotl/main/image/axolotl-badge-web.png" alt="Built with Axolotl" width="200" height="32"/>](https://github.com/OpenAccess-AI-Collective/axolotl)
250
+ ### Model Description
251
+
252
+ <!-- Provide a longer summary of what this model is. -->
253
+
254
+
255
+
256
+ - **Developed by:** nRuaif
257
+ - **Model type:** large language model
258
+ - **License:**
259
+ - **Finetuned from model [optional]:** Llama-70B
260
+ ### Model Sources [optional]
261
+
262
+
263
+ ## Uses
264
+
265
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
266
+ The model uses Fastchat/ShareGPT format.
267
+
268
+
269
+ ### Direct Use
270
+
271
+ <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
272
+
273
+ This model is finetuned for normal and erotic roleplay while can still an assistant. (Might not be a helpfull one through)
274
+
275
+
276
+
277
+ ### Out-of-Scope Use
278
+
279
+ <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
280
+ Do anything you want. I don't care
281
+
282
+
283
+ ## Bias, Risks, and Limitations
284
+
285
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
286
+
287
+ Model might have bias to NSFW due to the large % of NSFW data in the training set.
288
+
289
+
290
+
291
+
292
+
293
+
294
+
295
+ ## Training Details
296
+
297
+ ### Training Data
298
+
299
+ <!-- This should link to a Data Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
300
+
301
+
302
+ 3000 convos with 4090 cut off len.
303
+
304
+ ### Training Procedure
305
+
306
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
307
+
308
+
309
+
310
+
311
+ #### Training Hyperparameters
312
+
313
+ - **Training regime:** BF16, QLoRA, constant LR 5e-5 <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
314
+
315
+
316
+
317
+
318
+
319
+
320
+
321
+ ### Compute Infrastructure
322
+
323
+ The model is trained on 1 A100 for 10 hours on runpod.
324
+
325
+