TheBloke commited on
Commit
d5efbfe
1 Parent(s): aa743f1

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: MerlynMind/merlyn-education-corpus-qa-v2
3
+ inference: false
4
+ license: apache-2.0
5
+ model_creator: Merlyn Mind
6
+ model_name: Merlyn Education Corpus QA v2
7
+ model_type: llama
8
+ prompt_template: 'Instruction:\t{system_message}
9
+
10
+ Conversation:
11
+
12
+ ''user1'':\tuser message to analyse
13
+
14
+ ''user2'':\tuser message to analyse
15
+
16
+ Response:
17
+
18
+ '
19
+ quantized_by: TheBloke
20
+ tags:
21
+ - MerlynMind
22
+ - education
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
+ # Merlyn Education Corpus QA v2 - GPTQ
44
+ - Model creator: [Merlyn Mind](https://huggingface.co/MerlynMind)
45
+ - Original model: [Merlyn Education Corpus QA v2](https://huggingface.co/MerlynMind/merlyn-education-corpus-qa-v2)
46
+
47
+ <!-- description start -->
48
+ # Description
49
+
50
+ This repo contains GPTQ model files for [Merlyn Mind's Merlyn Education Corpus QA v2](https://huggingface.co/MerlynMind/merlyn-education-corpus-qa-v2).
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/merlyn-education-corpus-qa-v2-AWQ)
61
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/merlyn-education-corpus-qa-v2-GPTQ)
62
+ * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/merlyn-education-corpus-qa-v2-GGUF)
63
+ * [Merlyn Mind's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/MerlynMind/merlyn-education-corpus-qa-v2)
64
+ <!-- repositories-available end -->
65
+
66
+ <!-- prompt-template start -->
67
+ ## Prompt template: Merlyn-Education
68
+
69
+ ```
70
+ Instruction:\t{system_message}
71
+ Conversation:
72
+ 'user1':\tuser message to analyse
73
+ 'user2':\tuser message to analyse
74
+ Response:
75
+
76
+ ```
77
+
78
+ <!-- prompt-template end -->
79
+ <!-- licensing start -->
80
+ ## Licensing
81
+
82
+ The creator of the source model has listed its license as `apache-2.0`, and this quantization has therefore used that same license.
83
+
84
+ As this model is based on Llama 2, it is also subject to the Meta Llama 2 license terms, and the license files for that are additionally included. It should therefore be considered as being claimed to be licensed under both licenses. I contacted Hugging Face for clarification on dual licensing but they do not yet have an official position. Should this change, or should Meta provide any feedback on this situation, I will update this section accordingly.
85
+
86
+ In the meantime, any questions regarding licensing, and in particular how these two licenses might interact, should be directed to the original model repository: [Merlyn Mind's Merlyn Education Corpus QA v2](https://huggingface.co/MerlynMind/merlyn-education-corpus-qa-v2).
87
+ <!-- licensing end -->
88
+
89
+ <!-- README_GPTQ.md-compatible clients start -->
90
+ ## Known compatible clients / servers
91
+
92
+ These GPTQ models are known to work in the following inference servers/webuis.
93
+
94
+ - [text-generation-webui](https://github.com/oobabooga/text-generation-webui)
95
+ - [KoboldAI United](https://github.com/henk717/koboldai)
96
+ - [LoLLMS Web UI](https://github.com/ParisNeo/lollms-webui)
97
+ - [Hugging Face Text Generation Inference (TGI)](https://github.com/huggingface/text-generation-inference)
98
+
99
+ This may not be a complete list; if you know of others, please let me know!
100
+ <!-- README_GPTQ.md-compatible clients end -->
101
+
102
+ <!-- README_GPTQ.md-provided-files start -->
103
+ ## Provided files, and GPTQ parameters
104
+
105
+ Multiple quantisation parameters are provided, to allow you to choose the best one for your hardware and requirements.
106
+
107
+ Each separate quant is in a different branch. See below for instructions on fetching from different branches.
108
+
109
+ Most GPTQ files are made with AutoGPTQ. Mistral models are currently made with Transformers.
110
+
111
+ <details>
112
+ <summary>Explanation of GPTQ parameters</summary>
113
+
114
+ - Bits: The bit size of the quantised model.
115
+ - GS: GPTQ group size. Higher numbers use less VRAM, but have lower quantisation accuracy. "None" is the lowest possible value.
116
+ - 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.
117
+ - Damp %: A GPTQ parameter that affects how samples are processed for quantisation. 0.01 is default, but 0.1 results in slightly better accuracy.
118
+ - 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).
119
+ - 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.
120
+ - ExLlama Compatibility: Whether this file can be loaded with ExLlama, which currently only supports Llama and Mistral models in 4-bit.
121
+
122
+ </details>
123
+
124
+ | Branch | Bits | GS | Act Order | Damp % | GPTQ Dataset | Seq Len | Size | ExLlama | Desc |
125
+ | ------ | ---- | -- | --------- | ------ | ------------ | ------- | ---- | ------- | ---- |
126
+ | [main](https://huggingface.co/TheBloke/merlyn-education-corpus-qa-v2-GPTQ/tree/main) | 4 | 128 | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-raw-v1) | 4096 | 7.26 GB | Yes | 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/merlyn-education-corpus-qa-v2-GPTQ/tree/gptq-4bit-32g-actorder_True) | 4 | 32 | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-raw-v1) | 4096 | 8.00 GB | Yes | 4-bit, with Act Order and group size 32g. Gives highest possible inference quality, with maximum VRAM usage. |
128
+ | [gptq-8bit--1g-actorder_True](https://huggingface.co/TheBloke/merlyn-education-corpus-qa-v2-GPTQ/tree/gptq-8bit--1g-actorder_True) | 8 | None | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-raw-v1) | 4096 | 13.36 GB | No | 8-bit, with Act Order. No group size, to lower VRAM requirements. |
129
+ | [gptq-8bit-128g-actorder_True](https://huggingface.co/TheBloke/merlyn-education-corpus-qa-v2-GPTQ/tree/gptq-8bit-128g-actorder_True) | 8 | 128 | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-raw-v1) | 4096 | 13.65 GB | No | 8-bit, with group size 128g for higher inference quality and with Act Order for even higher accuracy. |
130
+ | [gptq-8bit-32g-actorder_True](https://huggingface.co/TheBloke/merlyn-education-corpus-qa-v2-GPTQ/tree/gptq-8bit-32g-actorder_True) | 8 | 32 | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-raw-v1) | 4096 | 14.54 GB | No | 8-bit, with group size 32g and Act Order for maximum inference quality. |
131
+ | [gptq-4bit-64g-actorder_True](https://huggingface.co/TheBloke/merlyn-education-corpus-qa-v2-GPTQ/tree/gptq-4bit-64g-actorder_True) | 4 | 64 | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-raw-v1) | 4096 | 7.51 GB | Yes | 4-bit, with Act Order and group size 64g. Uses less VRAM than 32g, but with slightly lower accuracy. |
132
+
133
+ <!-- README_GPTQ.md-provided-files end -->
134
+
135
+ <!-- README_GPTQ.md-download-from-branches start -->
136
+ ## How to download, including from branches
137
+
138
+ ### In text-generation-webui
139
+
140
+ To download from the `main` branch, enter `TheBloke/merlyn-education-corpus-qa-v2-GPTQ` in the "Download model" box.
141
+
142
+ To download from another branch, add `:branchname` to the end of the download name, eg `TheBloke/merlyn-education-corpus-qa-v2-GPTQ:gptq-4bit-32g-actorder_True`
143
+
144
+ ### From the command line
145
+
146
+ I recommend using the `huggingface-hub` Python library:
147
+
148
+ ```shell
149
+ pip3 install huggingface-hub
150
+ ```
151
+
152
+ To download the `main` branch to a folder called `merlyn-education-corpus-qa-v2-GPTQ`:
153
+
154
+ ```shell
155
+ mkdir merlyn-education-corpus-qa-v2-GPTQ
156
+ huggingface-cli download TheBloke/merlyn-education-corpus-qa-v2-GPTQ --local-dir merlyn-education-corpus-qa-v2-GPTQ --local-dir-use-symlinks False
157
+ ```
158
+
159
+ To download from a different branch, add the `--revision` parameter:
160
+
161
+ ```shell
162
+ mkdir merlyn-education-corpus-qa-v2-GPTQ
163
+ huggingface-cli download TheBloke/merlyn-education-corpus-qa-v2-GPTQ --revision gptq-4bit-32g-actorder_True --local-dir merlyn-education-corpus-qa-v2-GPTQ --local-dir-use-symlinks False
164
+ ```
165
+
166
+ <details>
167
+ <summary>More advanced huggingface-cli download usage</summary>
168
+
169
+ 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.
170
+
171
+ The cache location can be changed with the `HF_HOME` environment variable, and/or the `--cache-dir` parameter to `huggingface-cli`.
172
+
173
+ 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).
174
+
175
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
176
+
177
+ ```shell
178
+ pip3 install hf_transfer
179
+ ```
180
+
181
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
182
+
183
+ ```shell
184
+ mkdir merlyn-education-corpus-qa-v2-GPTQ
185
+ HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/merlyn-education-corpus-qa-v2-GPTQ --local-dir merlyn-education-corpus-qa-v2-GPTQ --local-dir-use-symlinks False
186
+ ```
187
+
188
+ Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
189
+ </details>
190
+
191
+ ### With `git` (**not** recommended)
192
+
193
+ To clone a specific branch with `git`, use a command like this:
194
+
195
+ ```shell
196
+ git clone --single-branch --branch gptq-4bit-32g-actorder_True https://huggingface.co/TheBloke/merlyn-education-corpus-qa-v2-GPTQ
197
+ ```
198
+
199
+ 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.)
200
+
201
+ <!-- README_GPTQ.md-download-from-branches end -->
202
+ <!-- README_GPTQ.md-text-generation-webui start -->
203
+ ## How to easily download and use this model in [text-generation-webui](https://github.com/oobabooga/text-generation-webui)
204
+
205
+ Please make sure you're using the latest version of [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
206
+
207
+ 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.
208
+
209
+ 1. Click the **Model tab**.
210
+ 2. Under **Download custom model or LoRA**, enter `TheBloke/merlyn-education-corpus-qa-v2-GPTQ`.
211
+
212
+ - To download from a specific branch, enter for example `TheBloke/merlyn-education-corpus-qa-v2-GPTQ:gptq-4bit-32g-actorder_True`
213
+ - see Provided Files above for the list of branches for each option.
214
+
215
+ 3. Click **Download**.
216
+ 4. The model will start downloading. Once it's finished it will say "Done".
217
+ 5. In the top left, click the refresh icon next to **Model**.
218
+ 6. In the **Model** dropdown, choose the model you just downloaded: `merlyn-education-corpus-qa-v2-GPTQ`
219
+ 7. The model will automatically load, and is now ready for use!
220
+ 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.
221
+
222
+ - 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`.
223
+
224
+ 9. Once you're ready, click the **Text Generation** tab and enter a prompt to get started!
225
+
226
+ <!-- README_GPTQ.md-text-generation-webui end -->
227
+
228
+ <!-- README_GPTQ.md-use-from-tgi start -->
229
+ ## Serving this model from Text Generation Inference (TGI)
230
+
231
+ 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`
232
+
233
+ Example Docker parameters:
234
+
235
+ ```shell
236
+ --model-id TheBloke/merlyn-education-corpus-qa-v2-GPTQ --port 3000 --quantize gptq --max-input-length 3696 --max-total-tokens 4096 --max-batch-prefill-tokens 4096
237
+ ```
238
+
239
+ Example Python code for interfacing with TGI (requires huggingface-hub 0.17.0 or later):
240
+
241
+ ```shell
242
+ pip3 install huggingface-hub
243
+ ```
244
+
245
+ ```python
246
+ from huggingface_hub import InferenceClient
247
+
248
+ endpoint_url = "https://your-endpoint-url-here"
249
+
250
+ prompt = "Tell me about AI"
251
+ prompt_template=f'''Instruction:\t{system_message}
252
+ Conversation:
253
+ 'user1':\tuser message to analyse
254
+ 'user2':\tuser message to analyse
255
+ Response:
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/merlyn-education-corpus-qa-v2-GPTQ"
301
+ # To use a different branch, change revision
302
+ # For example: revision="gptq-4bit-32g-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 = "Tell me about AI"
311
+ prompt_template=f'''Instruction:\t{system_message}
312
+ Conversation:
313
+ 'user1':\tuser message to analyse
314
+ 'user2':\tuser message to analyse
315
+ Response:
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 and Mistral models 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**: Brandon Frisco, LangChain4j, Spiking Neurons AB, transmissions 11, Joseph William Delisle, Nitin Borwankar, Willem Michiel, Michael Dempsey, vamX, Jeffrey Morgan, zynix, jjj, Omer Bin Jawed, Sean Connelly, jinyuan sun, Jeromy Smith, Shadi, Pawan Osman, Chadd, Elijah Stavena, Illia Dulskyi, Sebastain Graf, Stephen Murray, terasurfer, Edmond Seymore, Celu Ramasamy, Mandus, Alex, biorpg, Ajan Kanaga, Clay Pascal, Raven Klaugh, 阿明, K, ya boyyy, usrbinkat, Alicia Loh, John Villwock, ReadyPlayerEmma, Chris Smitley, Cap'n Zoog, fincy, GodLy, S_X, sidney chen, Cory Kujawski, OG, Mano Prime, AzureBlack, Pieter, Kalila, Spencer Kim, Tom X Nguyen, Stanislav Ovsiannikov, Michael Levine, Andrey, Trailburnt, Vadim, Enrico Ros, Talal Aujan, Brandon Phillips, Jack West, Eugene Pentland, Michael Davis, Will Dee, webtim, Jonathan Leane, Alps Aficionado, Rooh Singh, Tiffany J. Kim, theTransient, Luke @flexchar, Elle, Caitlyn Gatomon, Ari Malik, subjectnull, Johann-Peter Hartmann, Trenton Dambrowitz, Imad Khwaja, Asp the Wyvern, Emad Mostaque, Rainer Wilmers, Alexandros Triantafyllidis, Nicholas, Pedro Madruga, SuperWojo, Harry Royden McLaughlin, James Bentley, Olakabola, David Ziegler, Ai Maven, Jeff Scroggin, Nikolai Manek, Deo Leter, Matthew Berman, Fen Risland, Ken Nordquist, Manuel Alberto Morcote, Luke Pendergrass, TL, Fred von Graf, Randy H, Dan Guido, NimbleBox.ai, Vitor Caleffi, Gabriel Tamborski, knownsqashed, Lone Striker, Erik Bjäreholt, John Detwiler, Leonard Tan, Iucharbius
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: Merlyn Mind's Merlyn Education Corpus QA v2
388
+
389
+
390
+ # Merlyn-Education Corpus QA
391
+
392
+ merlyn-education-corpus-qa-v2 is a 13b parameter decoder-style transformer model for the education domain. It is fine-tuned from a [llama2-13b](https://huggingface.co/meta-llama/Llama-2-13b-hf) base-model.
393
+
394
+ This model was trained by [Merlyn Mind](https://www.merlyn.org/).
395
+
396
+ It is a model that provides an answer to a question based on the given context.
397
+
398
+ ## Model Date
399
+
400
+ August 21, 2023
401
+
402
+ ## Model License
403
+
404
+ Apache-2.0
405
+
406
+
407
+ ## Usage
408
+
409
+ Loading model and tokenizer:
410
+
411
+ ```python
412
+ import torch
413
+ from transformers import AutoTokenizer, AutoModelForCausalLM
414
+
415
+ model_path = "MerlynMind/merlyn-education-corpus-qa-v2"
416
+ device = torch.device("cuda:0") # change device id as necessary
417
+ model = AutoModelForCausalLM.from_pretrained(model_path)
418
+ tokenizer = AutoTokenizer.from_pretrained(model_path, fast_tokenizer=True)
419
+ model.to(device) # move to device
420
+
421
+ ```
422
+
423
+ Prompt example:
424
+
425
+ ```python
426
+ info = '''Information:\tThe Solar System is about 4.6 billion years old. The Sun formed by gravity in a large molecular cloud. It is mainly hydrogen, which it converts into helium.
427
+ Information:\tThe formation and evolution of the Solar System began 4.6 billion years ago with the gravitational collapse of a small part of a giant molecular cloud.
428
+ Information:\tAstronomers are now more or less certain that the order of the planets was not always as it is today. Knowing what we know today, we can see the Solar System is strange. All other planetary system we are able to study have their largest planet close to their star. Also we have noticed other oddities in the Solar System. Mars is smaller than it ought to be, and the asteroid belt has been disturbed.
429
+ Information:\tFor thousands of years, people had no need for a name for the "Solar System". They thought the Earth stayed still at the center of everything (geocentrism). The Greek philosopher Aristarchus of Samos suggested that there was a special order in the sky. Nicolaus Copernicus was the first to develop a mathematical system that described what we now call the "Solar System". This was called a "new system of the world". In the 17th century, Galileo Galilei, Johannes Kepler and Isaac Newton began to understand physics more clearly. People began to accept the idea that the Earth is a planet that moves around the Sun, and that the planets are worlds, and that all worlds are governed by the same same physical laws. More recently, telescopes and space probes sometimes let us see details directly. All inner planets have surface features. The gas giants (as the name suggests) have surfaces whose make-up is gradually being discovered.
430
+ Information:\tThere are eight planets in the Solar System. From closest to farthest from the Sun, they are: Mercury, Venus, Earth, Mars, Jupiter, Saturn, Uranus and Neptune. The first four planets are called terrestrial planets. They are mostly made of rock and metal, and they are mostly solid. The last four planets are called gas giants. This is because they are much larger than other planets and are mostly made of gas.
431
+ '''
432
+ qs = "Question:\tHow old is the Solar System?"
433
+
434
+ prompt = tokenizer.bos_token
435
+ prompt += '''Instruction:\tYou are to try to answer the following question using only the pieces of information given.
436
+ Instruction:\tYour response should be a well formed JSON object with an 'answerable' property followed by an 'answer' property.
437
+ Instruction:\tIf you cannot answer the question given the information, the value of the 'answerable' should be 'false' and the 'answer' should be an empty string.
438
+ Instruction:\tIf you can answer the question given the information, the value of the 'answerable' should be 'true' and your answer should be the string value of the 'answer' property.
439
+ ''' + info + qs + " Response:"
440
+
441
+ ```
442
+
443
+ We recommend using newline character for stopping criterion, as follows:
444
+
445
+ ```python
446
+ from transformers import StoppingCriteria, StoppingCriteriaList
447
+
448
+ eos_tokens = [tokenizer.eos_token,'\n']
449
+ eos_token_ids = [tokenizer.encode(token)[0] for token in eos_tokens]
450
+
451
+ class MultipleEOSTokensStoppingCriteria(StoppingCriteria):
452
+ def __init__(self, eos_token_ids):
453
+ self.eos_token_ids = set(eos_token_ids)
454
+ def __call__(self, input_ids, scores) -> bool:
455
+ if input_ids.shape[-1] <= 1:
456
+ return False
457
+ for eos_token_id in self.eos_token_ids:
458
+ if eos_token_id == input_ids[0, -1].item():
459
+ return True
460
+ return False
461
+
462
+ # Define stopping criteria
463
+ multiple_eos_tokens_processor = MultipleEOSTokensStoppingCriteria(eos_token_ids)
464
+ stopping_criteria = StoppingCriteriaList([multiple_eos_tokens_processor])
465
+ ```
466
+
467
+ Inference:
468
+
469
+ ```python
470
+ inputs = tokenizer(prompt, return_tensors="pt", return_token_type_ids=False).to(device)
471
+ generate_ids = model.generate(
472
+ **inputs,
473
+ max_new_tokens=1024,
474
+ temperature=0.0,
475
+ num_beams=2,
476
+ top_p=1,
477
+ stopping_criteria=stopping_criteria
478
+ )
479
+ response = tokenizer.decode(generate_ids[0],
480
+ skip_special_tokens=True,
481
+ clean_up_tokenization_spaces=True)
482
+ ```
483
+
484
+ Example output (after response processing):
485
+
486
+ ```json
487
+ [{"answerable": "true", "answer": "4.6 billion years"}]
488
+ ```
489
+
490
+ ## Evaluation
491
+ This model is trained on a larger dataset compared to the [pythia-based v1 model](https://huggingface.co/MerlynMind/merlyn-education-corpus-qa), yielding better correctness and reduced hallucinations on a larger and more diverse benchmarking dataset.
492
+
493
+