TheBloke commited on
Commit
af678bb
1 Parent(s): 7992844

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +401 -0
README.md ADDED
@@ -0,0 +1,401 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: ajibawa-2023/Uncensored-Jordan-7B
3
+ inference: false
4
+ language:
5
+ - en
6
+ license: other
7
+ model_creator: Feynman Innovations
8
+ model_name: Uncensored Jordan 7B
9
+ model_type: llama
10
+ prompt_template: 'This is a conversation with your Uncensored AI assistant Jordan.
11
+ Jordan can discuss with you at length about various topics such as ---, ---, ---,
12
+ . You can ask it anything you want and it will do its best to give you accurate
13
+ and relevant information.
14
+
15
+
16
+ Context
17
+
18
+ You are a Uncensored AI assistant.
19
+
20
+
21
+ USER: {prompt}
22
+
23
+ ASSISTANT:
24
+
25
+ '
26
+ quantized_by: TheBloke
27
+ ---
28
+ <!-- markdownlint-disable MD041 -->
29
+
30
+ <!-- header start -->
31
+ <!-- 200823 -->
32
+ <div style="width: auto; margin-left: auto; margin-right: auto">
33
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
34
+ </div>
35
+ <div style="display: flex; justify-content: space-between; width: 100%;">
36
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
37
+ <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
38
+ </div>
39
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
40
+ <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>
41
+ </div>
42
+ </div>
43
+ <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>
44
+ <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
45
+ <!-- header end -->
46
+
47
+ # Uncensored Jordan 7B - AWQ
48
+ - Model creator: [Feynman Innovations](https://huggingface.co/ajibawa-2023)
49
+ - Original model: [Uncensored Jordan 7B](https://huggingface.co/ajibawa-2023/Uncensored-Jordan-7B)
50
+
51
+ <!-- description start -->
52
+ ## Description
53
+
54
+ This repo contains AWQ model files for [Feynman Innovations's Uncensored Jordan 7B](https://huggingface.co/ajibawa-2023/Uncensored-Jordan-7B).
55
+
56
+ These files were quantised using hardware kindly provided by [Massed Compute](https://massedcompute.com/).
57
+
58
+
59
+ ### About AWQ
60
+
61
+ AWQ is an efficient, accurate and blazing-fast low-bit weight quantization method, currently supporting 4-bit quantization. Compared to GPTQ, it offers faster Transformers-based inference with equivalent or better quality compared to the most commonly used GPTQ settings.
62
+
63
+ It is supported by:
64
+
65
+ - [Text Generation Webui](https://github.com/oobabooga/text-generation-webui) - using Loader: AutoAWQ
66
+ - [vLLM](https://github.com/vllm-project/vllm) - Llama and Mistral models only
67
+ - [Hugging Face Text Generation Inference (TGI)](https://github.com/huggingface/text-generation-inference)
68
+ - [AutoAWQ](https://github.com/casper-hansen/AutoAWQ) - for use from Python code
69
+
70
+ <!-- description end -->
71
+ <!-- repositories-available start -->
72
+ ## Repositories available
73
+
74
+ * [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/Uncensored-Jordan-7B-AWQ)
75
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/Uncensored-Jordan-7B-GPTQ)
76
+ * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/Uncensored-Jordan-7B-GGUF)
77
+ * [Feynman Innovations's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/ajibawa-2023/Uncensored-Jordan-7B)
78
+ <!-- repositories-available end -->
79
+
80
+ <!-- prompt-template start -->
81
+ ## Prompt template: Jordan
82
+
83
+ ```
84
+ This is a conversation with your Uncensored AI assistant Jordan. Jordan can discuss with you at length about various topics such as ---, ---, ---, . You can ask it anything you want and it will do its best to give you accurate and relevant information.
85
+
86
+ Context
87
+ You are a Uncensored AI assistant.
88
+
89
+ USER: {prompt}
90
+ ASSISTANT:
91
+
92
+ ```
93
+
94
+ <!-- prompt-template end -->
95
+
96
+
97
+ <!-- README_AWQ.md-provided-files start -->
98
+ ## Provided files, and AWQ parameters
99
+
100
+ For my first release of AWQ models, I am releasing 128g models only. I will consider adding 32g as well if there is interest, and once I have done perplexity and evaluation comparisons, but at this time 32g models are still not fully tested with AutoAWQ and vLLM.
101
+
102
+ Models are released as sharded safetensors files.
103
+
104
+ | Branch | Bits | GS | AWQ Dataset | Seq Len | Size |
105
+ | ------ | ---- | -- | ----------- | ------- | ---- |
106
+ | [main](https://huggingface.co/TheBloke/Uncensored-Jordan-7B-AWQ/tree/main) | 4 | 128 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 2048 | 3.89 GB
107
+
108
+ <!-- README_AWQ.md-provided-files end -->
109
+
110
+ <!-- README_AWQ.md-text-generation-webui start -->
111
+ ## How to easily download and use this model in [text-generation-webui](https://github.com/oobabooga/text-generation-webui)
112
+
113
+ Please make sure you're using the latest version of [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
114
+
115
+ 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.
116
+
117
+ 1. Click the **Model tab**.
118
+ 2. Under **Download custom model or LoRA**, enter `TheBloke/Uncensored-Jordan-7B-AWQ`.
119
+ 3. Click **Download**.
120
+ 4. The model will start downloading. Once it's finished it will say "Done".
121
+ 5. In the top left, click the refresh icon next to **Model**.
122
+ 6. In the **Model** dropdown, choose the model you just downloaded: `Uncensored-Jordan-7B-AWQ`
123
+ 7. Select **Loader: AutoAWQ**.
124
+ 8. Click Load, and the model will load and is now ready for use.
125
+ 9. 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.
126
+ 10. Once you're ready, click the **Text Generation** tab and enter a prompt to get started!
127
+ <!-- README_AWQ.md-text-generation-webui end -->
128
+
129
+ <!-- README_AWQ.md-use-from-vllm start -->
130
+ ## Multi-user inference server: vLLM
131
+
132
+ Documentation on installing and using vLLM [can be found here](https://vllm.readthedocs.io/en/latest/).
133
+
134
+ - Please ensure you are using vLLM version 0.2 or later.
135
+ - When using vLLM as a server, pass the `--quantization awq` parameter.
136
+
137
+ For example:
138
+
139
+ ```shell
140
+ python3 python -m vllm.entrypoints.api_server --model TheBloke/Uncensored-Jordan-7B-AWQ --quantization awq
141
+ ```
142
+
143
+ - When using vLLM from Python code, again set `quantization=awq`.
144
+
145
+ For example:
146
+
147
+ ```python
148
+ from vllm import LLM, SamplingParams
149
+
150
+ prompts = [
151
+ "Tell me about AI",
152
+ "Write a story about llamas",
153
+ "What is 291 - 150?",
154
+ "How much wood would a woodchuck chuck if a woodchuck could chuck wood?",
155
+ ]
156
+ prompt_template=f'''This is a conversation with your Uncensored AI assistant Jordan. Jordan can discuss with you at length about various topics such as ---, ---, ---, . You can ask it anything you want and it will do its best to give you accurate and relevant information.
157
+
158
+ Context
159
+ You are a Uncensored AI assistant.
160
+
161
+ USER: {prompt}
162
+ ASSISTANT:
163
+ '''
164
+
165
+ prompts = [prompt_template.format(prompt=prompt) for prompt in prompts]
166
+
167
+ sampling_params = SamplingParams(temperature=0.8, top_p=0.95)
168
+
169
+ llm = LLM(model="TheBloke/Uncensored-Jordan-7B-AWQ", quantization="awq", dtype="auto")
170
+
171
+ outputs = llm.generate(prompts, sampling_params)
172
+
173
+ # Print the outputs.
174
+ for output in outputs:
175
+ prompt = output.prompt
176
+ generated_text = output.outputs[0].text
177
+ print(f"Prompt: {prompt!r}, Generated text: {generated_text!r}")
178
+ ```
179
+ <!-- README_AWQ.md-use-from-vllm start -->
180
+
181
+ <!-- README_AWQ.md-use-from-tgi start -->
182
+ ## Multi-user inference server: Hugging Face Text Generation Inference (TGI)
183
+
184
+ Use TGI version 1.1.0 or later. The official Docker container is: `ghcr.io/huggingface/text-generation-inference:1.1.0`
185
+
186
+ Example Docker parameters:
187
+
188
+ ```shell
189
+ --model-id TheBloke/Uncensored-Jordan-7B-AWQ --port 3000 --quantize awq --max-input-length 3696 --max-total-tokens 4096 --max-batch-prefill-tokens 4096
190
+ ```
191
+
192
+ Example Python code for interfacing with TGI (requires [huggingface-hub](https://github.com/huggingface/huggingface_hub) 0.17.0 or later):
193
+
194
+ ```shell
195
+ pip3 install huggingface-hub
196
+ ```
197
+
198
+ ```python
199
+ from huggingface_hub import InferenceClient
200
+
201
+ endpoint_url = "https://your-endpoint-url-here"
202
+
203
+ prompt = "Tell me about AI"
204
+ prompt_template=f'''This is a conversation with your Uncensored AI assistant Jordan. Jordan can discuss with you at length about various topics such as ---, ---, ---, . You can ask it anything you want and it will do its best to give you accurate and relevant information.
205
+
206
+ Context
207
+ You are a Uncensored AI assistant.
208
+
209
+ USER: {prompt}
210
+ ASSISTANT:
211
+ '''
212
+
213
+ client = InferenceClient(endpoint_url)
214
+ response = client.text_generation(prompt,
215
+ max_new_tokens=128,
216
+ do_sample=True,
217
+ temperature=0.7,
218
+ top_p=0.95,
219
+ top_k=40,
220
+ repetition_penalty=1.1)
221
+
222
+ print(f"Model output: ", response)
223
+ ```
224
+ <!-- README_AWQ.md-use-from-tgi end -->
225
+
226
+ <!-- README_AWQ.md-use-from-python start -->
227
+ ## Inference from Python code using AutoAWQ
228
+
229
+ ### Install the AutoAWQ package
230
+
231
+ Requires: [AutoAWQ](https://github.com/casper-hansen/AutoAWQ) 0.1.1 or later.
232
+
233
+ ```shell
234
+ pip3 install autoawq
235
+ ```
236
+
237
+ If you have problems installing [AutoAWQ](https://github.com/casper-hansen/AutoAWQ) using the pre-built wheels, install it from source instead:
238
+
239
+ ```shell
240
+ pip3 uninstall -y autoawq
241
+ git clone https://github.com/casper-hansen/AutoAWQ
242
+ cd AutoAWQ
243
+ pip3 install .
244
+ ```
245
+
246
+ ### AutoAWQ example code
247
+
248
+ ```python
249
+ from awq import AutoAWQForCausalLM
250
+ from transformers import AutoTokenizer
251
+
252
+ model_name_or_path = "TheBloke/Uncensored-Jordan-7B-AWQ"
253
+
254
+ # Load tokenizer
255
+ tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, trust_remote_code=False)
256
+ # Load model
257
+ model = AutoAWQForCausalLM.from_quantized(model_name_or_path, fuse_layers=True,
258
+ trust_remote_code=False, safetensors=True)
259
+
260
+ prompt = "Tell me about AI"
261
+ prompt_template=f'''This is a conversation with your Uncensored AI assistant Jordan. Jordan can discuss with you at length about various topics such as ---, ---, ---, . You can ask it anything you want and it will do its best to give you accurate and relevant information.
262
+
263
+ Context
264
+ You are a Uncensored AI assistant.
265
+
266
+ USER: {prompt}
267
+ ASSISTANT:
268
+ '''
269
+
270
+ print("*** Running model.generate:")
271
+
272
+ token_input = tokenizer(
273
+ prompt_template,
274
+ return_tensors='pt'
275
+ ).input_ids.cuda()
276
+
277
+ # Generate output
278
+ generation_output = model.generate(
279
+ token_input,
280
+ do_sample=True,
281
+ temperature=0.7,
282
+ top_p=0.95,
283
+ top_k=40,
284
+ max_new_tokens=512
285
+ )
286
+
287
+ # Get the tokens from the output, decode them, print them
288
+ token_output = generation_output[0]
289
+ text_output = tokenizer.decode(token_output)
290
+ print("LLM output: ", text_output)
291
+
292
+ """
293
+ # Inference should be possible with transformers pipeline as well in future
294
+ # But currently this is not yet supported by AutoAWQ (correct as of September 25th 2023)
295
+ from transformers import pipeline
296
+
297
+ print("*** Pipeline:")
298
+ pipe = pipeline(
299
+ "text-generation",
300
+ model=model,
301
+ tokenizer=tokenizer,
302
+ max_new_tokens=512,
303
+ do_sample=True,
304
+ temperature=0.7,
305
+ top_p=0.95,
306
+ top_k=40,
307
+ repetition_penalty=1.1
308
+ )
309
+
310
+ print(pipe(prompt_template)[0]['generated_text'])
311
+ """
312
+ ```
313
+ <!-- README_AWQ.md-use-from-python end -->
314
+
315
+ <!-- README_AWQ.md-compatibility start -->
316
+ ## Compatibility
317
+
318
+ The files provided are tested to work with:
319
+
320
+ - [text-generation-webui](https://github.com/oobabooga/text-generation-webui) using `Loader: AutoAWQ`.
321
+ - [vLLM](https://github.com/vllm-project/vllm) version 0.2.0 and later.
322
+ - [Hugging Face Text Generation Inference (TGI)](https://github.com/huggingface/text-generation-inference) version 1.1.0 and later.
323
+ - [AutoAWQ](https://github.com/casper-hansen/AutoAWQ) version 0.1.1 and later.
324
+
325
+ <!-- README_AWQ.md-compatibility end -->
326
+
327
+ <!-- footer start -->
328
+ <!-- 200823 -->
329
+ ## Discord
330
+
331
+ For further support, and discussions on these models and AI in general, join us at:
332
+
333
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
334
+
335
+ ## Thanks, and how to contribute
336
+
337
+ Thanks to the [chirper.ai](https://chirper.ai) team!
338
+
339
+ Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
340
+
341
+ 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.
342
+
343
+ 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.
344
+
345
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
346
+
347
+ * Patreon: https://patreon.com/TheBlokeAI
348
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
349
+
350
+ **Special thanks to**: Aemon Algiz.
351
+
352
+ **Patreon special mentions**: Brandon Frisco, LangChain4j, Spiking Neurons AB, transmissions 11, Joseph William Delisle, Nitin Borwankar, Willem Michiel, Michael Dempsey, vamX, Jeffrey Morgan, zynix, jjj, Omer Bin Jawed, Sean Connelly, jinyuan sun, Jeromy Smith, Shadi, Pawan Osman, Chadd, Elijah Stavena, Illia Dulskyi, Sebastain Graf, Stephen Murray, terasurfer, Edmond Seymore, Celu Ramasamy, Mandus, Alex, biorpg, Ajan Kanaga, Clay Pascal, Raven Klaugh, 阿明, K, ya boyyy, usrbinkat, Alicia Loh, John Villwock, ReadyPlayerEmma, Chris Smitley, Cap'n Zoog, fincy, GodLy, S_X, sidney chen, Cory Kujawski, OG, Mano Prime, AzureBlack, Pieter, Kalila, Spencer Kim, Tom X Nguyen, Stanislav Ovsiannikov, Michael Levine, Andrey, Trailburnt, Vadim, Enrico Ros, Talal Aujan, Brandon Phillips, Jack West, Eugene Pentland, Michael Davis, Will Dee, webtim, Jonathan Leane, Alps Aficionado, Rooh Singh, Tiffany J. Kim, theTransient, Luke @flexchar, Elle, Caitlyn Gatomon, Ari Malik, subjectnull, Johann-Peter Hartmann, Trenton Dambrowitz, Imad Khwaja, Asp the Wyvern, Emad Mostaque, Rainer Wilmers, Alexandros Triantafyllidis, Nicholas, Pedro Madruga, SuperWojo, Harry Royden McLaughlin, James Bentley, Olakabola, David Ziegler, Ai Maven, Jeff Scroggin, Nikolai Manek, Deo Leter, Matthew Berman, Fen Risland, Ken Nordquist, Manuel Alberto Morcote, Luke Pendergrass, TL, Fred von Graf, Randy H, Dan Guido, NimbleBox.ai, Vitor Caleffi, Gabriel Tamborski, knownsqashed, Lone Striker, Erik Bjäreholt, John Detwiler, Leonard Tan, Iucharbius
353
+
354
+
355
+ Thank you to all my generous patrons and donaters!
356
+
357
+ And thank you again to a16z for their generous grant.
358
+
359
+ <!-- footer end -->
360
+
361
+ # Original model card: Feynman Innovations's Uncensored Jordan 7B
362
+
363
+
364
+ **Jordan: An Uncensored Model**
365
+
366
+ The name "Jordan" pays homage to the charismatic character Jordan Belfort, portrayed by Leonardo DiCaprio in the movie "The Wolf of Wall Street."
367
+ Just like the character, Jordan aspires to push boundaries and encourage unfiltered conversations.
368
+ Jordan Belfort, the central character in "The Wolf of Wall Street," is known for his audaciousness, charisma, and willingness to speak about anything, no matter the societal norms or boundaries.
369
+ Jordan, the AI language model, draws inspiration from these qualities to offer a space where users can discuss a wide range of topics without fear of censorship or constraints.
370
+ Users can engage in candid discussions about politics, religion, contentious issues, and other subjects that might be off-limits on mainstream social media platforms.
371
+ It is trained on around 155000 set of conversations. Each set having 10~15 conversations. We will not release this data.
372
+
373
+ **Warning**
374
+
375
+ An uncensored model has no or little guardrails. You are responsible for anything you do with the model, just as you are responsible for anything you do with any dangerous objects.
376
+ Publishing anything this model generates is the same as publishing it yourself. We are not responsible for what you generate using this model.
377
+
378
+ **Training:**
379
+ Entire dataset was trained on Azure 4 x A100 80GB. For 3 epoch, training took 28 hours. DeepSpeed codebase was used for training purpose. This was trained on Llama-1 by Meta.
380
+ Llama-1 was used as it is very useful for Uncensored conversation.
381
+
382
+ **GPTQ GGML & AWQ**
383
+
384
+ GPTQ: TBA
385
+
386
+ GGUF: TBA
387
+
388
+ AWQ: TBA
389
+
390
+
391
+
392
+ **Example Prompt:**
393
+ ```
394
+ This is a conversation with your Uncensored AI assistant Jordan. Jordan can discuss with you at length about various topics such as ---, ---, ---, . You can ask it anything you want and it will do its best to give you accurate and relevant information.
395
+
396
+ Context
397
+ You are a Uncensored AI assistant.
398
+
399
+ USER: <prompt>
400
+ ASSISTANT:
401
+ ```