TheBloke commited on
Commit
f99f5c0
1 Parent(s): a5ac355

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +471 -0
README.md ADDED
@@ -0,0 +1,471 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: Arc53/docsgpt-7b-mistral
3
+ inference: false
4
+ license: apache-2.0
5
+ model_creator: Arc53
6
+ model_name: DocsGPT 7B Mistral
7
+ model_type: mistral
8
+ prompt_template: '### Instruction
9
+
10
+ {prompt}
11
+
12
+ ### Context
13
+
14
+ {{context}}
15
+
16
+ ### Answer
17
+
18
+ '
19
+ quantized_by: TheBloke
20
+ tags:
21
+ - rag
22
+ - closed-qa
23
+ - context
24
+ - mistral
25
+ ---
26
+ <!-- markdownlint-disable MD041 -->
27
+
28
+ <!-- header start -->
29
+ <!-- 200823 -->
30
+ <div style="width: auto; margin-left: auto; margin-right: auto">
31
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
32
+ </div>
33
+ <div style="display: flex; justify-content: space-between; width: 100%;">
34
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
35
+ <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
36
+ </div>
37
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
38
+ <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>
39
+ </div>
40
+ </div>
41
+ <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>
42
+ <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
43
+ <!-- header end -->
44
+
45
+ # DocsGPT 7B Mistral - GPTQ
46
+ - Model creator: [Arc53](https://huggingface.co/Arc53)
47
+ - Original model: [DocsGPT 7B Mistral](https://huggingface.co/Arc53/docsgpt-7b-mistral)
48
+
49
+ <!-- description start -->
50
+ # Description
51
+
52
+ This repo contains GPTQ model files for [Arc53's DocsGPT 7B Mistral](https://huggingface.co/Arc53/docsgpt-7b-mistral).
53
+
54
+ 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.
55
+
56
+ These files were quantised using hardware kindly provided by [Massed Compute](https://massedcompute.com/).
57
+
58
+ <!-- description end -->
59
+ <!-- repositories-available start -->
60
+ ## Repositories available
61
+
62
+ * [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/docsgpt-7B-mistral-AWQ)
63
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/docsgpt-7B-mistral-GPTQ)
64
+ * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/docsgpt-7B-mistral-GGUF)
65
+ * [Arc53's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/Arc53/docsgpt-7b-mistral)
66
+ <!-- repositories-available end -->
67
+
68
+ <!-- prompt-template start -->
69
+ ## Prompt template: DocsGPT
70
+
71
+ ```
72
+ ### Instruction
73
+ {prompt}
74
+ ### Context
75
+ {{context}}
76
+ ### Answer
77
+
78
+ ```
79
+
80
+ <!-- prompt-template end -->
81
+
82
+
83
+
84
+ <!-- README_GPTQ.md-compatible clients start -->
85
+ ## Known compatible clients / servers
86
+
87
+ GPTQ models are currently supported on Linux (NVidia/AMD) and Windows (NVidia only). macOS users: please use GGUF models.
88
+
89
+ These GPTQ models are known to work in the following inference servers/webuis.
90
+
91
+ - [text-generation-webui](https://github.com/oobabooga/text-generation-webui)
92
+ - [KoboldAI United](https://github.com/henk717/koboldai)
93
+ - [LoLLMS Web UI](https://github.com/ParisNeo/lollms-webui)
94
+ - [Hugging Face Text Generation Inference (TGI)](https://github.com/huggingface/text-generation-inference)
95
+
96
+ This may not be a complete list; if you know of others, please let me know!
97
+ <!-- README_GPTQ.md-compatible clients end -->
98
+
99
+ <!-- README_GPTQ.md-provided-files start -->
100
+ ## Provided files, and GPTQ parameters
101
+
102
+ Multiple quantisation parameters are provided, to allow you to choose the best one for your hardware and requirements.
103
+
104
+ Each separate quant is in a different branch. See below for instructions on fetching from different branches.
105
+
106
+ Most GPTQ files are made with AutoGPTQ. Mistral models are currently made with Transformers.
107
+
108
+ <details>
109
+ <summary>Explanation of GPTQ parameters</summary>
110
+
111
+ - Bits: The bit size of the quantised model.
112
+ - GS: GPTQ group size. Higher numbers use less VRAM, but have lower quantisation accuracy. "None" is the lowest possible value.
113
+ - 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.
114
+ - Damp %: A GPTQ parameter that affects how samples are processed for quantisation. 0.01 is default, but 0.1 results in slightly better accuracy.
115
+ - 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).
116
+ - 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.
117
+ - ExLlama Compatibility: Whether this file can be loaded with ExLlama, which currently only supports Llama and Mistral models in 4-bit.
118
+
119
+ </details>
120
+
121
+ | Branch | Bits | GS | Act Order | Damp % | GPTQ Dataset | Seq Len | Size | ExLlama | Desc |
122
+ | ------ | ---- | -- | --------- | ------ | ------------ | ------- | ---- | ------- | ---- |
123
+ | [main](https://huggingface.co/TheBloke/docsgpt-7B-mistral-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. |
124
+ | [gptq-4bit-32g-actorder_True](https://huggingface.co/TheBloke/docsgpt-7B-mistral-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. |
125
+ | [gptq-8bit--1g-actorder_True](https://huggingface.co/TheBloke/docsgpt-7B-mistral-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. |
126
+ | [gptq-8bit-128g-actorder_True](https://huggingface.co/TheBloke/docsgpt-7B-mistral-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. |
127
+ | [gptq-8bit-32g-actorder_True](https://huggingface.co/TheBloke/docsgpt-7B-mistral-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. |
128
+ | [gptq-4bit-64g-actorder_True](https://huggingface.co/TheBloke/docsgpt-7B-mistral-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.29 GB | Yes | 4-bit, with Act Order and group size 64g. Uses less VRAM than 32g, but with slightly lower accuracy. |
129
+
130
+ <!-- README_GPTQ.md-provided-files end -->
131
+
132
+ <!-- README_GPTQ.md-download-from-branches start -->
133
+ ## How to download, including from branches
134
+
135
+ ### In text-generation-webui
136
+
137
+ To download from the `main` branch, enter `TheBloke/docsgpt-7B-mistral-GPTQ` in the "Download model" box.
138
+
139
+ To download from another branch, add `:branchname` to the end of the download name, eg `TheBloke/docsgpt-7B-mistral-GPTQ:gptq-4bit-32g-actorder_True`
140
+
141
+ ### From the command line
142
+
143
+ I recommend using the `huggingface-hub` Python library:
144
+
145
+ ```shell
146
+ pip3 install huggingface-hub
147
+ ```
148
+
149
+ To download the `main` branch to a folder called `docsgpt-7B-mistral-GPTQ`:
150
+
151
+ ```shell
152
+ mkdir docsgpt-7B-mistral-GPTQ
153
+ huggingface-cli download TheBloke/docsgpt-7B-mistral-GPTQ --local-dir docsgpt-7B-mistral-GPTQ --local-dir-use-symlinks False
154
+ ```
155
+
156
+ To download from a different branch, add the `--revision` parameter:
157
+
158
+ ```shell
159
+ mkdir docsgpt-7B-mistral-GPTQ
160
+ huggingface-cli download TheBloke/docsgpt-7B-mistral-GPTQ --revision gptq-4bit-32g-actorder_True --local-dir docsgpt-7B-mistral-GPTQ --local-dir-use-symlinks False
161
+ ```
162
+
163
+ <details>
164
+ <summary>More advanced huggingface-cli download usage</summary>
165
+
166
+ 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.
167
+
168
+ The cache location can be changed with the `HF_HOME` environment variable, and/or the `--cache-dir` parameter to `huggingface-cli`.
169
+
170
+ 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).
171
+
172
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
173
+
174
+ ```shell
175
+ pip3 install hf_transfer
176
+ ```
177
+
178
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
179
+
180
+ ```shell
181
+ mkdir docsgpt-7B-mistral-GPTQ
182
+ HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/docsgpt-7B-mistral-GPTQ --local-dir docsgpt-7B-mistral-GPTQ --local-dir-use-symlinks False
183
+ ```
184
+
185
+ Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
186
+ </details>
187
+
188
+ ### With `git` (**not** recommended)
189
+
190
+ To clone a specific branch with `git`, use a command like this:
191
+
192
+ ```shell
193
+ git clone --single-branch --branch gptq-4bit-32g-actorder_True https://huggingface.co/TheBloke/docsgpt-7B-mistral-GPTQ
194
+ ```
195
+
196
+ 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.)
197
+
198
+ <!-- README_GPTQ.md-download-from-branches end -->
199
+ <!-- README_GPTQ.md-text-generation-webui start -->
200
+ ## How to easily download and use this model in [text-generation-webui](https://github.com/oobabooga/text-generation-webui)
201
+
202
+ Please make sure you're using the latest version of [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
203
+
204
+ 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.
205
+
206
+ 1. Click the **Model tab**.
207
+ 2. Under **Download custom model or LoRA**, enter `TheBloke/docsgpt-7B-mistral-GPTQ`.
208
+
209
+ - To download from a specific branch, enter for example `TheBloke/docsgpt-7B-mistral-GPTQ:gptq-4bit-32g-actorder_True`
210
+ - see Provided Files above for the list of branches for each option.
211
+
212
+ 3. Click **Download**.
213
+ 4. The model will start downloading. Once it's finished it will say "Done".
214
+ 5. In the top left, click the refresh icon next to **Model**.
215
+ 6. In the **Model** dropdown, choose the model you just downloaded: `docsgpt-7B-mistral-GPTQ`
216
+ 7. The model will automatically load, and is now ready for use!
217
+ 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.
218
+
219
+ - 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`.
220
+
221
+ 9. Once you're ready, click the **Text Generation** tab and enter a prompt to get started!
222
+
223
+ <!-- README_GPTQ.md-text-generation-webui end -->
224
+
225
+ <!-- README_GPTQ.md-use-from-tgi start -->
226
+ ## Serving this model from Text Generation Inference (TGI)
227
+
228
+ 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`
229
+
230
+ Example Docker parameters:
231
+
232
+ ```shell
233
+ --model-id TheBloke/docsgpt-7B-mistral-GPTQ --port 3000 --quantize gptq --max-input-length 3696 --max-total-tokens 4096 --max-batch-prefill-tokens 4096
234
+ ```
235
+
236
+ Example Python code for interfacing with TGI (requires huggingface-hub 0.17.0 or later):
237
+
238
+ ```shell
239
+ pip3 install huggingface-hub
240
+ ```
241
+
242
+ ```python
243
+ from huggingface_hub import InferenceClient
244
+
245
+ endpoint_url = "https://your-endpoint-url-here"
246
+
247
+ prompt = "Tell me about AI"
248
+ prompt_template=f'''### Instruction
249
+ {prompt}
250
+ ### Context
251
+ {{context}}
252
+ ### Answer
253
+ '''
254
+
255
+ client = InferenceClient(endpoint_url)
256
+ response = client.text_generation(
257
+ prompt_template,
258
+ max_new_tokens=128,
259
+ do_sample=True,
260
+ temperature=0.7,
261
+ top_p=0.95,
262
+ top_k=40,
263
+ repetition_penalty=1.1
264
+ )
265
+
266
+ print(f"Model output: {response}")
267
+ ```
268
+ <!-- README_GPTQ.md-use-from-tgi end -->
269
+ <!-- README_GPTQ.md-use-from-python start -->
270
+ ## Python code example: inference from this GPTQ model
271
+
272
+ ### Install the necessary packages
273
+
274
+ Requires: Transformers 4.33.0 or later, Optimum 1.12.0 or later, and AutoGPTQ 0.4.2 or later.
275
+
276
+ ```shell
277
+ pip3 install --upgrade transformers optimum
278
+ # If using PyTorch 2.1 + CUDA 12.x:
279
+ pip3 install --upgrade auto-gptq
280
+ # or, if using PyTorch 2.1 + CUDA 11.x:
281
+ pip3 install --upgrade auto-gptq --extra-index-url https://huggingface.github.io/autogptq-index/whl/cu118/
282
+ ```
283
+
284
+ 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:
285
+
286
+ ```shell
287
+ pip3 uninstall -y auto-gptq
288
+ git clone https://github.com/PanQiWei/AutoGPTQ
289
+ cd AutoGPTQ
290
+ git checkout v0.5.1
291
+ pip3 install .
292
+ ```
293
+
294
+ ### Example Python code
295
+
296
+ ```python
297
+ from transformers import AutoModelForCausalLM, AutoTokenizer, pipeline
298
+
299
+ model_name_or_path = "TheBloke/docsgpt-7B-mistral-GPTQ"
300
+ # To use a different branch, change revision
301
+ # For example: revision="gptq-4bit-32g-actorder_True"
302
+ model = AutoModelForCausalLM.from_pretrained(model_name_or_path,
303
+ device_map="auto",
304
+ trust_remote_code=False,
305
+ revision="main")
306
+
307
+ tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, use_fast=True)
308
+
309
+ prompt = "Write a story about llamas"
310
+ system_message = "You are a story writing assistant"
311
+ prompt_template=f'''### Instruction
312
+ {prompt}
313
+ ### Context
314
+ {{context}}
315
+ ### Answer
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: Arc53's DocsGPT 7B Mistral
388
+
389
+
390
+
391
+ DocsGPT is optimized for Documentation (RAG optimised): Specifically fine-tuned for providing answers that are based on context, making it particularly useful for developers and technical support teams.
392
+ We used the Lora fine tuning process.
393
+ This model is fine tuned on top of zephyr-7b-beta
394
+
395
+
396
+ It's an apache-2.0 license so you can use it for commercial purposes too.
397
+
398
+
399
+ Benchmarks:
400
+
401
+ Bacon:
402
+ The BACON test is an internal assessment designed to evaluate the capabilities of neural networks in handling questions with substantial content. It focuses on testing the model's understanding of context-driven queries, as well as its tendency for hallucination and attention span. The questions in both parts are carefully crafted, drawing from diverse sources such as scientific papers, complex code problems, and instructional prompts, providing a comprehensive test of the model's ability to process and generate information in various domains.
403
+ | Model | Score |
404
+ |------------------------------|-------|
405
+ | gpt-4 | 8.74 |
406
+ | DocsGPT-7b-Mistral | 8.64 |
407
+ | gpt-3.5-turbo | 8.42 |
408
+ | zephyr-7b-beta | 8.37 |
409
+ | neural-chat-7b-v3-1 | 7.88 |
410
+ | Mistral-7B-Instruct-v0.1 | 7.44 |
411
+ | openinstruct-mistral-7b | 5.86 |
412
+ | llama-2-13b | 2.29 |
413
+
414
+
415
+ ![image/png](https://cdn-uploads.huggingface.co/production/uploads/6220f5dfd0351748e114ca53/lWefx5b5uQAt4Uzf_0x-O.png)
416
+
417
+
418
+ ![image/png](https://cdn-uploads.huggingface.co/production/uploads/6220f5dfd0351748e114ca53/nAd4icZa2jIer-_JWOpZ0.png)
419
+
420
+
421
+
422
+
423
+ MTbench with llm judge:
424
+
425
+ ![image/png](https://cdn-uploads.huggingface.co/production/uploads/6220f5dfd0351748e114ca53/SOOVW_j908gpB8W804vsG.png)
426
+
427
+ ########## First turn ##########
428
+ | Model | Turn | Score |
429
+ |-----------------------|------|----------|
430
+ | gpt-4 | 1 | 8.956250 |
431
+ | gpt-3.5-turbo | 1 | 8.075000 |
432
+ | DocsGPT-7b-Mistral | 1 | 7.593750 |
433
+ | zephyr-7b-beta | 1 | 7.412500 |
434
+ | vicuna-13b-v1.3 | 1 | 6.812500 |
435
+ | alpaca-13b | 1 | 4.975000 |
436
+ | deepseek-coder-6.7b | 1 | 4.506329 |
437
+
438
+ ########## Second turn ##########
439
+ | Model | Turn | Score |
440
+ |-----------------------|------|----------|
441
+ | gpt-4 | 2 | 9.025000 |
442
+ | gpt-3.5-turbo | 2 | 7.812500 |
443
+ | DocsGPT-7b-Mistral | 2 | 6.740000 |
444
+ | zephyr-7b-beta | 2 | 6.650000 |
445
+ | vicuna-13b-v1.3 | 2 | 5.962500 |
446
+ | deepseek-coder-6.7b | 2 | 5.025641 |
447
+ | alpaca-13b | 2 | 4.087500 |
448
+
449
+ ########## Average ##########
450
+ | Model | Score |
451
+ |-----------------------|----------|
452
+ | gpt-4 | 8.990625 |
453
+ | gpt-3.5-turbo | 7.943750 |
454
+ | DocsGPT-7b-Mistral | 7.166875 |
455
+ | zephyr-7b-beta | 7.031250 |
456
+ | vicuna-13b-v1.3 | 6.387500 |
457
+ | deepseek-coder-6.7b | 4.764331 |
458
+ | alpaca-13b | 4.531250 |
459
+
460
+
461
+
462
+
463
+ To prepare your prompts make sure you keep this format:
464
+
465
+ ```
466
+ ### Instruction
467
+ (where the question goes)
468
+ ### Context
469
+ (your document retrieval + system instructions)
470
+ ### Answer
471
+ ```