TheBloke commited on
Commit
572e8b9
1 Parent(s): f6101e8

Initial GPTQ model commit

Browse files
Files changed (1) hide show
  1. README.md +246 -0
README.md ADDED
@@ -0,0 +1,246 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ inference: false
3
+ license: other
4
+ model_type: llama
5
+ ---
6
+
7
+ <!-- header start -->
8
+ <div style="width: 100%;">
9
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
10
+ </div>
11
+ <div style="display: flex; justify-content: space-between; width: 100%;">
12
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
13
+ <p><a href="https://discord.gg/theblokeai">Chat & support: my new Discord server</a></p>
14
+ </div>
15
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
16
+ <p><a href="https://www.patreon.com/TheBlokeAI">Want to contribute? TheBloke's Patreon page</a></p>
17
+ </div>
18
+ </div>
19
+ <!-- header end -->
20
+
21
+ # Tap-M's Luna AI Llama2 Uncensored GPTQ
22
+
23
+ These files are GPTQ model files for [Tap-M's Luna AI Llama2 Uncensored](https://huggingface.co/Tap-M/Luna-AI-Llama2-Uncensored).
24
+
25
+ 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.
26
+
27
+ Many thanks to William Beauchamp from [Chai](https://chai-research.com/) for providing the hardware used to make and upload these files!
28
+
29
+ ## Repositories available
30
+
31
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/Luna-AI-Llama2-Uncensored-GPTQ)
32
+ * [2, 3, 4, 5, 6 and 8-bit GGML models for CPU+GPU inference](https://huggingface.co/TheBloke/Luna-AI-Llama2-Uncensored-GGML)
33
+ * [Original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/Tap-M/Luna-AI-Llama2-Uncensored)
34
+
35
+ ## Prompt template: User-Assistant
36
+
37
+ ```
38
+ USER: {prompt}
39
+ ASSISTANT:
40
+ ```
41
+
42
+ ## Provided files
43
+
44
+ Multiple quantisation parameters are provided, to allow you to choose the best one for your hardware and requirements.
45
+
46
+ Each separate quant is in a different branch. See below for instructions on fetching from different branches.
47
+
48
+ | Branch | Bits | Group Size | Act Order (desc_act) | File Size | ExLlama Compatible? | Made With | Description |
49
+ | ------ | ---- | ---------- | -------------------- | --------- | ------------------- | --------- | ----------- |
50
+ | main | 4 | 128 | False | 3.90 GB | True | AutoGPTQ | Most compatible option. Good inference speed in AutoGPTQ and GPTQ-for-LLaMa. Lower inference quality than other options. |
51
+ | gptq-4bit-32g-actorder_True | 4 | 32 | True | 4.28 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. |
52
+ | gptq-4bit-64g-actorder_True | 4 | 64 | True | 4.02 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. |
53
+ | gptq-4bit-128g-actorder_True | 4 | 128 | True | 3.90 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. |
54
+ | gptq-8bit--1g-actorder_True | 8 | None | True | 7.01 GB | False | AutoGPTQ | 8-bit, with Act Order. No group size, to lower VRAM requirements and to improve AutoGPTQ speed. |
55
+ | gptq-8bit-128g-actorder_False | 8 | 128 | False | 7.16 GB | False | AutoGPTQ | 8-bit, with group size 128g for higher inference quality and without Act Order to improve AutoGPTQ speed. |
56
+ | gptq-8bit-128g-actorder_True | 8 | 128 | True | 7.16 GB | False | AutoGPTQ | 8-bit, with group size 128g for higher inference quality and with Act Order for even higher accuracy. Poor AutoGPTQ CUDA speed. |
57
+ | gptq-8bit-64g-actorder_True | 8 | 64 | True | 7.31 GB | False | AutoGPTQ | 8-bit, with group size 64g and Act Order for maximum inference quality. Poor AutoGPTQ CUDA speed. |
58
+
59
+ ## How to download from branches
60
+
61
+ - In text-generation-webui, you can add `:branch` to the end of the download name, eg `TheBloke/Luna-AI-Llama2-Uncensored-GPTQ:gptq-4bit-32g-actorder_True`
62
+ - With Git, you can clone a branch with:
63
+ ```
64
+ git clone --branch gptq-4bit-32g-actorder_True https://huggingface.co/TheBloke/Luna-AI-Llama2-Uncensored-GPTQ`
65
+ ```
66
+ - In Python Transformers code, the branch is the `revision` parameter; see below.
67
+
68
+ ## How to easily download and use this model in [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
69
+
70
+ Please make sure you're using the latest version of [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
71
+
72
+ It is strongly recommended to use the text-generation-webui one-click-installers unless you know how to make a manual install.
73
+
74
+ 1. Click the **Model tab**.
75
+ 2. Under **Download custom model or LoRA**, enter `TheBloke/Luna-AI-Llama2-Uncensored-GPTQ`.
76
+ - To download from a specific branch, enter for example `TheBloke/Luna-AI-Llama2-Uncensored-GPTQ:gptq-4bit-32g-actorder_True`
77
+ - see Provided Files above for the list of branches for each option.
78
+ 3. Click **Download**.
79
+ 4. The model will start downloading. Once it's finished it will say "Done"
80
+ 5. In the top left, click the refresh icon next to **Model**.
81
+ 6. In the **Model** dropdown, choose the model you just downloaded: `Luna-AI-Llama2-Uncensored-GPTQ`
82
+ 7. The model will automatically load, and is now ready for use!
83
+ 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.
84
+ * Note that you do not need to set GPTQ parameters any more. These are set automatically from the file `quantize_config.json`.
85
+ 9. Once you're ready, click the **Text Generation tab** and enter a prompt to get started!
86
+
87
+ ## How to use this GPTQ model from Python code
88
+
89
+ First make sure you have [AutoGPTQ](https://github.com/PanQiWei/AutoGPTQ) installed:
90
+
91
+ `GITHUB_ACTIONS=true pip install auto-gptq`
92
+
93
+ Then try the following example code:
94
+
95
+ ```python
96
+ from transformers import AutoTokenizer, pipeline, logging
97
+ from auto_gptq import AutoGPTQForCausalLM, BaseQuantizeConfig
98
+
99
+ model_name_or_path = "TheBloke/Luna-AI-Llama2-Uncensored-GPTQ"
100
+ model_basename = "gptq_model-4bit-128g"
101
+
102
+ use_triton = False
103
+
104
+ tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, use_fast=True)
105
+
106
+ model = AutoGPTQForCausalLM.from_quantized(model_name_or_path,
107
+ model_basename=model_basename,
108
+ use_safetensors=True,
109
+ trust_remote_code=False,
110
+ device="cuda:0",
111
+ use_triton=use_triton,
112
+ quantize_config=None)
113
+
114
+ """
115
+ To download from a specific branch, use the revision parameter, as in this example:
116
+
117
+ model = AutoGPTQForCausalLM.from_quantized(model_name_or_path,
118
+ revision="gptq-4bit-32g-actorder_True",
119
+ model_basename=model_basename,
120
+ use_safetensors=True,
121
+ trust_remote_code=False,
122
+ device="cuda:0",
123
+ quantize_config=None)
124
+ """
125
+
126
+ prompt = "Tell me about AI"
127
+ prompt_template=f'''USER: {prompt}
128
+ ASSISTANT:
129
+ '''
130
+
131
+ print("\n\n*** Generate:")
132
+
133
+ input_ids = tokenizer(prompt_template, return_tensors='pt').input_ids.cuda()
134
+ output = model.generate(inputs=input_ids, temperature=0.7, max_new_tokens=512)
135
+ print(tokenizer.decode(output[0]))
136
+
137
+ # Inference can also be done using transformers' pipeline
138
+
139
+ # Prevent printing spurious transformers error when using pipeline with AutoGPTQ
140
+ logging.set_verbosity(logging.CRITICAL)
141
+
142
+ print("*** Pipeline:")
143
+ pipe = pipeline(
144
+ "text-generation",
145
+ model=model,
146
+ tokenizer=tokenizer,
147
+ max_new_tokens=512,
148
+ temperature=0.7,
149
+ top_p=0.95,
150
+ repetition_penalty=1.15
151
+ )
152
+
153
+ print(pipe(prompt_template)[0]['generated_text'])
154
+ ```
155
+
156
+ ## Compatibility
157
+
158
+ 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.
159
+
160
+ ExLlama works with Llama models in 4-bit. Please see the Provided Files table above for per-file compatibility.
161
+
162
+ <!-- footer start -->
163
+ ## Discord
164
+
165
+ For further support, and discussions on these models and AI in general, join us at:
166
+
167
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
168
+
169
+ ## Thanks, and how to contribute.
170
+
171
+ Thanks to the [chirper.ai](https://chirper.ai) team!
172
+
173
+ 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.
174
+
175
+ 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.
176
+
177
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
178
+
179
+ * Patreon: https://patreon.com/TheBlokeAI
180
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
181
+
182
+ **Special thanks to**: Luke from CarbonQuill, Aemon Algiz.
183
+
184
+ **Patreon special mentions**: Space Cruiser, Nikolai Manek, Sam, Chris McCloskey, Rishabh Srivastava, Kalila, Spiking Neurons AB, Khalefa Al-Ahmad, WelcomeToTheClub, Chadd, Lone Striker, Viktor Bowallius, Edmond Seymore, Ai Maven, Chris Smitley, Dave, Alexandros Triantafyllidis, Luke @flexchar, Elle, ya boyyy, Talal Aujan, Alex , Jonathan Leane, Deep Realms, Randy H, subjectnull, Preetika Verma, Joseph William Delisle, Michael Levine, chris gileta, K, Oscar Rangel, LangChain4j, Trenton Dambrowitz, Eugene Pentland, Johann-Peter Hartmann, Femi Adebogun, Illia Dulskyi, senxiiz, Daniel P. Andersen, Sean Connelly, Artur Olbinski, RoA, Mano Prime, Derek Yates, Raven Klaugh, David Flickinger, Willem Michiel, Pieter, Willian Hasse, vamX, Luke Pendergrass, webtim, Ghost , Rainer Wilmers, Nathan LeClaire, Will Dee, Cory Kujawski, John Detwiler, Fred von Graf, biorpg, Iucharbius , Imad Khwaja, Pierre Kircher, terasurfer , Asp the Wyvern, John Villwock, theTransient, zynix , Gabriel Tamborski, Fen Risland, Gabriel Puliatti, Matthew Berman, Pyrater, SuperWojo, Stephen Murray, Karl Bernard, Ajan Kanaga, Greatston Gnanesh, Junyu Yang.
185
+
186
+ Thank you to all my generous patrons and donaters!
187
+
188
+ <!-- footer end -->
189
+
190
+ # Original model card: Tap-M's Luna AI Llama2 Uncensored
191
+
192
+
193
+ <div style="width: 800px; margin: auto;">
194
+
195
+ <h2>Model Description</h2>
196
+ <p>“Luna AI Llama2 Uncensored” is a Llama2 based Chat model <br />fine-tuned on over 40,000 long form chat discussions <br />
197
+ This model was fine-tuned by Tap, the creator of Luna AI. <br />
198
+ The result is an enhanced Llama2 7b model that rivals ChatGPT in performance <br />across a variety of tasks.</p>
199
+ <p>This model stands out for its long responses, low hallucination rate, and absence of censorship mechanisms. <br /></p>
200
+
201
+ <h2>Model Training</h2>
202
+ <p>The fine-tuning process was performed on an 8x a100 80GB machine.
203
+ <br />The model was trained almost entirely on synthetic outputs.
204
+ <br />This includes data from diverse sources which we included to create our custom dataset, it includes multiple rounds of chats between Human & AI.
205
+ </p>
206
+
207
+ <h2>Prompt Format</h2>
208
+ <p>The model follows the Vicuna 1.1/ OpenChat format:</p>
209
+
210
+ ```
211
+ USER: I have difficulties in making friends, and I really need someone to talk to. Would you be my friend?
212
+
213
+ ASSISTANT: Of course! Friends are always here for each other. What do you like to do?
214
+
215
+ ```
216
+
217
+
218
+ <h2>Future Plans</h2>
219
+ <p>The model is currently being uploaded in FP16 format, <br />and there are plans to convert the model to GGML and GPTQ 4bit quantizations.</p>
220
+
221
+ <h2>Benchmark Results</h2>
222
+
223
+ ||||||
224
+ |---:|---:|---:|---:|---:|
225
+ |Task|Version| Metric |Value |Stderr|
226
+ |arc_challenge|0|acc_norm|0.5512|0.0146|
227
+ |hellaswag|0||||
228
+ |mmlu|0||||
229
+ |truthfulqa_mc|1|mc2|0.4716|0.0155|
230
+ |Average|-|-|0.5114|0.0150|
231
+
232
+ <h2>Ethical considerations</h2>
233
+ <p>The data used to train the model is collected from various sources, mostly from the Web. <br />
234
+ As such, it contains offensive, harmful and biased content. <br />We thus expect the model to exhibit such biases from the training data.</p>
235
+
236
+ <h2>Human life</h2>
237
+ <p>The model is not intended to inform decisions about matters central to human life, <br />and should not be used in such a way.</p>
238
+
239
+ <h2>Risks and harms</h2>
240
+ <p>Risks and harms of large language models include the generation of harmful, offensive or biased content. <br />
241
+ These models are often prone to generating incorrect information, sometimes referred to as hallucinations.
242
+ <br /> We do not expect our model to be an exception in this regard.</p>
243
+
244
+ </div>
245
+
246
+