TheBloke commited on
Commit
cbb47ff
1 Parent(s): 7284276

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +493 -0
README.md ADDED
@@ -0,0 +1,493 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: mistralai/Mixtral-8x7B-Instruct-v0.1
3
+ inference: false
4
+ language:
5
+ - fr
6
+ - it
7
+ - de
8
+ - es
9
+ - en
10
+ license: apache-2.0
11
+ model_creator: Mistral AI_
12
+ model_name: Mixtral 8X7B Instruct v0.1
13
+ model_type: mixtral
14
+ prompt_template: '<s>[INST] {prompt} [/INST]
15
+
16
+ '
17
+ quantized_by: TheBloke
18
+ ---
19
+ <!-- markdownlint-disable MD041 -->
20
+
21
+ <!-- header start -->
22
+ <!-- 200823 -->
23
+ <div style="width: auto; margin-left: auto; margin-right: auto">
24
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
25
+ </div>
26
+ <div style="display: flex; justify-content: space-between; width: 100%;">
27
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
28
+ <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
29
+ </div>
30
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
31
+ <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>
32
+ </div>
33
+ </div>
34
+ <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>
35
+ <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
36
+ <!-- header end -->
37
+
38
+ # Mixtral 8X7B Instruct v0.1 - GPTQ
39
+ - Model creator: [Mistral AI_](https://huggingface.co/mistralai)
40
+ - Original model: [Mixtral 8X7B Instruct v0.1](https://huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1)
41
+
42
+ <!-- description start -->
43
+ # Description
44
+
45
+ This repo contains GPTQ model files for [Mistral AI_'s Mixtral 8X7B Instruct v0.1](https://huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1).
46
+
47
+ 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.
48
+
49
+ <!-- description end -->
50
+ <!-- repositories-available start -->
51
+ ## Repositories available
52
+
53
+ * [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/Mixtral-8x7B-Instruct-v0.1-AWQ)
54
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/Mixtral-8x7B-Instruct-v0.1-GPTQ)
55
+ * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/Mixtral-8x7B-Instruct-v0.1-GGUF)
56
+ * [Mistral AI_'s original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1)
57
+ <!-- repositories-available end -->
58
+
59
+ <!-- prompt-template start -->
60
+ ## Prompt template: Mistral
61
+
62
+ ```
63
+ <s>[INST] {prompt} [/INST]
64
+
65
+ ```
66
+
67
+ <!-- prompt-template end -->
68
+
69
+
70
+
71
+ <!-- README_GPTQ.md-compatible clients start -->
72
+ ## Known compatible clients / servers
73
+
74
+ GPTQ models are currently supported on Linux (NVidia/AMD) and Windows (NVidia only). macOS users: please use GGUF models.
75
+
76
+ These GPTQ models are known to work in the following inference servers/webuis.
77
+
78
+ - [text-generation-webui](https://github.com/oobabooga/text-generation-webui)
79
+ - [KoboldAI United](https://github.com/henk717/koboldai)
80
+ - [LoLLMS Web UI](https://github.com/ParisNeo/lollms-webui)
81
+ - [Hugging Face Text Generation Inference (TGI)](https://github.com/huggingface/text-generation-inference)
82
+
83
+ This may not be a complete list; if you know of others, please let me know!
84
+ <!-- README_GPTQ.md-compatible clients end -->
85
+
86
+ <!-- README_GPTQ.md-provided-files start -->
87
+ ## Provided files, and GPTQ parameters
88
+
89
+ Multiple quantisation parameters are provided, to allow you to choose the best one for your hardware and requirements.
90
+
91
+ Each separate quant is in a different branch. See below for instructions on fetching from different branches.
92
+
93
+ Most GPTQ files are made with AutoGPTQ. Mistral models are currently made with Transformers.
94
+
95
+ <details>
96
+ <summary>Explanation of GPTQ parameters</summary>
97
+
98
+ - Bits: The bit size of the quantised model.
99
+ - GS: GPTQ group size. Higher numbers use less VRAM, but have lower quantisation accuracy. "None" is the lowest possible value.
100
+ - 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.
101
+ - Damp %: A GPTQ parameter that affects how samples are processed for quantisation. 0.01 is default, but 0.1 results in slightly better accuracy.
102
+ - 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).
103
+ - 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.
104
+ - ExLlama Compatibility: Whether this file can be loaded with ExLlama, which currently only supports Llama and Mistral models in 4-bit.
105
+
106
+ </details>
107
+
108
+ | Branch | Bits | GS | Act Order | Damp % | GPTQ Dataset | Seq Len | Size | ExLlama | Desc |
109
+ | ------ | ---- | -- | --------- | ------ | ------------ | ------- | ---- | ------- | ---- |
110
+ | [main](https://huggingface.co/TheBloke/Mixtral-8x7B-Instruct-v0.1-GPTQ/tree/main) | 4 | None | Yes | 0.1 | [VMware Open Instruct](https://huggingface.co/datasets/VMware/open-instruct/viewer/) | 8192 | 23.81 GB | No | 4-bit, with Act Order. No group size, to lower VRAM requirements. |
111
+ | [gptq-4bit-128g-actorder_True](https://huggingface.co/TheBloke/Mixtral-8x7B-Instruct-v0.1-GPTQ/tree/gptq-4bit-128g-actorder_True) | 4 | 128 | Yes | 0.1 | [VMware Open Instruct](https://huggingface.co/datasets/VMware/open-instruct/viewer/) | 8192 | 24.70 GB | No | 4-bit, with Act Order and group size 128g. Uses even less VRAM than 64g, but with slightly lower accuracy. |
112
+ | [gptq-4bit-32g-actorder_True](https://huggingface.co/TheBloke/Mixtral-8x7B-Instruct-v0.1-GPTQ/tree/gptq-4bit-32g-actorder_True) | 4 | 32 | Yes | 0.1 | [VMware Open Instruct](https://huggingface.co/datasets/VMware/open-instruct/viewer/) | 8192 | 27.42 GB | No | 4-bit, with Act Order and group size 32g. Gives highest possible inference quality, with maximum VRAM usage. |
113
+ | [gptq-3bit--1g-actorder_True](https://huggingface.co/TheBloke/Mixtral-8x7B-Instruct-v0.1-GPTQ/tree/gptq-3bit--1g-actorder_True) | 3 | None | Yes | 0.1 | [VMware Open Instruct](https://huggingface.co/datasets/VMware/open-instruct/viewer/) | 8192 | 18.01 GB | No | 3-bit, with Act Order and no group size. Lowest possible VRAM requirements. May be lower quality than 3-bit 128g. |
114
+ | [gptq-3bit-128g-actorder_True](https://huggingface.co/TheBloke/Mixtral-8x7B-Instruct-v0.1-GPTQ/tree/gptq-3bit-128g-actorder_True) | 3 | 128 | Yes | 0.1 | [VMware Open Instruct](https://huggingface.co/datasets/VMware/open-instruct/viewer/) | 8192 | 18.85 GB | No | 3-bit, with group size 128g and act-order. Higher quality than 128g-False. |
115
+ | [gptq-8bit--1g-actorder_True](https://huggingface.co/TheBloke/Mixtral-8x7B-Instruct-v0.1-GPTQ/tree/gptq-8bit--1g-actorder_True) | 8 | None | Yes | 0.1 | [VMware Open Instruct](https://huggingface.co/datasets/VMware/open-instruct/viewer/) | 8192 | 47.04 GB | No | 8-bit, with Act Order. No group size, to lower VRAM requirements. |
116
+ | [gptq-8bit-128g-actorder_True](https://huggingface.co/TheBloke/Mixtral-8x7B-Instruct-v0.1-GPTQ/tree/gptq-8bit-128g-actorder_True) | 8 | 128 | Yes | 0.1 | [VMware Open Instruct](https://huggingface.co/datasets/VMware/open-instruct/viewer/) | 8192 | 48.10 GB | No | 8-bit, with group size 128g for higher inference quality and with Act Order for even higher accuracy. |
117
+
118
+ <!-- README_GPTQ.md-provided-files end -->
119
+
120
+ <!-- README_GPTQ.md-download-from-branches start -->
121
+ ## How to download, including from branches
122
+
123
+ ### In text-generation-webui
124
+
125
+ To download from the `main` branch, enter `TheBloke/Mixtral-8x7B-Instruct-v0.1-GPTQ` in the "Download model" box.
126
+
127
+ To download from another branch, add `:branchname` to the end of the download name, eg `TheBloke/Mixtral-8x7B-Instruct-v0.1-GPTQ:gptq-4bit-128g-actorder_True`
128
+
129
+ ### From the command line
130
+
131
+ I recommend using the `huggingface-hub` Python library:
132
+
133
+ ```shell
134
+ pip3 install huggingface-hub
135
+ ```
136
+
137
+ To download the `main` branch to a folder called `Mixtral-8x7B-Instruct-v0.1-GPTQ`:
138
+
139
+ ```shell
140
+ mkdir Mixtral-8x7B-Instruct-v0.1-GPTQ
141
+ huggingface-cli download TheBloke/Mixtral-8x7B-Instruct-v0.1-GPTQ --local-dir Mixtral-8x7B-Instruct-v0.1-GPTQ --local-dir-use-symlinks False
142
+ ```
143
+
144
+ To download from a different branch, add the `--revision` parameter:
145
+
146
+ ```shell
147
+ mkdir Mixtral-8x7B-Instruct-v0.1-GPTQ
148
+ huggingface-cli download TheBloke/Mixtral-8x7B-Instruct-v0.1-GPTQ --revision gptq-4bit-128g-actorder_True --local-dir Mixtral-8x7B-Instruct-v0.1-GPTQ --local-dir-use-symlinks False
149
+ ```
150
+
151
+ <details>
152
+ <summary>More advanced huggingface-cli download usage</summary>
153
+
154
+ If you remove the `--local-dir-use-symlinks False` parameter, the files will instead be stored in the central Hugging Face 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.
155
+
156
+ The cache location can be changed with the `HF_HOME` environment variable, and/or the `--cache-dir` parameter to `huggingface-cli`.
157
+
158
+ 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).
159
+
160
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
161
+
162
+ ```shell
163
+ pip3 install hf_transfer
164
+ ```
165
+
166
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
167
+
168
+ ```shell
169
+ mkdir Mixtral-8x7B-Instruct-v0.1-GPTQ
170
+ HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/Mixtral-8x7B-Instruct-v0.1-GPTQ --local-dir Mixtral-8x7B-Instruct-v0.1-GPTQ --local-dir-use-symlinks False
171
+ ```
172
+
173
+ Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
174
+ </details>
175
+
176
+ ### With `git` (**not** recommended)
177
+
178
+ To clone a specific branch with `git`, use a command like this:
179
+
180
+ ```shell
181
+ git clone --single-branch --branch gptq-4bit-128g-actorder_True https://huggingface.co/TheBloke/Mixtral-8x7B-Instruct-v0.1-GPTQ
182
+ ```
183
+
184
+ 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.)
185
+
186
+ <!-- README_GPTQ.md-download-from-branches end -->
187
+ <!-- README_GPTQ.md-text-generation-webui start -->
188
+ ## How to easily download and use this model in [text-generation-webui](https://github.com/oobabooga/text-generation-webui)
189
+
190
+ Please make sure you're using the latest version of [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
191
+
192
+ 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.
193
+
194
+ 1. Click the **Model tab**.
195
+ 2. Under **Download custom model or LoRA**, enter `TheBloke/Mixtral-8x7B-Instruct-v0.1-GPTQ`.
196
+
197
+ - To download from a specific branch, enter for example `TheBloke/Mixtral-8x7B-Instruct-v0.1-GPTQ:gptq-4bit-128g-actorder_True`
198
+ - see Provided Files above for the list of branches for each option.
199
+
200
+ 3. Click **Download**.
201
+ 4. The model will start downloading. Once it's finished it will say "Done".
202
+ 5. In the top left, click the refresh icon next to **Model**.
203
+ 6. In the **Model** dropdown, choose the model you just downloaded: `Mixtral-8x7B-Instruct-v0.1-GPTQ`
204
+ 7. The model will automatically load, and is now ready for use!
205
+ 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.
206
+
207
+ - 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`.
208
+
209
+ 9. Once you're ready, click the **Text Generation** tab and enter a prompt to get started!
210
+
211
+ <!-- README_GPTQ.md-text-generation-webui end -->
212
+
213
+ <!-- README_GPTQ.md-use-from-tgi start -->
214
+ ## Serving this model from Text Generation Inference (TGI)
215
+
216
+ 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`
217
+
218
+ Example Docker parameters:
219
+
220
+ ```shell
221
+ --model-id TheBloke/Mixtral-8x7B-Instruct-v0.1-GPTQ --port 3000 --quantize gptq --max-input-length 3696 --max-total-tokens 4096 --max-batch-prefill-tokens 4096
222
+ ```
223
+
224
+ Example Python code for interfacing with TGI (requires huggingface-hub 0.17.0 or later):
225
+
226
+ ```shell
227
+ pip3 install huggingface-hub
228
+ ```
229
+
230
+ ```python
231
+ from huggingface_hub import InferenceClient
232
+
233
+ endpoint_url = "https://your-endpoint-url-here"
234
+
235
+ prompt = "Tell me about AI"
236
+ prompt_template=f'''<s>[INST] {prompt} [/INST]
237
+ '''
238
+
239
+ client = InferenceClient(endpoint_url)
240
+ response = client.text_generation(prompt,
241
+ max_new_tokens=128,
242
+ do_sample=True,
243
+ temperature=0.7,
244
+ top_p=0.95,
245
+ top_k=40,
246
+ repetition_penalty=1.1)
247
+
248
+ print(f"Model output: {response}")
249
+ ```
250
+ <!-- README_GPTQ.md-use-from-tgi end -->
251
+ <!-- README_GPTQ.md-use-from-python start -->
252
+ ## Python code example: inference from this GPTQ model
253
+
254
+ ### Install the necessary packages
255
+
256
+ Requires: Transformers 4.33.0 or later, Optimum 1.12.0 or later, and AutoGPTQ 0.4.2 or later.
257
+
258
+ ```shell
259
+ pip3 install --upgrade transformers optimum
260
+ # If using PyTorch 2.1 + CUDA 12.x:
261
+ pip3 install --upgrade auto-gptq
262
+ # or, if using PyTorch 2.1 + CUDA 11.x:
263
+ pip3 install --upgrade auto-gptq --extra-index-url https://huggingface.github.io/autogptq-index/whl/cu118/
264
+ ```
265
+
266
+ If you are using PyTorch 2.0, you will need to install AutoGPTQ from source. Likewise if you have problems with the pre-built wheels, you should try building from source:
267
+
268
+ ```shell
269
+ pip3 uninstall -y auto-gptq
270
+ git clone https://github.com/PanQiWei/AutoGPTQ
271
+ cd AutoGPTQ
272
+ git checkout v0.5.1
273
+ pip3 install .
274
+ ```
275
+
276
+ ### Example Python code
277
+
278
+ ```python
279
+ from transformers import AutoModelForCausalLM, AutoTokenizer, pipeline
280
+
281
+ model_name_or_path = "TheBloke/Mixtral-8x7B-Instruct-v0.1-GPTQ"
282
+ # To use a different branch, change revision
283
+ # For example: revision="gptq-4bit-128g-actorder_True"
284
+ model = AutoModelForCausalLM.from_pretrained(model_name_or_path,
285
+ device_map="auto",
286
+ trust_remote_code=False,
287
+ revision="main")
288
+
289
+ tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, use_fast=True)
290
+
291
+ prompt = "Tell me about AI"
292
+ prompt_template=f'''<s>[INST] {prompt} [/INST]
293
+ '''
294
+
295
+ print("\n\n*** Generate:")
296
+
297
+ input_ids = tokenizer(prompt_template, return_tensors='pt').input_ids.cuda()
298
+ output = model.generate(inputs=input_ids, temperature=0.7, do_sample=True, top_p=0.95, top_k=40, max_new_tokens=512)
299
+ print(tokenizer.decode(output[0]))
300
+
301
+ # Inference can also be done using transformers' pipeline
302
+
303
+ print("*** Pipeline:")
304
+ pipe = pipeline(
305
+ "text-generation",
306
+ model=model,
307
+ tokenizer=tokenizer,
308
+ max_new_tokens=512,
309
+ do_sample=True,
310
+ temperature=0.7,
311
+ top_p=0.95,
312
+ top_k=40,
313
+ repetition_penalty=1.1
314
+ )
315
+
316
+ print(pipe(prompt_template)[0]['generated_text'])
317
+ ```
318
+ <!-- README_GPTQ.md-use-from-python end -->
319
+
320
+ <!-- README_GPTQ.md-compatibility start -->
321
+ ## Compatibility
322
+
323
+ The files provided are tested to work with Transformers. For non-Mistral models, AutoGPTQ can also be used directly.
324
+
325
+ [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.
326
+
327
+ For a list of clients/servers, please see "Known compatible clients / servers", above.
328
+ <!-- README_GPTQ.md-compatibility end -->
329
+
330
+ <!-- footer start -->
331
+ <!-- 200823 -->
332
+ ## Discord
333
+
334
+ For further support, and discussions on these models and AI in general, join us at:
335
+
336
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
337
+
338
+ ## Thanks, and how to contribute
339
+
340
+ Thanks to the [chirper.ai](https://chirper.ai) team!
341
+
342
+ Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
343
+
344
+ 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.
345
+
346
+ 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.
347
+
348
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
349
+
350
+ * Patreon: https://patreon.com/TheBlokeAI
351
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
352
+
353
+ **Special thanks to**: Aemon Algiz.
354
+
355
+ **Patreon special mentions**: Michael Levine, 阿明, Trailburnt, Nikolai Manek, John Detwiler, Randy H, Will Dee, Sebastain Graf, NimbleBox.ai, Eugene Pentland, Emad Mostaque, Ai Maven, Jim Angel, Jeff Scroggin, Michael Davis, Manuel Alberto Morcote, Stephen Murray, Robert, Justin Joy, Luke @flexchar, Brandon Frisco, Elijah Stavena, S_X, Dan Guido, Undi ., Komninos Chatzipapas, Shadi, theTransient, Lone Striker, Raven Klaugh, jjj, Cap'n Zoog, Michel-Marie MAUDET (LINAGORA), Matthew Berman, David, Fen Risland, Omer Bin Jawed, Luke Pendergrass, Kalila, OG, Erik Bjäreholt, Rooh Singh, Joseph William Delisle, Dan Lewis, TL, John Villwock, AzureBlack, Brad, Pedro Madruga, Caitlyn Gatomon, K, jinyuan sun, Mano Prime, Alex, Jeffrey Morgan, Alicia Loh, Illia Dulskyi, Chadd, transmissions 11, fincy, Rainer Wilmers, ReadyPlayerEmma, knownsqashed, Mandus, biorpg, Deo Leter, Brandon Phillips, SuperWojo, Sean Connelly, Iucharbius, Jack West, Harry Royden McLaughlin, Nicholas, terasurfer, Vitor Caleffi, Duane Dunston, Johann-Peter Hartmann, David Ziegler, Olakabola, Ken Nordquist, Trenton Dambrowitz, Tom X Nguyen, Vadim, Ajan Kanaga, Leonard Tan, Clay Pascal, Alexandros Triantafyllidis, JM33133, Xule, vamX, ya boyyy, subjectnull, Talal Aujan, Alps Aficionado, wassieverse, Ari Malik, James Bentley, Woland, Spencer Kim, Michael Dempsey, Fred von Graf, Elle, zynix, William Richards, Stanislav Ovsiannikov, Edmond Seymore, Jonathan Leane, Martin Kemka, usrbinkat, Enrico Ros
356
+
357
+
358
+ Thank you to all my generous patrons and donaters!
359
+
360
+ And thank you again to a16z for their generous grant.
361
+
362
+ <!-- footer end -->
363
+
364
+ # Original model card: Mistral AI_'s Mixtral 8X7B Instruct v0.1
365
+
366
+ # Model Card for Mixtral-8x7B
367
+ The Mixtral-8x7B Large Language Model (LLM) is a pretrained generative Sparse Mixture of Experts. The Mixtral-8x7B outperforms Llama 2 70B on most benchmarks we tested.
368
+
369
+ For full details of this model please read our [release blog post](https://mistral.ai/news/mixtral-of-experts/).
370
+
371
+ ## Warning
372
+ This repo contains weights that are compatible with [vLLM](https://github.com/vllm-project/vllm) serving of the model as well as Hugging Face [transformers](https://github.com/huggingface/transformers) library. It is based on the original Mixtral [torrent release](magnet:?xt=urn:btih:5546272da9065eddeb6fcd7ffddeef5b75be79a7&dn=mixtral-8x7b-32kseqlen&tr=udp%3A%2F%http://2Fopentracker.i2p.rocks%3A6969%2Fannounce&tr=http%3A%2F%http://2Ftracker.openbittorrent.com%3A80%2Fannounce), but the file format and parameter names are different. Please note that model cannot (yet) be instantiated with HF.
373
+
374
+ ## Instruction format
375
+
376
+ This format must be strictly respected, otherwise the model will generate sub-optimal outputs.
377
+
378
+ The template used to build a prompt for the Instruct model is defined as follows:
379
+ ```
380
+ <s> [INST] Instruction [/INST] Model answer</s> [INST] Follow-up instruction [/INST]
381
+ ```
382
+ Note that `<s>` and `</s>` are special tokens for beginning of string (BOS) and end of string (EOS) while [INST] and [/INST] are regular strings.
383
+
384
+ As reference, here is the pseudo-code used to tokenize instructions during fine-tuning:
385
+ ```python
386
+ def tokenize(text):
387
+ return tok.encode(text, add_special_tokens=False)
388
+
389
+ [BOS_ID] +
390
+ tokenize("[INST]") + tokenize(USER_MESSAGE_1) + tokenize("[/INST]") +
391
+ tokenize(BOT_MESSAGE_1) + [EOS_ID] +
392
+
393
+ tokenize("[INST]") + tokenize(USER_MESSAGE_N) + tokenize("[/INST]") +
394
+ tokenize(BOT_MESSAGE_N) + [EOS_ID]
395
+ ```
396
+
397
+ In the pseudo-code above, note that the `tokenize` method should not add a BOS or EOS token automatically, but should add a prefix space.
398
+
399
+ ## Run the model
400
+
401
+ ```python
402
+ from transformers import AutoModelForCausalLM, AutoTokenizer
403
+
404
+ model_id = "mistralai/Mixtral-8x7B-Instruct-v0.1"
405
+ tokenizer = AutoTokenizer.from_pretrained(model_id)
406
+
407
+ model = AutoModelForCausalLM.from_pretrained(model_id)
408
+
409
+ text = "Hello my name is"
410
+ inputs = tokenizer(text, return_tensors="pt")
411
+
412
+ outputs = model.generate(**inputs, max_new_tokens=20)
413
+ print(tokenizer.decode(outputs[0], skip_special_tokens=True))
414
+ ```
415
+
416
+ By default, transformers will load the model in full precision. Therefore you might be interested to further reduce down the memory requirements to run the model through the optimizations we offer in HF ecosystem:
417
+
418
+ ### In half-precision
419
+
420
+ Note `float16` precision only works on GPU devices
421
+
422
+ <details>
423
+ <summary> Click to expand </summary>
424
+
425
+ ```diff
426
+ + import torch
427
+ from transformers import AutoModelForCausalLM, AutoTokenizer
428
+
429
+ model_id = "mistralai/Mixtral-8x7B-Instruct-v0.1"
430
+ tokenizer = AutoTokenizer.from_pretrained(model_id)
431
+
432
+ + model = AutoModelForCausalLM.from_pretrained(model_id, torch_dtype=torch.float16).to(0)
433
+
434
+ text = "Hello my name is"
435
+ + inputs = tokenizer(text, return_tensors="pt").to(0)
436
+
437
+ outputs = model.generate(**inputs, max_new_tokens=20)
438
+ print(tokenizer.decode(outputs[0], skip_special_tokens=True))
439
+ ```
440
+ </details>
441
+
442
+ ### Lower precision using (8-bit & 4-bit) using `bitsandbytes`
443
+
444
+ <details>
445
+ <summary> Click to expand </summary>
446
+
447
+ ```diff
448
+ + import torch
449
+ from transformers import AutoModelForCausalLM, AutoTokenizer
450
+
451
+ model_id = "mistralai/Mixtral-8x7B-Instruct-v0.1"
452
+ tokenizer = AutoTokenizer.from_pretrained(model_id)
453
+
454
+ + model = AutoModelForCausalLM.from_pretrained(model_id, load_in_4bit=True)
455
+
456
+ text = "Hello my name is"
457
+ + inputs = tokenizer(text, return_tensors="pt").to(0)
458
+
459
+ outputs = model.generate(**inputs, max_new_tokens=20)
460
+ print(tokenizer.decode(outputs[0], skip_special_tokens=True))
461
+ ```
462
+ </details>
463
+
464
+ ### Load the model with Flash Attention 2
465
+
466
+ <details>
467
+ <summary> Click to expand </summary>
468
+
469
+ ```diff
470
+ + import torch
471
+ from transformers import AutoModelForCausalLM, AutoTokenizer
472
+
473
+ model_id = "mistralai/Mixtral-8x7B-Instruct-v0.1"
474
+ tokenizer = AutoTokenizer.from_pretrained(model_id)
475
+
476
+ + model = AutoModelForCausalLM.from_pretrained(model_id, use_flash_attention_2=True)
477
+
478
+ text = "Hello my name is"
479
+ + inputs = tokenizer(text, return_tensors="pt").to(0)
480
+
481
+ outputs = model.generate(**inputs, max_new_tokens=20)
482
+ print(tokenizer.decode(outputs[0], skip_special_tokens=True))
483
+ ```
484
+ </details>
485
+
486
+ ## Limitations
487
+
488
+ The Mixtral-8x7B Instruct model is a quick demonstration that the base model can be easily fine-tuned to achieve compelling performance.
489
+ It does not have any moderation mechanisms. We're looking forward to engaging with the community on ways to
490
+ make the model finely respect guardrails, allowing for deployment in environments requiring moderated outputs.
491
+
492
+ # The Mistral AI Team
493
+ Albert Jiang, Alexandre Sablayrolles, Arthur Mensch, Blanche Savary, Chris Bamford, Devendra Singh Chaplot, Diego de las Casas, Emma Bou Hanna, Florian Bressand, Gianna Lengyel, Guillaume Bour, Guillaume Lample, Lélio Renard Lavaud, Louis Ternon, Lucile Saulnier, Marie-Anne Lachaux, Pierre Stock, Teven Le Scao, Théophile Gervet, Thibaut Lavril, Thomas Wang, Timothée Lacroix, William El Sayed.