TheBloke commited on
Commit
98eee6e
ยท
1 Parent(s): 64963da

Upload README.md

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