TheBloke commited on
Commit
9e977d8
1 Parent(s): dd3e277

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +480 -0
README.md ADDED
@@ -0,0 +1,480 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: HuggingFaceH4/zephyr-7b-alpha
3
+ datasets:
4
+ - stingning/ultrachat
5
+ - openbmb/UltraFeedback
6
+ inference: false
7
+ language:
8
+ - en
9
+ license: cc-by-nc-4.0
10
+ model-index:
11
+ - name: zephyr-7b-alpha
12
+ results: []
13
+ model_creator: Hugging Face H4
14
+ model_name: Zephyr 7B Alpha
15
+ model_type: mistral
16
+ prompt_template: '<|system|>
17
+
18
+ </s>
19
+
20
+ <|user|>
21
+
22
+ {prompt}</s>
23
+
24
+ <|assistant|>
25
+
26
+ '
27
+ quantized_by: TheBloke
28
+ tags:
29
+ - generated_from_trainer
30
+ ---
31
+
32
+ <!-- header start -->
33
+ <!-- 200823 -->
34
+ <div style="width: auto; margin-left: auto; margin-right: auto">
35
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
36
+ </div>
37
+ <div style="display: flex; justify-content: space-between; width: 100%;">
38
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
39
+ <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
40
+ </div>
41
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
42
+ <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>
43
+ </div>
44
+ </div>
45
+ <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>
46
+ <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
47
+ <!-- header end -->
48
+
49
+ # Zephyr 7B Alpha - GPTQ
50
+ - Model creator: [Hugging Face H4](https://huggingface.co/HuggingFaceH4)
51
+ - Original model: [Zephyr 7B Alpha](https://huggingface.co/HuggingFaceH4/zephyr-7b-alpha)
52
+
53
+ <!-- description start -->
54
+ ## Description
55
+
56
+ This repo contains GPTQ model files for [Hugging Face H4's Zephyr 7B Alpha](https://huggingface.co/HuggingFaceH4/zephyr-7b-alpha).
57
+
58
+ 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.
59
+
60
+ <!-- description end -->
61
+ <!-- repositories-available start -->
62
+ ## Repositories available
63
+
64
+ * [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/zephyr-7B-alpha-AWQ)
65
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/zephyr-7B-alpha-GPTQ)
66
+ * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/zephyr-7B-alpha-GGUF)
67
+ * [Hugging Face H4's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/HuggingFaceH4/zephyr-7b-alpha)
68
+ <!-- repositories-available end -->
69
+
70
+ <!-- prompt-template start -->
71
+ ## Prompt template: Zephyr
72
+
73
+ ```
74
+ <|system|>
75
+ </s>
76
+ <|user|>
77
+ {prompt}</s>
78
+ <|assistant|>
79
+
80
+ ```
81
+
82
+ <!-- prompt-template end -->
83
+
84
+
85
+ <!-- README_GPTQ.md-provided-files start -->
86
+ ## Provided files, and GPTQ parameters
87
+
88
+ Multiple quantisation parameters are provided, to allow you to choose the best one for your hardware and requirements.
89
+
90
+ Each separate quant is in a different branch. See below for instructions on fetching from different branches.
91
+
92
+ Most GPTQ files are made with AutoGPTQ. Mistral models are currently made with Transformers.
93
+
94
+ <details>
95
+ <summary>Explanation of GPTQ parameters</summary>
96
+
97
+ - Bits: The bit size of the quantised model.
98
+ - GS: GPTQ group size. Higher numbers use less VRAM, but have lower quantisation accuracy. "None" is the lowest possible value.
99
+ - 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.
100
+ - Damp %: A GPTQ parameter that affects how samples are processed for quantisation. 0.01 is default, but 0.1 results in slightly better accuracy.
101
+ - GPTQ dataset: The calibration dataset used during quantisation. Using a dataset more appropriate to the model's training can improve quantisation accuracy. Note that the GPTQ calibration 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).
102
+ - 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.
103
+ - ExLlama Compatibility: Whether this file can be loaded with ExLlama, which currently only supports Llama models in 4-bit.
104
+
105
+ </details>
106
+
107
+ | Branch | Bits | GS | Act Order | Damp % | GPTQ Dataset | Seq Len | Size | ExLlama | Desc |
108
+ | ------ | ---- | -- | --------- | ------ | ------------ | ------- | ---- | ------- | ---- |
109
+ | [main](https://huggingface.co/TheBloke/zephyr-7B-alpha-GPTQ/tree/main) | 4 | 128 | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 4095 | 4.16 GB | Yes | 4-bit, with Act Order and group size 128g. Uses even less VRAM than 64g, but with slightly lower accuracy. |
110
+ | [gptq-4bit-32g-actorder_True](https://huggingface.co/TheBloke/zephyr-7B-alpha-GPTQ/tree/gptq-4bit-32g-actorder_True) | 4 | 32 | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 4095 | 4.57 GB | Yes | 4-bit, with Act Order and group size 32g. Gives highest possible inference quality, with maximum VRAM usage. |
111
+ | [gptq-8bit--1g-actorder_True](https://huggingface.co/TheBloke/zephyr-7B-alpha-GPTQ/tree/gptq-8bit--1g-actorder_True) | 8 | None | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 4095 | 7.52 GB | No | 8-bit, with Act Order. No group size, to lower VRAM requirements. |
112
+ | [gptq-8bit-128g-actorder_True](https://huggingface.co/TheBloke/zephyr-7B-alpha-GPTQ/tree/gptq-8bit-128g-actorder_True) | 8 | 128 | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 4095 | 7.68 GB | No | 8-bit, with group size 128g for higher inference quality and with Act Order for even higher accuracy. |
113
+ | [gptq-8bit-32g-actorder_True](https://huggingface.co/TheBloke/zephyr-7B-alpha-GPTQ/tree/gptq-8bit-32g-actorder_True) | 8 | 32 | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 4095 | 8.17 GB | No | 8-bit, with group size 32g and Act Order for maximum inference quality. |
114
+ | [gptq-4bit-64g-actorder_True](https://huggingface.co/TheBloke/zephyr-7B-alpha-GPTQ/tree/gptq-4bit-64g-actorder_True) | 4 | 64 | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 4095 | 4.29 GB | Yes | 4-bit, with Act Order and group size 64g. Uses less VRAM than 32g, but with slightly lower accuracy. |
115
+
116
+ <!-- README_GPTQ.md-provided-files end -->
117
+
118
+ <!-- README_GPTQ.md-download-from-branches start -->
119
+ ## How to download, including from branches
120
+
121
+ ### In text-generation-webui
122
+
123
+ To download from the `main` branch, enter `TheBloke/zephyr-7B-alpha-GPTQ` in the "Download model" box.
124
+
125
+ To download from another branch, add `:branchname` to the end of the download name, eg `TheBloke/zephyr-7B-alpha-GPTQ:gptq-4bit-32g-actorder_True`
126
+
127
+ ### From the command line
128
+
129
+ I recommend using the `huggingface-hub` Python library:
130
+
131
+ ```shell
132
+ pip3 install huggingface-hub
133
+ ```
134
+
135
+ To download the `main` branch to a folder called `zephyr-7B-alpha-GPTQ`:
136
+
137
+ ```shell
138
+ mkdir zephyr-7B-alpha-GPTQ
139
+ huggingface-cli download TheBloke/zephyr-7B-alpha-GPTQ --local-dir zephyr-7B-alpha-GPTQ --local-dir-use-symlinks False
140
+ ```
141
+
142
+ To download from a different branch, add the `--revision` parameter:
143
+
144
+ ```shell
145
+ mkdir zephyr-7B-alpha-GPTQ
146
+ huggingface-cli download TheBloke/zephyr-7B-alpha-GPTQ --revision gptq-4bit-32g-actorder_True --local-dir zephyr-7B-alpha-GPTQ --local-dir-use-symlinks False
147
+ ```
148
+
149
+ <details>
150
+ <summary>More advanced huggingface-cli download usage</summary>
151
+
152
+ If you remove the `--local-dir-use-symlinks False` parameter, the files will instead be stored in the central Huggingface cache directory (default location on Linux is: `~/.cache/huggingface`), and symlinks will be added to the specified `--local-dir`, pointing to their real location in the cache. This allows for interrupted downloads to be resumed, and allows you to quickly clone the repo to multiple places on disk without triggering a download again. The downside, and the reason why I don't list that as the default option, is that the files are then hidden away in a cache folder and it's harder to know where your disk space is being used, and to clear it up if/when you want to remove a download model.
153
+
154
+ The cache location can be changed with the `HF_HOME` environment variable, and/or the `--cache-dir` parameter to `huggingface-cli`.
155
+
156
+ For more documentation on downloading with `huggingface-cli`, please see: [HF -> Hub Python Library -> Download files -> Download from the CLI](https://huggingface.co/docs/huggingface_hub/guides/download#download-from-the-cli).
157
+
158
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
159
+
160
+ ```shell
161
+ pip3 install hf_transfer
162
+ ```
163
+
164
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
165
+
166
+ ```shell
167
+ mkdir zephyr-7B-alpha-GPTQ
168
+ HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/zephyr-7B-alpha-GPTQ --local-dir zephyr-7B-alpha-GPTQ --local-dir-use-symlinks False
169
+ ```
170
+
171
+ Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
172
+ </details>
173
+
174
+ ### With `git` (**not** recommended)
175
+
176
+ To clone a specific branch with `git`, use a command like this:
177
+
178
+ ```shell
179
+ git clone --single-branch --branch gptq-4bit-32g-actorder_True https://huggingface.co/TheBloke/zephyr-7B-alpha-GPTQ
180
+ ```
181
+
182
+ Note that using Git with HF repos is strongly discouraged. It will be much slower than using `huggingface-hub`, and will use twice as much disk space as it has to store the model files twice (it stores every byte both in the intended target folder, and again in the `.git` folder as a blob.)
183
+
184
+ <!-- README_GPTQ.md-download-from-branches end -->
185
+ <!-- README_GPTQ.md-text-generation-webui start -->
186
+ ## How to easily download and use this model in [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
187
+
188
+ Please make sure you're using the latest version of [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
189
+
190
+ 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.
191
+
192
+ 1. Click the **Model tab**.
193
+ 2. Under **Download custom model or LoRA**, enter `TheBloke/zephyr-7B-alpha-GPTQ`.
194
+ - To download from a specific branch, enter for example `TheBloke/zephyr-7B-alpha-GPTQ:gptq-4bit-32g-actorder_True`
195
+ - see Provided Files above for the list of branches for each option.
196
+ 3. Click **Download**.
197
+ 4. The model will start downloading. Once it's finished it will say "Done".
198
+ 5. In the top left, click the refresh icon next to **Model**.
199
+ 6. In the **Model** dropdown, choose the model you just downloaded: `zephyr-7B-alpha-GPTQ`
200
+ 7. The model will automatically load, and is now ready for use!
201
+ 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.
202
+ * Note that you do not need to and should not set manual GPTQ parameters any more. These are set automatically from the file `quantize_config.json`.
203
+ 9. Once you're ready, click the **Text Generation tab** and enter a prompt to get started!
204
+
205
+ <!-- README_GPTQ.md-text-generation-webui end -->
206
+
207
+ <!-- README_GPTQ.md-use-from-tgi start -->
208
+ ## Serving this model from Text Generation Inference (TGI)
209
+
210
+ It's recommended to use TGI version 1.1.0 or later. The official Docker container is: `ghcr.io/huggingface/text-generation-inference:1.1.0`
211
+
212
+ Example Docker parameters:
213
+
214
+ ```shell
215
+ --model-id TheBloke/zephyr-7B-alpha-GPTQ --port 3000 --quantize awq --max-input-length 3696 --max-total-tokens 4096 --max-batch-prefill-tokens 4096
216
+ ```
217
+
218
+ Example Python code for interfacing with TGI (requires huggingface-hub 0.17.0 or later):
219
+
220
+ ```shell
221
+ pip3 install huggingface-hub
222
+ ```
223
+
224
+ ```python
225
+ from huggingface_hub import InferenceClient
226
+
227
+ endpoint_url = "https://your-endpoint-url-here"
228
+
229
+ prompt = "Tell me about AI"
230
+ prompt_template=f'''<|system|>
231
+ </s>
232
+ <|user|>
233
+ {prompt}</s>
234
+ <|assistant|>
235
+ '''
236
+
237
+ client = InferenceClient(endpoint_url)
238
+ response = client.text_generation(prompt,
239
+ max_new_tokens=128,
240
+ do_sample=True,
241
+ temperature=0.7,
242
+ top_p=0.95,
243
+ top_k=40,
244
+ repetition_penalty=1.1)
245
+
246
+ print(f"Model output: {response}")
247
+ ```
248
+ <!-- README_GPTQ.md-use-from-tgi end -->
249
+ <!-- README_GPTQ.md-use-from-python start -->
250
+ ## How to use this GPTQ model from Python code
251
+
252
+ ### Install the necessary packages
253
+
254
+ Requires: Transformers 4.33.0 or later, Optimum 1.12.0 or later, and AutoGPTQ 0.4.2 or later.
255
+
256
+ ```shell
257
+ pip3 install transformers optimum
258
+ pip3 install auto-gptq --extra-index-url https://huggingface.github.io/autogptq-index/whl/cu118/ # Use cu117 if on CUDA 11.7
259
+ ```
260
+
261
+ If you have problems installing AutoGPTQ using the pre-built wheels, install it from source instead:
262
+
263
+ ```shell
264
+ pip3 uninstall -y auto-gptq
265
+ git clone https://github.com/PanQiWei/AutoGPTQ
266
+ cd AutoGPTQ
267
+ git checkout v0.4.2
268
+ pip3 install .
269
+ ```
270
+
271
+ ### You can then use the following code
272
+
273
+ ```python
274
+ from transformers import AutoModelForCausalLM, AutoTokenizer, pipeline
275
+
276
+ model_name_or_path = "TheBloke/zephyr-7B-alpha-GPTQ"
277
+ # To use a different branch, change revision
278
+ # For example: revision="gptq-4bit-32g-actorder_True"
279
+ model = AutoModelForCausalLM.from_pretrained(model_name_or_path,
280
+ device_map="auto",
281
+ trust_remote_code=False,
282
+ revision="main")
283
+
284
+ tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, use_fast=True)
285
+
286
+ prompt = "Tell me about AI"
287
+ prompt_template=f'''<|system|>
288
+ </s>
289
+ <|user|>
290
+ {prompt}</s>
291
+ <|assistant|>
292
+ '''
293
+
294
+ print("\n\n*** Generate:")
295
+
296
+ input_ids = tokenizer(prompt_template, return_tensors='pt').input_ids.cuda()
297
+ output = model.generate(inputs=input_ids, temperature=0.7, do_sample=True, top_p=0.95, top_k=40, max_new_tokens=512)
298
+ print(tokenizer.decode(output[0]))
299
+
300
+ # Inference can also be done using transformers' pipeline
301
+
302
+ print("*** Pipeline:")
303
+ pipe = pipeline(
304
+ "text-generation",
305
+ model=model,
306
+ tokenizer=tokenizer,
307
+ max_new_tokens=512,
308
+ do_sample=True,
309
+ temperature=0.7,
310
+ top_p=0.95,
311
+ top_k=40,
312
+ repetition_penalty=1.1
313
+ )
314
+
315
+ print(pipe(prompt_template)[0]['generated_text'])
316
+ ```
317
+ <!-- README_GPTQ.md-use-from-python end -->
318
+
319
+ <!-- README_GPTQ.md-compatibility start -->
320
+ ## Compatibility
321
+
322
+ 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).
323
+
324
+ [ExLlama](https://github.com/turboderp/exllama) is compatible with Llama and Mistral models in 4-bit. Please see the Provided Files table above for per-file compatibility.
325
+
326
+ [Huggingface Text Generation Inference (TGI)](https://github.com/huggingface/text-generation-inference) is compatible with all GPTQ models.
327
+ <!-- README_GPTQ.md-compatibility end -->
328
+
329
+ <!-- footer start -->
330
+ <!-- 200823 -->
331
+ ## Discord
332
+
333
+ For further support, and discussions on these models and AI in general, join us at:
334
+
335
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
336
+
337
+ ## Thanks, and how to contribute
338
+
339
+ Thanks to the [chirper.ai](https://chirper.ai) team!
340
+
341
+ Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
342
+
343
+ 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.
344
+
345
+ 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.
346
+
347
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
348
+
349
+ * Patreon: https://patreon.com/TheBlokeAI
350
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
351
+
352
+ **Special thanks to**: Aemon Algiz.
353
+
354
+ **Patreon special mentions**: Pierre Kircher, Stanislav Ovsiannikov, Michael Levine, Eugene Pentland, Andrey, 준교 김, Randy H, Fred von Graf, Artur Olbinski, Caitlyn Gatomon, terasurfer, Jeff Scroggin, James Bentley, Vadim, Gabriel Puliatti, Harry Royden McLaughlin, Sean Connelly, Dan Guido, Edmond Seymore, Alicia Loh, subjectnull, AzureBlack, Manuel Alberto Morcote, Thomas Belote, Lone Striker, Chris Smitley, Vitor Caleffi, Johann-Peter Hartmann, Clay Pascal, biorpg, Brandon Frisco, sidney chen, transmissions 11, Pedro Madruga, jinyuan sun, Ajan Kanaga, Emad Mostaque, Trenton Dambrowitz, Jonathan Leane, Iucharbius, usrbinkat, vamX, George Stoitzev, Luke Pendergrass, theTransient, Olakabola, Swaroop Kallakuri, Cap'n Zoog, Brandon Phillips, Michael Dempsey, Nikolai Manek, danny, Matthew Berman, Gabriel Tamborski, alfie_i, Raymond Fosdick, Tom X Nguyen, Raven Klaugh, LangChain4j, Magnesian, Illia Dulskyi, David Ziegler, Mano Prime, Luis Javier Navarrete Lozano, Erik Bjäreholt, 阿明, Nathan Dryer, Alex, Rainer Wilmers, zynix, TL, Joseph William Delisle, John Villwock, Nathan LeClaire, Willem Michiel, Joguhyik, GodLy, OG, Alps Aficionado, Jeffrey Morgan, ReadyPlayerEmma, Tiffany J. Kim, Sebastain Graf, Spencer Kim, Michael Davis, webtim, Talal Aujan, knownsqashed, John Detwiler, Imad Khwaja, Deo Leter, Jerry Meng, Elijah Stavena, Rooh Singh, Pieter, SuperWojo, Alexandros Triantafyllidis, Stephen Murray, Ai Maven, ya boyyy, Enrico Ros, Ken Nordquist, Deep Realms, Nicholas, Spiking Neurons AB, Elle, Will Dee, Jack West, RoA, Luke @flexchar, Viktor Bowallius, Derek Yates, Subspace Studios, jjj, Toran Billups, Asp the Wyvern, Fen Risland, Ilya, NimbleBox.ai, Chadd, Nitin Borwankar, Emre, Mandus, Leonard Tan, Kalila, K, Trailburnt, S_X, Cory Kujawski
355
+
356
+
357
+ Thank you to all my generous patrons and donaters!
358
+
359
+ And thank you again to a16z for their generous grant.
360
+
361
+ <!-- footer end -->
362
+
363
+ # Original model card: Hugging Face H4's Zephyr 7B Alpha
364
+
365
+
366
+ <!-- This model card has been generated automatically according to the information the Trainer had access to. You
367
+ should probably proofread and complete it, then remove this comment. -->
368
+
369
+ <img src="https://huggingface.co/HuggingFaceH4/zephyr-7b-alpha/resolve/main/thumbnail.png" alt="Zephyr Logo" width="800" style="margin-left:'auto' margin-right:'auto' display:'block'"/>
370
+
371
+
372
+ # Model Card for Zephyr 7B Alpha
373
+
374
+ Zephyr is a series of language models that are trained to act as helpful assistants. Zephyr-7B-α is the first model in the series, and is a fine-tuned version of [mistralai/Mistral-7B-v0.1](https://huggingface.co/mistralai/Mistral-7B-v0.1) that was trained on on a mix of publicly available, synthetic datasets using [Direct Preference Optimization (DPO)](https://arxiv.org/abs/2305.18290). We found that removing the in-built alignment of these datasets boosted performance on [MT Bench](https://huggingface.co/spaces/lmsys/mt-bench) and made the model more helpful. However, this means that model is likely to generate problematic text when prompted to do so and should only be used for educational and research purposes.
375
+
376
+
377
+ ## Model description
378
+
379
+ - **Model type:** A 7B parameter GPT-like model fine-tuned on a mix of publicly available, synthetic datasets.
380
+ - **Language(s) (NLP):** Primarily English
381
+ - **License:** CC BY-NC 4.0
382
+ - **Finetuned from model:** [mistralai/Mistral-7B-v0.1](https://huggingface.co/mistralai/Mistral-7B-v0.1)
383
+
384
+ ### Model Sources
385
+
386
+ <!-- Provide the basic links for the model. -->
387
+
388
+ - **Repository:** https://github.com/huggingface/alignment-handbook
389
+ - **Demo:** https://huggingface.co/spaces/HuggingFaceH4/zephyr-chat
390
+
391
+ ## Intended uses & limitations
392
+
393
+ The model was initially fine-tuned on a variant of the [`UltraChat`](https://huggingface.co/datasets/stingning/ultrachat) dataset, which contains a diverse range of synthetic dialogues generated by ChatGPT. We then further aligned the model with [🤗 TRL's](https://github.com/huggingface/trl) `DPOTrainer` on the [openbmb/UltraFeedback](https://huggingface.co/datasets/openbmb/UltraFeedback) dataset, which contain 64k prompts and model completions that are ranked by GPT-4. As a result, the model can be used for chat and you can check out our [demo](https://huggingface.co/spaces/HuggingFaceH4/zephyr-chat) to test its capabilities.
394
+
395
+ Here's how you can run the model using the `pipeline()` function from 🤗 Transformers:
396
+
397
+ ```python
398
+ import torch
399
+ from transformers import pipeline
400
+
401
+ pipe = pipeline("text-generation", model="HuggingFaceH4/zephyr-7b-alpha", torch_dtype=torch.bfloat16, device_map="auto")
402
+
403
+ # We use a variant of ChatML to format each message
404
+ prompt_template = "<|system|>\n</s>\n<|user|>\n{query}</s>\n<|assistant|>\n"
405
+ prompt = prompt_template.format(query="How many helicopters can a human eat in one sitting?")
406
+ outputs = pipe(prompt, max_new_tokens=256, do_sample=True, temperature=0.7, top_k=50, top_p=0.95)
407
+ # Zero. Humans cannot consume or digest solid objects like helicopters, including their components such as rotor blades and engines. A human's diet is limited to food that they can swallow and break down through the process of digestion. Eating a helicopter would be physically impossible and could potentially cause serious harm if attempted.
408
+ ```
409
+
410
+ ## Bias, Risks, and Limitations
411
+
412
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
413
+
414
+ Zephyr-7B-α has not been aligned to human preferences with techniques like RLHF or deployed with in-the-loop filtering of responses like ChatGPT, so the model can produce problematic outputs (especially when prompted to do so).
415
+ It is also unknown what the size and composition of the corpus was used to train the base model (`mistralai/Mistral-7B-v0.1`), however it is likely to have included a mix of Web data and technical sources like books and code. See the [Falcon 180B model card](https://huggingface.co/tiiuae/falcon-180B#training-data) for an example of this.
416
+
417
+
418
+ ## Training and evaluation data
419
+
420
+ Zephyr 7B Alpha achieves the following results on the evaluation set:
421
+
422
+ - Loss: 0.4605
423
+ - Rewards/chosen: -0.5053
424
+ - Rewards/rejected: -1.8752
425
+ - Rewards/accuracies: 0.7812
426
+ - Rewards/margins: 1.3699
427
+ - Logps/rejected: -327.4286
428
+ - Logps/chosen: -297.1040
429
+ - Logits/rejected: -2.7153
430
+ - Logits/chosen: -2.7447
431
+
432
+ ## Training procedure
433
+
434
+ ### Training hyperparameters
435
+
436
+ The following hyperparameters were used during training:
437
+ - learning_rate: 5e-07
438
+ - train_batch_size: 2
439
+ - eval_batch_size: 4
440
+ - seed: 42
441
+ - distributed_type: multi-GPU
442
+ - num_devices: 16
443
+ - total_train_batch_size: 32
444
+ - total_eval_batch_size: 64
445
+ - optimizer: Adam with betas=(0.9,0.999) and epsilon=1e-08
446
+ - lr_scheduler_type: linear
447
+ - lr_scheduler_warmup_ratio: 0.1
448
+ - num_epochs: 1
449
+
450
+ ### Training results
451
+
452
+ | Training Loss | Epoch | Step | Validation Loss | Rewards/chosen | Rewards/rejected | Rewards/accuracies | Rewards/margins | Logps/rejected | Logps/chosen | Logits/rejected | Logits/chosen |
453
+ |:-------------:|:-----:|:----:|:---------------:|:--------------:|:----------------:|:------------------:|:---------------:|:--------------:|:------------:|:---------------:|:-------------:|
454
+ | 0.5602 | 0.05 | 100 | 0.5589 | -0.3359 | -0.8168 | 0.7188 | 0.4809 | -306.2607 | -293.7161 | -2.6554 | -2.6797 |
455
+ | 0.4852 | 0.1 | 200 | 0.5136 | -0.5310 | -1.4994 | 0.8125 | 0.9684 | -319.9124 | -297.6181 | -2.5762 | -2.5957 |
456
+ | 0.5212 | 0.15 | 300 | 0.5168 | -0.1686 | -1.1760 | 0.7812 | 1.0074 | -313.4444 | -290.3699 | -2.6865 | -2.7125 |
457
+ | 0.5496 | 0.21 | 400 | 0.4835 | -0.1617 | -1.7170 | 0.8281 | 1.5552 | -324.2635 | -290.2326 | -2.7947 | -2.8218 |
458
+ | 0.5209 | 0.26 | 500 | 0.5054 | -0.4778 | -1.6604 | 0.7344 | 1.1826 | -323.1325 | -296.5546 | -2.8388 | -2.8667 |
459
+ | 0.4617 | 0.31 | 600 | 0.4910 | -0.3738 | -1.5180 | 0.7656 | 1.1442 | -320.2848 | -294.4741 | -2.8234 | -2.8521 |
460
+ | 0.4452 | 0.36 | 700 | 0.4838 | -0.4591 | -1.6576 | 0.7031 | 1.1986 | -323.0770 | -296.1796 | -2.7401 | -2.7653 |
461
+ | 0.4674 | 0.41 | 800 | 0.5077 | -0.5692 | -1.8659 | 0.7656 | 1.2967 | -327.2416 | -298.3818 | -2.6740 | -2.6945 |
462
+ | 0.4656 | 0.46 | 900 | 0.4927 | -0.5279 | -1.6614 | 0.7656 | 1.1335 | -323.1518 | -297.5553 | -2.7817 | -2.8015 |
463
+ | 0.4102 | 0.52 | 1000 | 0.4772 | -0.5767 | -2.0667 | 0.7656 | 1.4900 | -331.2578 | -298.5311 | -2.7160 | -2.7455 |
464
+ | 0.4663 | 0.57 | 1100 | 0.4740 | -0.8038 | -2.1018 | 0.7656 | 1.2980 | -331.9604 | -303.0741 | -2.6994 | -2.7257 |
465
+ | 0.4737 | 0.62 | 1200 | 0.4716 | -0.3783 | -1.7015 | 0.7969 | 1.3232 | -323.9545 | -294.5634 | -2.6842 | -2.7135 |
466
+ | 0.4259 | 0.67 | 1300 | 0.4866 | -0.6239 | -1.9703 | 0.7812 | 1.3464 | -329.3312 | -299.4761 | -2.7046 | -2.7356 |
467
+ | 0.4935 | 0.72 | 1400 | 0.4747 | -0.5626 | -1.7600 | 0.7812 | 1.1974 | -325.1243 | -298.2491 | -2.7153 | -2.7444 |
468
+ | 0.4211 | 0.77 | 1500 | 0.4645 | -0.6099 | -1.9993 | 0.7656 | 1.3894 | -329.9109 | -299.1959 | -2.6944 | -2.7236 |
469
+ | 0.4931 | 0.83 | 1600 | 0.4684 | -0.6798 | -2.1082 | 0.7656 | 1.4285 | -332.0890 | -300.5934 | -2.7006 | -2.7305 |
470
+ | 0.5029 | 0.88 | 1700 | 0.4595 | -0.5063 | -1.8951 | 0.7812 | 1.3889 | -327.8267 | -297.1233 | -2.7108 | -2.7403 |
471
+ | 0.4965 | 0.93 | 1800 | 0.4613 | -0.5561 | -1.9079 | 0.7812 | 1.3518 | -328.0831 | -298.1203 | -2.7226 | -2.7523 |
472
+ | 0.4337 | 0.98 | 1900 | 0.4608 | -0.5066 | -1.8718 | 0.7656 | 1.3652 | -327.3599 | -297.1296 | -2.7175 | -2.7469 |
473
+
474
+
475
+ ### Framework versions
476
+
477
+ - Transformers 4.34.0
478
+ - Pytorch 2.0.1+cu118
479
+ - Datasets 2.12.0
480
+ - Tokenizers 0.14.0