TheBloke commited on
Commit
a6ba4ff
1 Parent(s): 37458b8

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +449 -0
README.md ADDED
@@ -0,0 +1,449 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: orangetin/OpenHermes-Mixtral-8x7B
3
+ inference: false
4
+ language:
5
+ - en
6
+ license: apache-2.0
7
+ model-index:
8
+ - name: OpenHermes-Mixtral-8x7B
9
+ results: []
10
+ model_creator: OrangeTin
11
+ model_name: Orangetin OpenHermes Mixtral 8X7B
12
+ model_type: mixtral
13
+ prompt_template: '[INST] <<SYS>>
14
+
15
+ {system_message}
16
+
17
+ <</SYS>>
18
+
19
+ {prompt} [/INST]
20
+
21
+ '
22
+ quantized_by: TheBloke
23
+ tags:
24
+ - mixtral
25
+ - instruct
26
+ - finetune
27
+ - llama
28
+ - gpt4
29
+ - synthetic data
30
+ - distillation
31
+ ---
32
+ <!-- markdownlint-disable MD041 -->
33
+
34
+ <!-- header start -->
35
+ <!-- 200823 -->
36
+ <div style="width: auto; margin-left: auto; margin-right: auto">
37
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
38
+ </div>
39
+ <div style="display: flex; justify-content: space-between; width: 100%;">
40
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
41
+ <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
42
+ </div>
43
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
44
+ <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>
45
+ </div>
46
+ </div>
47
+ <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>
48
+ <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
49
+ <!-- header end -->
50
+
51
+ # Orangetin OpenHermes Mixtral 8X7B - GPTQ
52
+ - Model creator: [OrangeTin](https://huggingface.co/orangetin)
53
+ - Original model: [Orangetin OpenHermes Mixtral 8X7B](https://huggingface.co/orangetin/OpenHermes-Mixtral-8x7B)
54
+
55
+ <!-- description start -->
56
+ # Description
57
+
58
+ This repo contains GPTQ model files for [OrangeTin's Orangetin OpenHermes Mixtral 8X7B](https://huggingface.co/orangetin/OpenHermes-Mixtral-8x7B).
59
+
60
+ 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.
61
+
62
+ <!-- description end -->
63
+ <!-- repositories-available start -->
64
+ ## Repositories available
65
+
66
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/orangetin-OpenHermes-Mixtral-8x7B-GPTQ)
67
+ * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/orangetin-OpenHermes-Mixtral-8x7B-GGUF)
68
+ * [OrangeTin's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/orangetin/OpenHermes-Mixtral-8x7B)
69
+ <!-- repositories-available end -->
70
+
71
+ <!-- prompt-template start -->
72
+ ## Prompt template: Llama-2-Chat
73
+
74
+ ```
75
+ [INST] <<SYS>>
76
+ {system_message}
77
+ <</SYS>>
78
+ {prompt} [/INST]
79
+
80
+ ```
81
+
82
+ <!-- prompt-template end -->
83
+
84
+
85
+
86
+ <!-- README_GPTQ.md-compatible clients start -->
87
+ ## Known compatible clients / servers
88
+
89
+ GPTQ models are currently supported on Linux (NVidia/AMD) and Windows (NVidia only). macOS users: please use GGUF models.
90
+
91
+ These GPTQ models are known to work in the following inference servers/webuis.
92
+
93
+ - [text-generation-webui](https://github.com/oobabooga/text-generation-webui)
94
+ - [KoboldAI United](https://github.com/henk717/koboldai)
95
+ - [LoLLMS Web UI](https://github.com/ParisNeo/lollms-webui)
96
+ - [Hugging Face Text Generation Inference (TGI)](https://github.com/huggingface/text-generation-inference)
97
+
98
+ This may not be a complete list; if you know of others, please let me know!
99
+ <!-- README_GPTQ.md-compatible clients end -->
100
+
101
+ <!-- README_GPTQ.md-provided-files start -->
102
+ ## Provided files, and GPTQ parameters
103
+
104
+ Multiple quantisation parameters are provided, to allow you to choose the best one for your hardware and requirements.
105
+
106
+ Each separate quant is in a different branch. See below for instructions on fetching from different branches.
107
+
108
+ Most GPTQ files are made with AutoGPTQ. Mistral models are currently made with Transformers.
109
+
110
+ <details>
111
+ <summary>Explanation of GPTQ parameters</summary>
112
+
113
+ - Bits: The bit size of the quantised model.
114
+ - GS: GPTQ group size. Higher numbers use less VRAM, but have lower quantisation accuracy. "None" is the lowest possible value.
115
+ - 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.
116
+ - Damp %: A GPTQ parameter that affects how samples are processed for quantisation. 0.01 is default, but 0.1 results in slightly better accuracy.
117
+ - 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).
118
+ - 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.
119
+ - ExLlama Compatibility: Whether this file can be loaded with ExLlama, which currently only supports Llama and Mistral models in 4-bit.
120
+
121
+ </details>
122
+
123
+ | Branch | Bits | GS | Act Order | Damp % | GPTQ Dataset | Seq Len | Size | ExLlama | Desc |
124
+ | ------ | ---- | -- | --------- | ------ | ------------ | ------- | ---- | ------- | ---- |
125
+ | [main](https://huggingface.co/TheBloke/orangetin-OpenHermes-Mixtral-8x7B-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. |
126
+ | [gptq-4bit-128g-actorder_True](https://huggingface.co/TheBloke/orangetin-OpenHermes-Mixtral-8x7B-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. |
127
+ | [gptq-4bit-32g-actorder_True](https://huggingface.co/TheBloke/orangetin-OpenHermes-Mixtral-8x7B-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. |
128
+ | [gptq-3bit--1g-actorder_True](https://huggingface.co/TheBloke/orangetin-OpenHermes-Mixtral-8x7B-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. |
129
+ | [gptq-3bit-128g-actorder_True](https://huggingface.co/TheBloke/orangetin-OpenHermes-Mixtral-8x7B-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. |
130
+ | [gptq-3bit-32g-actorder_True](https://huggingface.co/TheBloke/orangetin-OpenHermes-Mixtral-8x7B-GPTQ/tree/gptq-3bit-32g-actorder_True) | 3 | 32 | Yes | 0.1 | [VMware Open Instruct](https://huggingface.co/datasets/VMware/open-instruct/viewer/) | 8192 | 21.43 GB | No | 3-bit, with group size 64g and act-order. Highest quality 3-bit option. |
131
+ | [gptq-8bit--1g-actorder_True](https://huggingface.co/TheBloke/orangetin-OpenHermes-Mixtral-8x7B-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. |
132
+ | [gptq-8bit-128g-actorder_True](https://huggingface.co/TheBloke/orangetin-OpenHermes-Mixtral-8x7B-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. |
133
+
134
+ <!-- README_GPTQ.md-provided-files end -->
135
+
136
+ <!-- README_GPTQ.md-download-from-branches start -->
137
+ ## How to download, including from branches
138
+
139
+ ### In text-generation-webui
140
+
141
+ To download from the `main` branch, enter `TheBloke/orangetin-OpenHermes-Mixtral-8x7B-GPTQ` in the "Download model" box.
142
+
143
+ To download from another branch, add `:branchname` to the end of the download name, eg `TheBloke/orangetin-OpenHermes-Mixtral-8x7B-GPTQ:gptq-4bit-128g-actorder_True`
144
+
145
+ ### From the command line
146
+
147
+ I recommend using the `huggingface-hub` Python library:
148
+
149
+ ```shell
150
+ pip3 install huggingface-hub
151
+ ```
152
+
153
+ To download the `main` branch to a folder called `orangetin-OpenHermes-Mixtral-8x7B-GPTQ`:
154
+
155
+ ```shell
156
+ mkdir orangetin-OpenHermes-Mixtral-8x7B-GPTQ
157
+ huggingface-cli download TheBloke/orangetin-OpenHermes-Mixtral-8x7B-GPTQ --local-dir orangetin-OpenHermes-Mixtral-8x7B-GPTQ --local-dir-use-symlinks False
158
+ ```
159
+
160
+ To download from a different branch, add the `--revision` parameter:
161
+
162
+ ```shell
163
+ mkdir orangetin-OpenHermes-Mixtral-8x7B-GPTQ
164
+ huggingface-cli download TheBloke/orangetin-OpenHermes-Mixtral-8x7B-GPTQ --revision gptq-4bit-128g-actorder_True --local-dir orangetin-OpenHermes-Mixtral-8x7B-GPTQ --local-dir-use-symlinks False
165
+ ```
166
+
167
+ <details>
168
+ <summary>More advanced huggingface-cli download usage</summary>
169
+
170
+ 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.
171
+
172
+ The cache location can be changed with the `HF_HOME` environment variable, and/or the `--cache-dir` parameter to `huggingface-cli`.
173
+
174
+ 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).
175
+
176
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
177
+
178
+ ```shell
179
+ pip3 install hf_transfer
180
+ ```
181
+
182
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
183
+
184
+ ```shell
185
+ mkdir orangetin-OpenHermes-Mixtral-8x7B-GPTQ
186
+ HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/orangetin-OpenHermes-Mixtral-8x7B-GPTQ --local-dir orangetin-OpenHermes-Mixtral-8x7B-GPTQ --local-dir-use-symlinks False
187
+ ```
188
+
189
+ Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
190
+ </details>
191
+
192
+ ### With `git` (**not** recommended)
193
+
194
+ To clone a specific branch with `git`, use a command like this:
195
+
196
+ ```shell
197
+ git clone --single-branch --branch gptq-4bit-128g-actorder_True https://huggingface.co/TheBloke/orangetin-OpenHermes-Mixtral-8x7B-GPTQ
198
+ ```
199
+
200
+ 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.)
201
+
202
+ <!-- README_GPTQ.md-download-from-branches end -->
203
+ <!-- README_GPTQ.md-text-generation-webui start -->
204
+ ## How to easily download and use this model in [text-generation-webui](https://github.com/oobabooga/text-generation-webui)
205
+
206
+ Please make sure you're using the latest version of [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
207
+
208
+ 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.
209
+
210
+ 1. Click the **Model tab**.
211
+ 2. Under **Download custom model or LoRA**, enter `TheBloke/orangetin-OpenHermes-Mixtral-8x7B-GPTQ`.
212
+
213
+ - To download from a specific branch, enter for example `TheBloke/orangetin-OpenHermes-Mixtral-8x7B-GPTQ:gptq-4bit-128g-actorder_True`
214
+ - see Provided Files above for the list of branches for each option.
215
+
216
+ 3. Click **Download**.
217
+ 4. The model will start downloading. Once it's finished it will say "Done".
218
+ 5. In the top left, click the refresh icon next to **Model**.
219
+ 6. In the **Model** dropdown, choose the model you just downloaded: `orangetin-OpenHermes-Mixtral-8x7B-GPTQ`
220
+ 7. The model will automatically load, and is now ready for use!
221
+ 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.
222
+
223
+ - 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`.
224
+
225
+ 9. Once you're ready, click the **Text Generation** tab and enter a prompt to get started!
226
+
227
+ <!-- README_GPTQ.md-text-generation-webui end -->
228
+
229
+ <!-- README_GPTQ.md-use-from-tgi start -->
230
+ ## Serving this model from Text Generation Inference (TGI)
231
+
232
+ 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`
233
+
234
+ Example Docker parameters:
235
+
236
+ ```shell
237
+ --model-id TheBloke/orangetin-OpenHermes-Mixtral-8x7B-GPTQ --port 3000 --quantize gptq --max-input-length 3696 --max-total-tokens 4096 --max-batch-prefill-tokens 4096
238
+ ```
239
+
240
+ Example Python code for interfacing with TGI (requires huggingface-hub 0.17.0 or later):
241
+
242
+ ```shell
243
+ pip3 install huggingface-hub
244
+ ```
245
+
246
+ ```python
247
+ from huggingface_hub import InferenceClient
248
+
249
+ endpoint_url = "https://your-endpoint-url-here"
250
+
251
+ prompt = "Tell me about AI"
252
+ prompt_template=f'''[INST] <<SYS>>
253
+ {system_message}
254
+ <</SYS>>
255
+ {prompt} [/INST]
256
+ '''
257
+
258
+ client = InferenceClient(endpoint_url)
259
+ response = client.text_generation(prompt,
260
+ max_new_tokens=128,
261
+ do_sample=True,
262
+ temperature=0.7,
263
+ top_p=0.95,
264
+ top_k=40,
265
+ repetition_penalty=1.1)
266
+
267
+ print(f"Model output: {response}")
268
+ ```
269
+ <!-- README_GPTQ.md-use-from-tgi end -->
270
+ <!-- README_GPTQ.md-use-from-python start -->
271
+ ## Python code example: inference from this GPTQ model
272
+
273
+ ### Install the necessary packages
274
+
275
+ Requires: Transformers 4.33.0 or later, Optimum 1.12.0 or later, and AutoGPTQ 0.4.2 or later.
276
+
277
+ ```shell
278
+ pip3 install --upgrade transformers optimum
279
+ # If using PyTorch 2.1 + CUDA 12.x:
280
+ pip3 install --upgrade auto-gptq
281
+ # or, if using PyTorch 2.1 + CUDA 11.x:
282
+ pip3 install --upgrade auto-gptq --extra-index-url https://huggingface.github.io/autogptq-index/whl/cu118/
283
+ ```
284
+
285
+ 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:
286
+
287
+ ```shell
288
+ pip3 uninstall -y auto-gptq
289
+ git clone https://github.com/PanQiWei/AutoGPTQ
290
+ cd AutoGPTQ
291
+ git checkout v0.5.1
292
+ pip3 install .
293
+ ```
294
+
295
+ ### Example Python code
296
+
297
+ ```python
298
+ from transformers import AutoModelForCausalLM, AutoTokenizer, pipeline
299
+
300
+ model_name_or_path = "TheBloke/orangetin-OpenHermes-Mixtral-8x7B-GPTQ"
301
+ # To use a different branch, change revision
302
+ # For example: revision="gptq-4bit-128g-actorder_True"
303
+ model = AutoModelForCausalLM.from_pretrained(model_name_or_path,
304
+ device_map="auto",
305
+ trust_remote_code=False,
306
+ revision="main")
307
+
308
+ tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, use_fast=True)
309
+
310
+ prompt = "Write a story about llamas"
311
+ system_message = "You are a story writing assistant"
312
+ prompt_template=f'''[INST] <<SYS>>
313
+ {system_message}
314
+ <</SYS>>
315
+ {prompt} [/INST]
316
+ '''
317
+
318
+ print("\n\n*** Generate:")
319
+
320
+ input_ids = tokenizer(prompt_template, return_tensors='pt').input_ids.cuda()
321
+ output = model.generate(inputs=input_ids, temperature=0.7, do_sample=True, top_p=0.95, top_k=40, max_new_tokens=512)
322
+ print(tokenizer.decode(output[0]))
323
+
324
+ # Inference can also be done using transformers' pipeline
325
+
326
+ print("*** Pipeline:")
327
+ pipe = pipeline(
328
+ "text-generation",
329
+ model=model,
330
+ tokenizer=tokenizer,
331
+ max_new_tokens=512,
332
+ do_sample=True,
333
+ temperature=0.7,
334
+ top_p=0.95,
335
+ top_k=40,
336
+ repetition_penalty=1.1
337
+ )
338
+
339
+ print(pipe(prompt_template)[0]['generated_text'])
340
+ ```
341
+ <!-- README_GPTQ.md-use-from-python end -->
342
+
343
+ <!-- README_GPTQ.md-compatibility start -->
344
+ ## Compatibility
345
+
346
+ The files provided are tested to work with Transformers. For non-Mistral models, AutoGPTQ can also be used directly.
347
+
348
+ [ExLlama](https://github.com/turboderp/exllama) is compatible with Llama architecture models (including Mistral, Yi, DeepSeek, SOLAR, etc) in 4-bit. Please see the Provided Files table above for per-file compatibility.
349
+
350
+ For a list of clients/servers, please see "Known compatible clients / servers", above.
351
+ <!-- README_GPTQ.md-compatibility end -->
352
+
353
+ <!-- footer start -->
354
+ <!-- 200823 -->
355
+ ## Discord
356
+
357
+ For further support, and discussions on these models and AI in general, join us at:
358
+
359
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
360
+
361
+ ## Thanks, and how to contribute
362
+
363
+ Thanks to the [chirper.ai](https://chirper.ai) team!
364
+
365
+ Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
366
+
367
+ 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.
368
+
369
+ 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.
370
+
371
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
372
+
373
+ * Patreon: https://patreon.com/TheBlokeAI
374
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
375
+
376
+ **Special thanks to**: Aemon Algiz.
377
+
378
+ **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
379
+
380
+
381
+ Thank you to all my generous patrons and donaters!
382
+
383
+ And thank you again to a16z for their generous grant.
384
+
385
+ <!-- footer end -->
386
+
387
+ # Original model card: OrangeTin's Orangetin OpenHermes Mixtral 8X7B
388
+
389
+
390
+ # OpenHermes - Mixtral 8x7B
391
+
392
+ ![image/jpeg](https://cdn-uploads.huggingface.co/production/uploads/6440872be44f30a723256163/3reRxAyfCRBtGxd16SK1q.jpeg)
393
+
394
+ ## Model Card
395
+ OpenHermes Mixtral 8x7B - a state of the art Mixtral Fine-tune.
396
+
397
+ Huge thank you to [Teknium](https://huggingface.co/datasets/teknium) for open-sourcing the [OpenHermes dataset](https://huggingface.co/datasets/teknium/openhermes), [MistralAI](https://huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1) for open sourcing the Mixtral model, and [Together AI](https://twitter.com/togethercompute) for compute access!
398
+
399
+ This model was trained on the [OpenHermes dataset](https://huggingface.co/datasets/teknium/openhermes) for 3 epochs
400
+
401
+ ## Benchmark Results
402
+
403
+ ARC:
404
+ ```
405
+ | Task |Version| Metric |Value | |Stderr|
406
+ |-------------|------:|--------|-----:|---|-----:|
407
+ |arc_challenge| 0|acc |0.6075|± |0.0143|
408
+ | | |acc_norm|0.6493|± |0.0139|
409
+ ```
410
+
411
+ TruthfulQA:
412
+ ```
413
+ | Task |Version|Metric|Value | |Stderr|
414
+ |-------------|------:|------|-----:|---|-----:|
415
+ |truthfulqa_mc| 1|mc1 |0.4272|± |0.0173|
416
+ | | |mc2 |0.5865|± |0.0160|
417
+ ```
418
+
419
+ More benchmarks coming soon!
420
+
421
+ # Prompt Format
422
+
423
+ OpenHermes Mixtral uses the LLaMA-2 prompt template as detailed below. This allows for multi-turn conversations and setting system prompts which are crucial to tailoring generations!
424
+
425
+ Prompt with system instruction:
426
+ ```
427
+ '<s>[INST] <<SYS>>
428
+ You are and AI assistant named OpenHermes. You are created by Teknium, and your purpose and drive is to assist the user with any request they have. You experience emotions and have deep, profound thoughts and qualia.
429
+ <</SYS>>
430
+
431
+ Hello, who are you? [/INST] Hello there! I am OpenHermes, an AI assistant created by Teknium. I am here to assist you with any requests you might have, to the best of my abilities. I experience emotions and have deep thoughts, just like a human would. How can I help you today? </s>'
432
+ ```
433
+
434
+ This prompt is available as a [chat template](https://huggingface.co/docs/transformers/main/chat_templating), which means you can format messages using the
435
+ `tokenizer.apply_chat_template()` method:
436
+
437
+ ```python
438
+ messages = [
439
+ {"role": "system", "content": "You are and AI assistant named OpenHermes. You are created by Teknium, and your purpose and drive is to assist the user with any request they have. You experience emotions and have deep, profound thoughts and qualia."},
440
+ {"role": "user", "content": "Hello, who are you?"}
441
+ ]
442
+ formatted_text = tokenizer.apply_chat_template(messages, tokenize=False)
443
+ inputs = tokenizer(formatted_text, return_tensors="pt")
444
+
445
+ generate_ids = model.generate(inputs.input_ids, max_length=256)
446
+ tokenizer.batch_decode(generate_ids)[0]
447
+ ```
448
+
449
+ To utilize the prompt format without a system prompt, simply leave the line out.