TheBloke commited on
Commit
5acd1fb
1 Parent(s): 3f72b06

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +391 -0
README.md ADDED
@@ -0,0 +1,391 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: qblocks/zephyr_7b_norobots
3
+ datasets:
4
+ - HuggingFaceH4/no_robots
5
+ inference: false
6
+ library_name: peft
7
+ license: apache-2.0
8
+ model_creator: MonsterAPI
9
+ model_name: Zephyr 7B Norobots
10
+ model_type: mistral
11
+ prompt_template: '<|system|> </s> <|user|> {prompt} </s> <|assistant|> {{response}}
12
+ </s>
13
+
14
+ '
15
+ quantized_by: TheBloke
16
+ tags:
17
+ - code
18
+ - instruct
19
+ - zephyr
20
+ ---
21
+ <!-- markdownlint-disable MD041 -->
22
+
23
+ <!-- header start -->
24
+ <!-- 200823 -->
25
+ <div style="width: auto; margin-left: auto; margin-right: auto">
26
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
27
+ </div>
28
+ <div style="display: flex; justify-content: space-between; width: 100%;">
29
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
30
+ <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
31
+ </div>
32
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
33
+ <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>
34
+ </div>
35
+ </div>
36
+ <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>
37
+ <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
38
+ <!-- header end -->
39
+
40
+ # Zephyr 7B Norobots - AWQ
41
+ - Model creator: [MonsterAPI](https://huggingface.co/qblocks)
42
+ - Original model: [Zephyr 7B Norobots](https://huggingface.co/qblocks/zephyr_7b_norobots)
43
+
44
+ <!-- description start -->
45
+ ## Description
46
+
47
+ This repo contains AWQ model files for [MonsterAPI's Zephyr 7B Norobots](https://huggingface.co/qblocks/zephyr_7b_norobots).
48
+
49
+ These files were quantised using hardware kindly provided by [Massed Compute](https://massedcompute.com/).
50
+
51
+
52
+ ### About AWQ
53
+
54
+ 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.
55
+
56
+ It is supported by:
57
+
58
+ - [Text Generation Webui](https://github.com/oobabooga/text-generation-webui) - using Loader: AutoAWQ
59
+ - [vLLM](https://github.com/vllm-project/vllm) - Llama and Mistral models only
60
+ - [Hugging Face Text Generation Inference (TGI)](https://github.com/huggingface/text-generation-inference)
61
+ - [Transformers](https://huggingface.co/docs/transformers) version 4.35.0 and later, from any code or client that supports Transformers
62
+ - [AutoAWQ](https://github.com/casper-hansen/AutoAWQ) - for use from Python code
63
+
64
+ <!-- description end -->
65
+ <!-- repositories-available start -->
66
+ ## Repositories available
67
+
68
+ * [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/zephyr_7b_norobots-AWQ)
69
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/zephyr_7b_norobots-GPTQ)
70
+ * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/zephyr_7b_norobots-GGUF)
71
+ * [Unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/TheBloke/zephyr_7b_norobots-fp16)
72
+ * [MonsterAPI's original LoRA adapter, which can be merged on to the base model.](https://huggingface.co/qblocks/zephyr_7b_norobots)
73
+ <!-- repositories-available end -->
74
+
75
+ <!-- prompt-template start -->
76
+ ## Prompt template: NoRobots
77
+
78
+ ```
79
+ <|system|> </s> <|user|> {prompt} </s> <|assistant|> {{response}} </s>
80
+
81
+ ```
82
+
83
+ <!-- prompt-template end -->
84
+
85
+
86
+ <!-- README_AWQ.md-provided-files start -->
87
+ ## Provided files, and AWQ parameters
88
+
89
+ I currently release 128g GEMM models only. The addition of group_size 32 models, and GEMV kernel models, is being actively considered.
90
+
91
+ Models are released as sharded safetensors files.
92
+
93
+ | Branch | Bits | GS | AWQ Dataset | Seq Len | Size |
94
+ | ------ | ---- | -- | ----------- | ------- | ---- |
95
+ | [main](https://huggingface.co/TheBloke/zephyr_7b_norobots-AWQ/tree/main) | 4 | 128 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-raw-v1) | 4096 | 4.15 GB
96
+
97
+ <!-- README_AWQ.md-provided-files end -->
98
+
99
+ <!-- README_AWQ.md-text-generation-webui start -->
100
+ ## How to easily download and use this model in [text-generation-webui](https://github.com/oobabooga/text-generation-webui)
101
+
102
+ Please make sure you're using the latest version of [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
103
+
104
+ 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.
105
+
106
+ 1. Click the **Model tab**.
107
+ 2. Under **Download custom model or LoRA**, enter `TheBloke/zephyr_7b_norobots-AWQ`.
108
+ 3. Click **Download**.
109
+ 4. The model will start downloading. Once it's finished it will say "Done".
110
+ 5. In the top left, click the refresh icon next to **Model**.
111
+ 6. In the **Model** dropdown, choose the model you just downloaded: `zephyr_7b_norobots-AWQ`
112
+ 7. Select **Loader: AutoAWQ**.
113
+ 8. Click Load, and the model will load and is now ready for use.
114
+ 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.
115
+ 10. Once you're ready, click the **Text Generation** tab and enter a prompt to get started!
116
+ <!-- README_AWQ.md-text-generation-webui end -->
117
+
118
+ <!-- README_AWQ.md-use-from-vllm start -->
119
+ ## Multi-user inference server: vLLM
120
+
121
+ Documentation on installing and using vLLM [can be found here](https://vllm.readthedocs.io/en/latest/).
122
+
123
+ - Please ensure you are using vLLM version 0.2 or later.
124
+ - When using vLLM as a server, pass the `--quantization awq` parameter.
125
+
126
+ For example:
127
+
128
+ ```shell
129
+ python3 -m vllm.entrypoints.api_server --model TheBloke/zephyr_7b_norobots-AWQ --quantization awq --dtype auto
130
+ ```
131
+
132
+ - When using vLLM from Python code, again set `quantization=awq`.
133
+
134
+ For example:
135
+
136
+ ```python
137
+ from vllm import LLM, SamplingParams
138
+
139
+ prompts = [
140
+ "Tell me about AI",
141
+ "Write a story about llamas",
142
+ "What is 291 - 150?",
143
+ "How much wood would a woodchuck chuck if a woodchuck could chuck wood?",
144
+ ]
145
+ prompt_template=f'''<|system|> </s> <|user|> {prompt} </s> <|assistant|> {{response}} </s>
146
+ '''
147
+
148
+ prompts = [prompt_template.format(prompt=prompt) for prompt in prompts]
149
+
150
+ sampling_params = SamplingParams(temperature=0.8, top_p=0.95)
151
+
152
+ llm = LLM(model="TheBloke/zephyr_7b_norobots-AWQ", quantization="awq", dtype="auto")
153
+
154
+ outputs = llm.generate(prompts, sampling_params)
155
+
156
+ # Print the outputs.
157
+ for output in outputs:
158
+ prompt = output.prompt
159
+ generated_text = output.outputs[0].text
160
+ print(f"Prompt: {prompt!r}, Generated text: {generated_text!r}")
161
+ ```
162
+ <!-- README_AWQ.md-use-from-vllm start -->
163
+
164
+ <!-- README_AWQ.md-use-from-tgi start -->
165
+ ## Multi-user inference server: Hugging Face Text Generation Inference (TGI)
166
+
167
+ Use TGI version 1.1.0 or later. The official Docker container is: `ghcr.io/huggingface/text-generation-inference:1.1.0`
168
+
169
+ Example Docker parameters:
170
+
171
+ ```shell
172
+ --model-id TheBloke/zephyr_7b_norobots-AWQ --port 3000 --quantize awq --max-input-length 3696 --max-total-tokens 4096 --max-batch-prefill-tokens 4096
173
+ ```
174
+
175
+ Example Python code for interfacing with TGI (requires [huggingface-hub](https://github.com/huggingface/huggingface_hub) 0.17.0 or later):
176
+
177
+ ```shell
178
+ pip3 install huggingface-hub
179
+ ```
180
+
181
+ ```python
182
+ from huggingface_hub import InferenceClient
183
+
184
+ endpoint_url = "https://your-endpoint-url-here"
185
+
186
+ prompt = "Tell me about AI"
187
+ prompt_template=f'''<|system|> </s> <|user|> {prompt} </s> <|assistant|> {{response}} </s>
188
+ '''
189
+
190
+ client = InferenceClient(endpoint_url)
191
+ response = client.text_generation(prompt,
192
+ max_new_tokens=128,
193
+ do_sample=True,
194
+ temperature=0.7,
195
+ top_p=0.95,
196
+ top_k=40,
197
+ repetition_penalty=1.1)
198
+
199
+ print(f"Model output: ", response)
200
+ ```
201
+ <!-- README_AWQ.md-use-from-tgi end -->
202
+
203
+ <!-- README_AWQ.md-use-from-python start -->
204
+ ## Inference from Python code using Transformers
205
+
206
+ ### Install the necessary packages
207
+
208
+ - Requires: [Transformers](https://huggingface.co/docs/transformers) 4.35.0 or later.
209
+ - Requires: [AutoAWQ](https://github.com/casper-hansen/AutoAWQ) 0.1.6 or later.
210
+
211
+ ```shell
212
+ pip3 install --upgrade "autoawq>=0.1.6" "transformers>=4.35.0"
213
+ ```
214
+
215
+ Note that if you are using PyTorch 2.0.1, the above AutoAWQ command will automatically upgrade you to PyTorch 2.1.0.
216
+
217
+ If you are using CUDA 11.8 and wish to continue using PyTorch 2.0.1, instead run this command:
218
+
219
+ ```shell
220
+ pip3 install https://github.com/casper-hansen/AutoAWQ/releases/download/v0.1.6/autoawq-0.1.6+cu118-cp310-cp310-linux_x86_64.whl
221
+ ```
222
+
223
+ If you have problems installing [AutoAWQ](https://github.com/casper-hansen/AutoAWQ) using the pre-built wheels, install it from source instead:
224
+
225
+ ```shell
226
+ pip3 uninstall -y autoawq
227
+ git clone https://github.com/casper-hansen/AutoAWQ
228
+ cd AutoAWQ
229
+ pip3 install .
230
+ ```
231
+
232
+ ### Transformers example code (requires Transformers 4.35.0 and later)
233
+
234
+ ```python
235
+ from transformers import AutoModelForCausalLM, AutoTokenizer, TextStreamer
236
+
237
+ model_name_or_path = "TheBloke/zephyr_7b_norobots-AWQ"
238
+
239
+ tokenizer = AutoTokenizer.from_pretrained(model_name_or_path)
240
+ model = AutoModelForCausalLM.from_pretrained(
241
+ model_name_or_path,
242
+ low_cpu_mem_usage=True,
243
+ device_map="cuda:0"
244
+ )
245
+
246
+ # Using the text streamer to stream output one token at a time
247
+ streamer = TextStreamer(tokenizer, skip_prompt=True, skip_special_tokens=True)
248
+
249
+ prompt = "Tell me about AI"
250
+ prompt_template=f'''<|system|> </s> <|user|> {prompt} </s> <|assistant|> {{response}} </s>
251
+ '''
252
+
253
+ # Convert prompt to tokens
254
+ tokens = tokenizer(
255
+ prompt_template,
256
+ return_tensors='pt'
257
+ ).input_ids.cuda()
258
+
259
+ generation_params = {
260
+ "do_sample": True,
261
+ "temperature": 0.7,
262
+ "top_p": 0.95,
263
+ "top_k": 40,
264
+ "max_new_tokens": 512,
265
+ "repetition_penalty": 1.1
266
+ }
267
+
268
+ # Generate streamed output, visible one token at a time
269
+ generation_output = model.generate(
270
+ tokens,
271
+ streamer=streamer,
272
+ **generation_params
273
+ )
274
+
275
+ # Generation without a streamer, which will include the prompt in the output
276
+ generation_output = model.generate(
277
+ tokens,
278
+ **generation_params
279
+ )
280
+
281
+ # Get the tokens from the output, decode them, print them
282
+ token_output = generation_output[0]
283
+ text_output = tokenizer.decode(token_output)
284
+ print("model.generate output: ", text_output)
285
+
286
+ # Inference is also possible via Transformers' pipeline
287
+ from transformers import pipeline
288
+
289
+ pipe = pipeline(
290
+ "text-generation",
291
+ model=model,
292
+ tokenizer=tokenizer,
293
+ **generation_params
294
+ )
295
+
296
+ pipe_output = pipe(prompt_template)[0]['generated_text']
297
+ print("pipeline output: ", pipe_output)
298
+
299
+ ```
300
+ <!-- README_AWQ.md-use-from-python end -->
301
+
302
+ <!-- README_AWQ.md-compatibility start -->
303
+ ## Compatibility
304
+
305
+ The files provided are tested to work with:
306
+
307
+ - [text-generation-webui](https://github.com/oobabooga/text-generation-webui) using `Loader: AutoAWQ`.
308
+ - [vLLM](https://github.com/vllm-project/vllm) version 0.2.0 and later.
309
+ - [Hugging Face Text Generation Inference (TGI)](https://github.com/huggingface/text-generation-inference) version 1.1.0 and later.
310
+ - [Transformers](https://huggingface.co/docs/transformers) version 4.35.0 and later.
311
+ - [AutoAWQ](https://github.com/casper-hansen/AutoAWQ) version 0.1.1 and later.
312
+
313
+ <!-- README_AWQ.md-compatibility end -->
314
+
315
+ <!-- footer start -->
316
+ <!-- 200823 -->
317
+ ## Discord
318
+
319
+ For further support, and discussions on these models and AI in general, join us at:
320
+
321
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
322
+
323
+ ## Thanks, and how to contribute
324
+
325
+ Thanks to the [chirper.ai](https://chirper.ai) team!
326
+
327
+ Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
328
+
329
+ 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.
330
+
331
+ 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.
332
+
333
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
334
+
335
+ * Patreon: https://patreon.com/TheBlokeAI
336
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
337
+
338
+ **Special thanks to**: Aemon Algiz.
339
+
340
+ **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
341
+
342
+
343
+ Thank you to all my generous patrons and donaters!
344
+
345
+ And thank you again to a16z for their generous grant.
346
+
347
+ <!-- footer end -->
348
+
349
+ # Original model card: MonsterAPI's Zephyr 7B Norobots
350
+
351
+
352
+ ### Finetuning Overview:
353
+
354
+ **Model Used:** HuggingFaceH4/zephyr-7b-alpha
355
+
356
+ **Dataset:** HuggingFaceH4/no_robots
357
+
358
+ #### Dataset Insights:
359
+
360
+ [No Robots](https://huggingface.co/datasets/HuggingFaceH4/no_robots) is a high-quality dataset of 10,000 instructions and demonstrations created by skilled human annotators. This data can be used for supervised fine-tuning (SFT) to make language models follow instructions better.
361
+
362
+ #### Finetuning Details:
363
+
364
+ With the utilization of [MonsterAPI](https://monsterapi.ai)'s [LLM finetuner](https://docs.monsterapi.ai/fine-tune-a-large-language-model-llm), this finetuning:
365
+
366
+ - Was achieved with great cost-effectiveness.
367
+ - Completed in a total duration of 36mins 47secs for 1 epoch using an A6000 48GB GPU.
368
+ - Costed `$1.212` for the entire epoch.
369
+
370
+ #### Hyperparameters & Additional Details:
371
+
372
+ - **Epochs:** 1
373
+ - **Cost Per Epoch:** $1.212
374
+ - **Total Finetuning Cost:** $1.212
375
+ - **Model Path:** HuggingFaceH4/zephyr-7b-alpha
376
+ - **Learning Rate:** 0.0002
377
+ - **Data Split:** 100% train
378
+ - **Gradient Accumulation Steps:** 4
379
+ - **lora r:** 32
380
+ - **lora alpha:** 64
381
+
382
+ ---
383
+ #### Prompt Structure
384
+ ```
385
+ <|system|> <|endoftext|> <|user|> [USER PROMPT]<|endoftext|> <|assistant|> [ASSISTANT ANSWER] <|endoftext|>
386
+ ```
387
+ #### Train loss :
388
+
389
+ ![training loss](https://cdn-uploads.huggingface.co/production/uploads/63ba46aa0a9866b28cb19a14/EYUTlcPFz-2nXzNj5_gsW.png)
390
+
391
+ license: apache-2.0