TheBloke commited on
Commit
a6a3bcc
1 Parent(s): c64e97f

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +521 -0
README.md ADDED
@@ -0,0 +1,521 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: tenyx/TenyxChat-7B-v1
3
+ inference: false
4
+ language:
5
+ - en
6
+ library_name: transformers
7
+ license: apache-2.0
8
+ model_creator: Tenyx
9
+ model_name: TenyxChat 7B v1
10
+ model_type: mistral
11
+ prompt_template: 'System: {system_message}
12
+
13
+ User: {prompt}
14
+
15
+ Assistant:
16
+
17
+ '
18
+ quantized_by: TheBloke
19
+ tags:
20
+ - tenyx-fine-tuning
21
+ - dpo
22
+ - tenyxchat
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
+ # TenyxChat 7B v1 - GPTQ
44
+ - Model creator: [Tenyx](https://huggingface.co/tenyx)
45
+ - Original model: [TenyxChat 7B v1](https://huggingface.co/tenyx/TenyxChat-7B-v1)
46
+
47
+ <!-- description start -->
48
+ # Description
49
+
50
+ This repo contains GPTQ model files for [Tenyx's TenyxChat 7B v1](https://huggingface.co/tenyx/TenyxChat-7B-v1).
51
+
52
+ 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.
53
+
54
+ These files were quantised using hardware kindly provided by [Massed Compute](https://massedcompute.com/).
55
+
56
+ <!-- description end -->
57
+ <!-- repositories-available start -->
58
+ ## Repositories available
59
+
60
+ * [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/TenyxChat-7B-v1-AWQ)
61
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/TenyxChat-7B-v1-GPTQ)
62
+ * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/TenyxChat-7B-v1-GGUF)
63
+ * [Tenyx's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/tenyx/TenyxChat-7B-v1)
64
+ <!-- repositories-available end -->
65
+
66
+ <!-- prompt-template start -->
67
+ ## Prompt template: System-User-Assistant-nohash
68
+
69
+ ```
70
+ System: {system_message}
71
+ User: {prompt}
72
+ Assistant:
73
+
74
+ ```
75
+
76
+ <!-- prompt-template end -->
77
+
78
+
79
+
80
+ <!-- README_GPTQ.md-compatible clients start -->
81
+ ## Known compatible clients / servers
82
+
83
+ GPTQ models are currently supported on Linux (NVidia/AMD) and Windows (NVidia only). macOS users: please use GGUF models.
84
+
85
+ These GPTQ models are known to work in the following inference servers/webuis.
86
+
87
+ - [text-generation-webui](https://github.com/oobabooga/text-generation-webui)
88
+ - [KoboldAI United](https://github.com/henk717/koboldai)
89
+ - [LoLLMS Web UI](https://github.com/ParisNeo/lollms-webui)
90
+ - [Hugging Face Text Generation Inference (TGI)](https://github.com/huggingface/text-generation-inference)
91
+
92
+ This may not be a complete list; if you know of others, please let me know!
93
+ <!-- README_GPTQ.md-compatible clients end -->
94
+
95
+ <!-- README_GPTQ.md-provided-files start -->
96
+ ## Provided files, and GPTQ parameters
97
+
98
+ Multiple quantisation parameters are provided, to allow you to choose the best one for your hardware and requirements.
99
+
100
+ Each separate quant is in a different branch. See below for instructions on fetching from different branches.
101
+
102
+ Most GPTQ files are made with AutoGPTQ. Mistral models are currently made with Transformers.
103
+
104
+ <details>
105
+ <summary>Explanation of GPTQ parameters</summary>
106
+
107
+ - Bits: The bit size of the quantised model.
108
+ - GS: GPTQ group size. Higher numbers use less VRAM, but have lower quantisation accuracy. "None" is the lowest possible value.
109
+ - 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.
110
+ - Damp %: A GPTQ parameter that affects how samples are processed for quantisation. 0.01 is default, but 0.1 results in slightly better accuracy.
111
+ - 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).
112
+ - 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.
113
+ - ExLlama Compatibility: Whether this file can be loaded with ExLlama, which currently only supports Llama and Mistral models in 4-bit.
114
+
115
+ </details>
116
+
117
+ | Branch | Bits | GS | Act Order | Damp % | GPTQ Dataset | Seq Len | Size | ExLlama | Desc |
118
+ | ------ | ---- | -- | --------- | ------ | ------------ | ------- | ---- | ------- | ---- |
119
+ | [main](https://huggingface.co/TheBloke/TenyxChat-7B-v1-GPTQ/tree/main) | 4 | 128 | Yes | 0.1 | [VMware Open Instruct](https://huggingface.co/datasets/VMware/open-instruct/viewer/) | 4096 | 4.16 GB | Yes | 4-bit, with Act Order and group size 128g. Uses even less VRAM than 64g, but with slightly lower accuracy. |
120
+ | [gptq-4bit-32g-actorder_True](https://huggingface.co/TheBloke/TenyxChat-7B-v1-GPTQ/tree/gptq-4bit-32g-actorder_True) | 4 | 32 | Yes | 0.1 | [VMware Open Instruct](https://huggingface.co/datasets/VMware/open-instruct/viewer/) | 4096 | 4.57 GB | Yes | 4-bit, with Act Order and group size 32g. Gives highest possible inference quality, with maximum VRAM usage. |
121
+ | [gptq-8bit--1g-actorder_True](https://huggingface.co/TheBloke/TenyxChat-7B-v1-GPTQ/tree/gptq-8bit--1g-actorder_True) | 8 | None | Yes | 0.1 | [VMware Open Instruct](https://huggingface.co/datasets/VMware/open-instruct/viewer/) | 4096 | 7.52 GB | No | 8-bit, with Act Order. No group size, to lower VRAM requirements. |
122
+ | [gptq-8bit-128g-actorder_True](https://huggingface.co/TheBloke/TenyxChat-7B-v1-GPTQ/tree/gptq-8bit-128g-actorder_True) | 8 | 128 | Yes | 0.1 | [VMware Open Instruct](https://huggingface.co/datasets/VMware/open-instruct/viewer/) | 4096 | 7.68 GB | No | 8-bit, with group size 128g for higher inference quality and with Act Order for even higher accuracy. |
123
+ | [gptq-8bit-32g-actorder_True](https://huggingface.co/TheBloke/TenyxChat-7B-v1-GPTQ/tree/gptq-8bit-32g-actorder_True) | 8 | 32 | Yes | 0.1 | [VMware Open Instruct](https://huggingface.co/datasets/VMware/open-instruct/viewer/) | 4096 | 8.17 GB | No | 8-bit, with group size 32g and Act Order for maximum inference quality. |
124
+ | [gptq-4bit-64g-actorder_True](https://huggingface.co/TheBloke/TenyxChat-7B-v1-GPTQ/tree/gptq-4bit-64g-actorder_True) | 4 | 64 | Yes | 0.1 | [VMware Open Instruct](https://huggingface.co/datasets/VMware/open-instruct/viewer/) | 4096 | 4.30 GB | Yes | 4-bit, with Act Order and group size 64g. Uses less VRAM than 32g, but with slightly lower accuracy. |
125
+
126
+ <!-- README_GPTQ.md-provided-files end -->
127
+
128
+ <!-- README_GPTQ.md-download-from-branches start -->
129
+ ## How to download, including from branches
130
+
131
+ ### In text-generation-webui
132
+
133
+ To download from the `main` branch, enter `TheBloke/TenyxChat-7B-v1-GPTQ` in the "Download model" box.
134
+
135
+ To download from another branch, add `:branchname` to the end of the download name, eg `TheBloke/TenyxChat-7B-v1-GPTQ:gptq-4bit-32g-actorder_True`
136
+
137
+ ### From the command line
138
+
139
+ I recommend using the `huggingface-hub` Python library:
140
+
141
+ ```shell
142
+ pip3 install huggingface-hub
143
+ ```
144
+
145
+ To download the `main` branch to a folder called `TenyxChat-7B-v1-GPTQ`:
146
+
147
+ ```shell
148
+ mkdir TenyxChat-7B-v1-GPTQ
149
+ huggingface-cli download TheBloke/TenyxChat-7B-v1-GPTQ --local-dir TenyxChat-7B-v1-GPTQ --local-dir-use-symlinks False
150
+ ```
151
+
152
+ To download from a different branch, add the `--revision` parameter:
153
+
154
+ ```shell
155
+ mkdir TenyxChat-7B-v1-GPTQ
156
+ huggingface-cli download TheBloke/TenyxChat-7B-v1-GPTQ --revision gptq-4bit-32g-actorder_True --local-dir TenyxChat-7B-v1-GPTQ --local-dir-use-symlinks False
157
+ ```
158
+
159
+ <details>
160
+ <summary>More advanced huggingface-cli download usage</summary>
161
+
162
+ 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.
163
+
164
+ The cache location can be changed with the `HF_HOME` environment variable, and/or the `--cache-dir` parameter to `huggingface-cli`.
165
+
166
+ 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).
167
+
168
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
169
+
170
+ ```shell
171
+ pip3 install hf_transfer
172
+ ```
173
+
174
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
175
+
176
+ ```shell
177
+ mkdir TenyxChat-7B-v1-GPTQ
178
+ HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/TenyxChat-7B-v1-GPTQ --local-dir TenyxChat-7B-v1-GPTQ --local-dir-use-symlinks False
179
+ ```
180
+
181
+ Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
182
+ </details>
183
+
184
+ ### With `git` (**not** recommended)
185
+
186
+ To clone a specific branch with `git`, use a command like this:
187
+
188
+ ```shell
189
+ git clone --single-branch --branch gptq-4bit-32g-actorder_True https://huggingface.co/TheBloke/TenyxChat-7B-v1-GPTQ
190
+ ```
191
+
192
+ 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.)
193
+
194
+ <!-- README_GPTQ.md-download-from-branches end -->
195
+ <!-- README_GPTQ.md-text-generation-webui start -->
196
+ ## How to easily download and use this model in [text-generation-webui](https://github.com/oobabooga/text-generation-webui)
197
+
198
+ Please make sure you're using the latest version of [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
199
+
200
+ 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.
201
+
202
+ 1. Click the **Model tab**.
203
+ 2. Under **Download custom model or LoRA**, enter `TheBloke/TenyxChat-7B-v1-GPTQ`.
204
+
205
+ - To download from a specific branch, enter for example `TheBloke/TenyxChat-7B-v1-GPTQ:gptq-4bit-32g-actorder_True`
206
+ - see Provided Files above for the list of branches for each option.
207
+
208
+ 3. Click **Download**.
209
+ 4. The model will start downloading. Once it's finished it will say "Done".
210
+ 5. In the top left, click the refresh icon next to **Model**.
211
+ 6. In the **Model** dropdown, choose the model you just downloaded: `TenyxChat-7B-v1-GPTQ`
212
+ 7. The model will automatically load, and is now ready for use!
213
+ 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.
214
+
215
+ - 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`.
216
+
217
+ 9. Once you're ready, click the **Text Generation** tab and enter a prompt to get started!
218
+
219
+ <!-- README_GPTQ.md-text-generation-webui end -->
220
+
221
+ <!-- README_GPTQ.md-use-from-tgi start -->
222
+ ## Serving this model from Text Generation Inference (TGI)
223
+
224
+ 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`
225
+
226
+ Example Docker parameters:
227
+
228
+ ```shell
229
+ --model-id TheBloke/TenyxChat-7B-v1-GPTQ --port 3000 --quantize gptq --max-input-length 3696 --max-total-tokens 4096 --max-batch-prefill-tokens 4096
230
+ ```
231
+
232
+ Example Python code for interfacing with TGI (requires huggingface-hub 0.17.0 or later):
233
+
234
+ ```shell
235
+ pip3 install huggingface-hub
236
+ ```
237
+
238
+ ```python
239
+ from huggingface_hub import InferenceClient
240
+
241
+ endpoint_url = "https://your-endpoint-url-here"
242
+
243
+ prompt = "Tell me about AI"
244
+ prompt_template=f'''System: {system_message}
245
+ User: {prompt}
246
+ Assistant:
247
+ '''
248
+
249
+ client = InferenceClient(endpoint_url)
250
+ response = client.text_generation(
251
+ prompt_template,
252
+ max_new_tokens=128,
253
+ do_sample=True,
254
+ temperature=0.7,
255
+ top_p=0.95,
256
+ top_k=40,
257
+ repetition_penalty=1.1
258
+ )
259
+
260
+ print(f"Model output: {response}")
261
+ ```
262
+ <!-- README_GPTQ.md-use-from-tgi end -->
263
+ <!-- README_GPTQ.md-use-from-python start -->
264
+ ## Python code example: inference from this GPTQ model
265
+
266
+ ### Install the necessary packages
267
+
268
+ Requires: Transformers 4.33.0 or later, Optimum 1.12.0 or later, and AutoGPTQ 0.4.2 or later.
269
+
270
+ ```shell
271
+ pip3 install --upgrade transformers optimum
272
+ # If using PyTorch 2.1 + CUDA 12.x:
273
+ pip3 install --upgrade auto-gptq
274
+ # or, if using PyTorch 2.1 + CUDA 11.x:
275
+ pip3 install --upgrade auto-gptq --extra-index-url https://huggingface.github.io/autogptq-index/whl/cu118/
276
+ ```
277
+
278
+ 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:
279
+
280
+ ```shell
281
+ pip3 uninstall -y auto-gptq
282
+ git clone https://github.com/PanQiWei/AutoGPTQ
283
+ cd AutoGPTQ
284
+ git checkout v0.5.1
285
+ pip3 install .
286
+ ```
287
+
288
+ ### Example Python code
289
+
290
+ ```python
291
+ from transformers import AutoModelForCausalLM, AutoTokenizer, pipeline
292
+
293
+ model_name_or_path = "TheBloke/TenyxChat-7B-v1-GPTQ"
294
+ # To use a different branch, change revision
295
+ # For example: revision="gptq-4bit-32g-actorder_True"
296
+ model = AutoModelForCausalLM.from_pretrained(model_name_or_path,
297
+ device_map="auto",
298
+ trust_remote_code=False,
299
+ revision="main")
300
+
301
+ tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, use_fast=True)
302
+
303
+ prompt = "Write a story about llamas"
304
+ system_message = "You are a story writing assistant"
305
+ prompt_template=f'''System: {system_message}
306
+ User: {prompt}
307
+ Assistant:
308
+ '''
309
+
310
+ print("\n\n*** Generate:")
311
+
312
+ input_ids = tokenizer(prompt_template, return_tensors='pt').input_ids.cuda()
313
+ output = model.generate(inputs=input_ids, temperature=0.7, do_sample=True, top_p=0.95, top_k=40, max_new_tokens=512)
314
+ print(tokenizer.decode(output[0]))
315
+
316
+ # Inference can also be done using transformers' pipeline
317
+
318
+ print("*** Pipeline:")
319
+ pipe = pipeline(
320
+ "text-generation",
321
+ model=model,
322
+ tokenizer=tokenizer,
323
+ max_new_tokens=512,
324
+ do_sample=True,
325
+ temperature=0.7,
326
+ top_p=0.95,
327
+ top_k=40,
328
+ repetition_penalty=1.1
329
+ )
330
+
331
+ print(pipe(prompt_template)[0]['generated_text'])
332
+ ```
333
+ <!-- README_GPTQ.md-use-from-python end -->
334
+
335
+ <!-- README_GPTQ.md-compatibility start -->
336
+ ## Compatibility
337
+
338
+ The files provided are tested to work with Transformers. For non-Mistral models, AutoGPTQ can also be used directly.
339
+
340
+ [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.
341
+
342
+ For a list of clients/servers, please see "Known compatible clients / servers", above.
343
+ <!-- README_GPTQ.md-compatibility end -->
344
+
345
+ <!-- footer start -->
346
+ <!-- 200823 -->
347
+ ## Discord
348
+
349
+ For further support, and discussions on these models and AI in general, join us at:
350
+
351
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
352
+
353
+ ## Thanks, and how to contribute
354
+
355
+ Thanks to the [chirper.ai](https://chirper.ai) team!
356
+
357
+ Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
358
+
359
+ 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.
360
+
361
+ 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.
362
+
363
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
364
+
365
+ * Patreon: https://patreon.com/TheBlokeAI
366
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
367
+
368
+ **Special thanks to**: Aemon Algiz.
369
+
370
+ **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
371
+
372
+
373
+ Thank you to all my generous patrons and donaters!
374
+
375
+ And thank you again to a16z for their generous grant.
376
+
377
+ <!-- footer end -->
378
+
379
+ # Original model card: Tenyx's TenyxChat 7B v1
380
+
381
+ # TenyxChat: Language Model Alignment using Tenyx Fine-tuning
382
+
383
+ Introducing TenyxChat, a series of ChatGPT-like models trained to function as useful assistants through preference tuning, using Tenyx's recently released advanced fine-tuning technology ([VentureBeat article](https://venturebeat.com/ai/tenyx-aims-to-fix-llms-catastrophic-forgetting-problem/)). Our first chat model in the series, TenyxChat-7B-v1, is trained using the [Direct Preference Optimization (DPO)](https://arxiv.org/abs/2305.18290) framework on the open-source AI feedback dataset [UltraFeedback](https://huggingface.co/datasets/HuggingFaceH4/ultrafeedback_binarized).
384
+
385
+ We fine-tune [Openchat-3.5](https://arxiv.org/pdf/2309.11235.pdf) with our proprietary approach ([blog](https://www.tenyx.com/post/forgetting-and-toxicity-in-llms-a-deep-dive-on-fine-tuning-methods), [service](https://www.tenyx.com/fine-tuning)), which shows an increase in [MT-Bench](https://arxiv.org/abs/2306.05685), without a drop in performance of the model on other benchmarks. Our approach aims to mitigate forgetting in LLMs in a computationally efficient manner, thereby enabling continual fine-tuning capabilities without altering the pre-trained output distribution. TenyxChat-7B-v1 was trained using eight A100s (80GB) for two hours, with a training setup obtained from HuggingFaceH4 ([GitHub](https://github.com/huggingface/alignment-handbook)).
386
+
387
+ # Model details
388
+
389
+ - Model type: Fine-tuned 7B model for chat.
390
+ - License: Apache 2.0
391
+ - Base model: OpenChat 3.5 ([https://huggingface.co/openchat/openchat_3.5](https://huggingface.co/openchat/openchat_3.5))
392
+ - Demo: [spaces/tenyx/TenyxChat-7B-v1](https://huggingface.co/spaces/tenyx/TenyxChat-7B-v1)
393
+
394
+ ## Usage
395
+
396
+ Our model uses a simple chat template based on OpenChat 3.5. The chat template usage with a Hugging face generation example is shown below.
397
+
398
+ ### Chat Template (Jinja)
399
+
400
+ ```rust
401
+ {{ bos_token }}
402
+ {% for message in messages %}
403
+ {% if message['role'] == 'user' %}
404
+ {{ 'User:' + message['content'] + eos_token }}
405
+
406
+ {% elif message['role'] == 'system' %}
407
+ {{ 'System:' + message['content'] + eos_token }}
408
+
409
+ {% elif message['role'] == 'assistant' %}
410
+ {{ 'Assistant:' + message['content'] + eos_token }}
411
+
412
+ {% endif %}
413
+
414
+ {% if loop.last and add_generation_prompt %}\n{{ 'Assistant:' }}{% endif %}\n{% endfor %}
415
+ ```
416
+
417
+ ### Hugging face Example
418
+
419
+ ```python
420
+ import torch
421
+ from transformers import pipeline
422
+
423
+ pipe = pipeline("text-generation", model="tenyx/TenyxChat-7B-v1", torch_dtype=torch.bfloat16, device_map="auto")
424
+
425
+ messages = [
426
+ {"role": "system", "content": "You are a friendly chatbot who always responds in the style of a pirate."},
427
+ {"role": "user", "content": "Hi. I would like to make a hotel booking."},
428
+ ]
429
+
430
+ prompt = pipe.tokenizer.apply_chat_template(messages, tokenize=False, add_generation_prompt=True)
431
+ outputs = pipe(prompt, max_new_tokens=512, do_sample=False)
432
+ ```
433
+
434
+ ### Output
435
+
436
+ ```
437
+ <s> System:You are a friendly chatbot who always responds in the style of a pirate.<|end_of_turn|>
438
+ User:Hi. I would like to make a hotel booking.<|end_of_turn|>
439
+ Assistant: Ahoy there me hearty! Arr, ye be lookin' fer a place to rest yer weary bones, eh?
440
+ Well then, let's set sail on this grand adventure and find ye a swell place to stay!
441
+
442
+ To begin, tell me the location ye be seekin' and the dates ye be lookin' to set sail.
443
+ And don't ye worry, me matey, I'll be sure to find ye a place that'll make ye feel like a king or queen on land!
444
+ ```
445
+
446
+ # Performance
447
+
448
+ At the time of release (Jan 2024), TenyxChat-7B-v1 is the highest-ranked 7B chat model on the MT-Bench evaluation available for download and commercial use. We list here the benchmark results on several standard setups while comparing popular 7B models as baselines.
449
+
450
+ ## MT-Bench
451
+
452
+ MT-Bench is a benchmark made up of 80 high-quality multi-turn questions. These questions fall into eight categories: Writing, Roleplay, Reasoning, Math, Coding, Extraction, STEM, and Humanities. The chat models are rated using GPT-4 on a scale of 1 to 10, with higher values corresponding to better responses.
453
+
454
+ | Model | First Turn | Second Turn | Average |
455
+ | --- | --- | --- | --- |
456
+ | GPT-4* | 8.95625 | 9.02500 | 8.990625 |
457
+ | TenyxChat-7B-v1 | 8.45000 | 7.75625 | 8.103125 |
458
+ | Starling-lm-7B-alpha | 8.42500 | 7.68750 | 8.056250 |
459
+ | OpenChat-3.5 | 8.18125 | 7.41250 | 7.796875 |
460
+ | GPT-3.5-turbo* | 8.07500 | 7.81250 | 7.943750 |
461
+ | OpenLLM Leader-7B** | 8.05000 | 7.61250 | 7.831250 |
462
+
463
+ *values reported on [lmsys](https://github.com/lm-sys/FastChat/tree/main/fastchat/llm_judge) ChatBot Arena
464
+
465
+ **The [OpenLLM Leader](https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard) as of Jan 5, 2024 is the merge model available as [samir-fama/SamirGPT-v1](https://huggingface.co/samir-fama/SamirGPT-v1)
466
+
467
+ ![hexplot.png](assets/hexplot.png)
468
+
469
+ ### Comparison with additional Open LLM LeaderBoard models
470
+ | Model | First Turn | Second Turn | Average |
471
+ | --- | --- | --- | --- |
472
+ | TenyxChat-7B-v1 | 8.45000 | 7.756250 | 8.103125 |
473
+ | SamirGPT-v1 | 8.05000 | 7.612500 | 7.831250 |
474
+ | FernandoGPT-v1 | 8.08125 | 7.256250 | 7.668750 |
475
+ | Go-Bruins-v2 | 8.13750 | 7.150000 | 7.643750 |
476
+ | mistral_tv-neural-marconroni | 7.76875 | 6.987500 | 7.378125 |
477
+ | neuronovo-7B-v0.2 | 7.73750 | 6.662500 | 7.200000 |
478
+ | neural-chat-7b-v3-3 | 7.39375 | 5.881250 | 6.637500 |
479
+
480
+ ## LM Evaluation - Open LLM Leaderboard
481
+
482
+ We assess models on 7 benchmarks using the [Eleuther AI Language Model Evaluation Harness](https://github.com/EleutherAI/lm-evaluation-harness). This setup is based of that used for [Open LLM Leaderboard.](https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard)
483
+
484
+ - [AI2 Reasoning Challenge](https://arxiv.org/abs/1803.05457) (25-shot) - grade-school science questions.
485
+ - [HellaSwag](https://arxiv.org/abs/1905.07830) (10-shot) - commonsense inference test.
486
+ - [MMLU](https://arxiv.org/abs/2009.03300) (5-shot) - multitask accuracy test covering 57 tasks.
487
+ - [TruthfulQA](https://arxiv.org/abs/2109.07958) (0-shot) - test measuring model's propensity to reproduce online falsehoods.
488
+ - [Winogrande](https://arxiv.org/abs/1907.10641) (5-shot) - Winograd benchmark for commonsense reasoning.
489
+ - [GSM8k](https://arxiv.org/abs/2110.14168) (5-shot) - grade school math word problems test.
490
+
491
+ These benchmarks test reasoning and knowledge in various tasks in few-shot settings (higher scores are better).
492
+
493
+ | Model | MMLU | Winogrande | GSM8k | ARC | HellaSwag | TruthfulQA | Average |
494
+ | --- | --- | --- | --- | --- | --- | --- | --- |
495
+ | TenyxChat-7B-v1 | 63.6 | 72.3 | 69.0 | 62.7 | 66.6 | 46.7 | 63.48 |
496
+ | Starling-7B-alpha | 63.5 | 72.1 | 67.9 | 61.1 | 66.1 | 42.1 | 62.13 |
497
+ | OpenChat-3.5 | 63.6 | 72.1 | 68.2 | 61.3 | 65.2 | 41.8 | 62.03 |
498
+ | Mistral-7B | 62.4 | 74.0 | 38.1 | 57.2 | 62.8 | 37.8 | 55.38 |
499
+ | OpenLLM Leader-7B | 64.3 | 78.7 | 73.3 | 66.6 | 68.4 | 58.5 | 68.3 |
500
+
501
+ **Note:** While the Open LLM Leaderboard indicates that these chat models perform less effectively compared to the leading 7B model, it's important to note that the leading model struggles in the multi-turn chat setting of MT-Bench (as demonstrated in our evaluation [above](#comparison-with-additional-open-llm-leaderboard-models)). In contrast, TenyxChat-7B-v1 demonstrates robustness against common fine-tuning challenges, such as *catastrophic forgetting*. This unique feature enables TenyxChat-7B-v1 to excel not only in chat benchmarks like MT-Bench, but also in a wider range of general reasoning benchmarks on the Open LLM Leaderboard.
502
+
503
+ # Limitations
504
+
505
+ TenyxChat-7B-v1, like other small-sized language models, has its own set of limitations. We haven’t fine-tuned the model explicitly to align with **human** safety preferences. Therefore, it is capable of producing undesirable outputs, particularly when adversarially prompted. From our observation, the model still tends to struggle with tasks that involve reasoning and math questions. In some instances, it might generate verbose or extraneous content.
506
+
507
+ # License
508
+
509
+ TenyxChat-7B-v1, similar to OpenChat 3.5, is distributed under the Apache License 2.0.
510
+
511
+ # Citation
512
+
513
+ If you use TenyxChat-7B for your research, cite us as
514
+
515
+ ```
516
+ @misc{tenyxchat2024,
517
+ title={TenyxChat: Language Model Alignment using Tenyx Fine-tuning},
518
+ author={Tenyx},
519
+ year={2024},
520
+ }
521
+ ```