TheBloke commited on
Commit
43c646a
1 Parent(s): 2bda69c

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +560 -0
README.md ADDED
@@ -0,0 +1,560 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: PocketDoc/Dans-AdventurousWinds-Mk2-7b
3
+ datasets:
4
+ - PocketDoc/Floyd-Text-Adventures
5
+ - PocketDoc/Choose-Your-Story-Long-Text-Adventures
6
+ inference: false
7
+ language:
8
+ - en
9
+ license: apache-2.0
10
+ model_creator: PocketDoc Labs
11
+ model_name: Dans AdventurousWinds Mk2 7B
12
+ model_type: mistral
13
+ prompt_template: '[Genres: Science Fiction]
14
+
15
+ [Tags: humor, old school, sci fi]
16
+
17
+ [Mode: Adventure]
18
+
19
+ [Description: A puzzle about committing acts of financial skulduggery and exploiting
20
+ ridiculous magical items.]
21
+
22
+ [Misc: Writing era: 1993]
23
+
24
+ [Intro]
25
+
26
+ It is the year 2045. You are a young man in his twenties living in New York City.
27
+ Your father was an inventor who died when you were very small; your mother raised
28
+ you alone for many years until she remarried. Now you live with your stepfather,
29
+ but he doesn''t care much for you and has never given you any money to help support
30
+ yourself. You have no job and little hope of getting one because of your lack of
31
+ experience. However, you do have some unusual abilities that could be put to good
32
+ use if only you knew how...
33
+
34
+
35
+ > {prompt}
36
+
37
+ '
38
+ quantized_by: TheBloke
39
+ ---
40
+ <!-- markdownlint-disable MD041 -->
41
+
42
+ <!-- header start -->
43
+ <!-- 200823 -->
44
+ <div style="width: auto; margin-left: auto; margin-right: auto">
45
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
46
+ </div>
47
+ <div style="display: flex; justify-content: space-between; width: 100%;">
48
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
49
+ <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
50
+ </div>
51
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
52
+ <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>
53
+ </div>
54
+ </div>
55
+ <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>
56
+ <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
57
+ <!-- header end -->
58
+
59
+ # Dans AdventurousWinds Mk2 7B - GPTQ
60
+ - Model creator: [PocketDoc Labs](https://huggingface.co/PocketDoc)
61
+ - Original model: [Dans AdventurousWinds Mk2 7B](https://huggingface.co/PocketDoc/Dans-AdventurousWinds-Mk2-7b)
62
+
63
+ <!-- description start -->
64
+ ## Description
65
+
66
+ This repo contains GPTQ model files for [PocketDoc Labs's Dans AdventurousWinds Mk2 7B](https://huggingface.co/PocketDoc/Dans-AdventurousWinds-Mk2-7b).
67
+
68
+ 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.
69
+
70
+ <!-- description end -->
71
+ <!-- repositories-available start -->
72
+ ## Repositories available
73
+
74
+ * [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/Dans-AdventurousWinds-Mk2-7B-AWQ)
75
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/Dans-AdventurousWinds-Mk2-7B-GPTQ)
76
+ * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/Dans-AdventurousWinds-Mk2-7B-GGUF)
77
+ * [PocketDoc Labs's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/PocketDoc/Dans-AdventurousWinds-Mk2-7b)
78
+ <!-- repositories-available end -->
79
+
80
+ <!-- prompt-template start -->
81
+ ## Prompt template: Adventure
82
+
83
+ ```
84
+ [Genres: Science Fiction]
85
+ [Tags: humor, old school, sci fi]
86
+ [Mode: Adventure]
87
+ [Description: A puzzle about committing acts of financial skulduggery and exploiting ridiculous magical items.]
88
+ [Misc: Writing era: 1993]
89
+ [Intro]
90
+ It is the year 2045. You are a young man in his twenties living in New York City. Your father was an inventor who died when you were very small; your mother raised you alone for many years until she remarried. Now you live with your stepfather, but he doesn't care much for you and has never given you any money to help support yourself. You have no job and little hope of getting one because of your lack of experience. However, you do have some unusual abilities that could be put to good use if only you knew how...
91
+
92
+ > {prompt}
93
+
94
+ ```
95
+
96
+ <!-- prompt-template end -->
97
+
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 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/Dans-AdventurousWinds-Mk2-7B-GPTQ/tree/main) | 4 | 128 | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 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/Dans-AdventurousWinds-Mk2-7B-GPTQ/tree/gptq-4bit-32g-actorder_True) | 4 | 32 | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 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/Dans-AdventurousWinds-Mk2-7B-GPTQ/tree/gptq-8bit--1g-actorder_True) | 8 | None | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 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/Dans-AdventurousWinds-Mk2-7B-GPTQ/tree/gptq-8bit-128g-actorder_True) | 8 | 128 | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 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/Dans-AdventurousWinds-Mk2-7B-GPTQ/tree/gptq-8bit-32g-actorder_True) | 8 | 32 | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 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/Dans-AdventurousWinds-Mk2-7B-GPTQ/tree/gptq-4bit-64g-actorder_True) | 4 | 64 | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 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/Dans-AdventurousWinds-Mk2-7B-GPTQ` in the "Download model" box.
138
+
139
+ To download from another branch, add `:branchname` to the end of the download name, eg `TheBloke/Dans-AdventurousWinds-Mk2-7B-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 `Dans-AdventurousWinds-Mk2-7B-GPTQ`:
150
+
151
+ ```shell
152
+ mkdir Dans-AdventurousWinds-Mk2-7B-GPTQ
153
+ huggingface-cli download TheBloke/Dans-AdventurousWinds-Mk2-7B-GPTQ --local-dir Dans-AdventurousWinds-Mk2-7B-GPTQ --local-dir-use-symlinks False
154
+ ```
155
+
156
+ To download from a different branch, add the `--revision` parameter:
157
+
158
+ ```shell
159
+ mkdir Dans-AdventurousWinds-Mk2-7B-GPTQ
160
+ huggingface-cli download TheBloke/Dans-AdventurousWinds-Mk2-7B-GPTQ --revision gptq-4bit-32g-actorder_True --local-dir Dans-AdventurousWinds-Mk2-7B-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 Huggingface 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 Dans-AdventurousWinds-Mk2-7B-GPTQ
182
+ HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/Dans-AdventurousWinds-Mk2-7B-GPTQ --local-dir Dans-AdventurousWinds-Mk2-7B-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/Dans-AdventurousWinds-Mk2-7B-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/Dans-AdventurousWinds-Mk2-7B-GPTQ`.
208
+
209
+ - To download from a specific branch, enter for example `TheBloke/Dans-AdventurousWinds-Mk2-7B-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: `Dans-AdventurousWinds-Mk2-7B-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/Dans-AdventurousWinds-Mk2-7B-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'''[Genres: Science Fiction]
249
+ [Tags: humor, old school, sci fi]
250
+ [Mode: Adventure]
251
+ [Description: A puzzle about committing acts of financial skulduggery and exploiting ridiculous magical items.]
252
+ [Misc: Writing era: 1993]
253
+ [Intro]
254
+ It is the year 2045. You are a young man in his twenties living in New York City. Your father was an inventor who died when you were very small; your mother raised you alone for many years until she remarried. Now you live with your stepfather, but he doesn't care much for you and has never given you any money to help support yourself. You have no job and little hope of getting one because of your lack of experience. However, you do have some unusual abilities that could be put to good use if only you knew how...
255
+
256
+ > {prompt}
257
+ '''
258
+
259
+ client = InferenceClient(endpoint_url)
260
+ response = client.text_generation(prompt,
261
+ max_new_tokens=128,
262
+ do_sample=True,
263
+ temperature=0.7,
264
+ top_p=0.95,
265
+ top_k=40,
266
+ repetition_penalty=1.1)
267
+
268
+ print(f"Model output: {response}")
269
+ ```
270
+ <!-- README_GPTQ.md-use-from-tgi end -->
271
+ <!-- README_GPTQ.md-use-from-python start -->
272
+ ## How to use this GPTQ model from Python code
273
+
274
+ ### Install the necessary packages
275
+
276
+ Requires: Transformers 4.33.0 or later, Optimum 1.12.0 or later, and AutoGPTQ 0.4.2 or later.
277
+
278
+ ```shell
279
+ pip3 install transformers optimum
280
+ pip3 install auto-gptq --extra-index-url https://huggingface.github.io/autogptq-index/whl/cu118/ # Use cu117 if on CUDA 11.7
281
+ ```
282
+
283
+ If you have problems installing AutoGPTQ using the pre-built wheels, install it from source instead:
284
+
285
+ ```shell
286
+ pip3 uninstall -y auto-gptq
287
+ git clone https://github.com/PanQiWei/AutoGPTQ
288
+ cd AutoGPTQ
289
+ git checkout v0.4.2
290
+ pip3 install .
291
+ ```
292
+
293
+ ### You can then use the following code
294
+
295
+ ```python
296
+ from transformers import AutoModelForCausalLM, AutoTokenizer, pipeline
297
+
298
+ model_name_or_path = "TheBloke/Dans-AdventurousWinds-Mk2-7B-GPTQ"
299
+ # To use a different branch, change revision
300
+ # For example: revision="gptq-4bit-32g-actorder_True"
301
+ model = AutoModelForCausalLM.from_pretrained(model_name_or_path,
302
+ device_map="auto",
303
+ trust_remote_code=False,
304
+ revision="main")
305
+
306
+ tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, use_fast=True)
307
+
308
+ prompt = "Tell me about AI"
309
+ prompt_template=f'''[Genres: Science Fiction]
310
+ [Tags: humor, old school, sci fi]
311
+ [Mode: Adventure]
312
+ [Description: A puzzle about committing acts of financial skulduggery and exploiting ridiculous magical items.]
313
+ [Misc: Writing era: 1993]
314
+ [Intro]
315
+ It is the year 2045. You are a young man in his twenties living in New York City. Your father was an inventor who died when you were very small; your mother raised you alone for many years until she remarried. Now you live with your stepfather, but he doesn't care much for you and has never given you any money to help support yourself. You have no job and little hope of getting one because of your lack of experience. However, you do have some unusual abilities that could be put to good use if only you knew how...
316
+
317
+ > {prompt}
318
+ '''
319
+
320
+ print("\n\n*** Generate:")
321
+
322
+ input_ids = tokenizer(prompt_template, return_tensors='pt').input_ids.cuda()
323
+ output = model.generate(inputs=input_ids, temperature=0.7, do_sample=True, top_p=0.95, top_k=40, max_new_tokens=512)
324
+ print(tokenizer.decode(output[0]))
325
+
326
+ # Inference can also be done using transformers' pipeline
327
+
328
+ print("*** Pipeline:")
329
+ pipe = pipeline(
330
+ "text-generation",
331
+ model=model,
332
+ tokenizer=tokenizer,
333
+ max_new_tokens=512,
334
+ do_sample=True,
335
+ temperature=0.7,
336
+ top_p=0.95,
337
+ top_k=40,
338
+ repetition_penalty=1.1
339
+ )
340
+
341
+ print(pipe(prompt_template)[0]['generated_text'])
342
+ ```
343
+ <!-- README_GPTQ.md-use-from-python end -->
344
+
345
+ <!-- README_GPTQ.md-compatibility start -->
346
+ ## Compatibility
347
+
348
+ The files provided are tested to work with AutoGPTQ, both via Transformers and using AutoGPTQ directly. They should also work with [Occ4m's GPTQ-for-LLaMa fork](https://github.com/0cc4m/KoboldAI).
349
+
350
+ [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.
351
+
352
+ [Huggingface Text Generation Inference (TGI)](https://github.com/huggingface/text-generation-inference) is compatible with all GPTQ models.
353
+ <!-- README_GPTQ.md-compatibility end -->
354
+
355
+ <!-- footer start -->
356
+ <!-- 200823 -->
357
+ ## Discord
358
+
359
+ For further support, and discussions on these models and AI in general, join us at:
360
+
361
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
362
+
363
+ ## Thanks, and how to contribute
364
+
365
+ Thanks to the [chirper.ai](https://chirper.ai) team!
366
+
367
+ Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
368
+
369
+ 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.
370
+
371
+ 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.
372
+
373
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
374
+
375
+ * Patreon: https://patreon.com/TheBlokeAI
376
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
377
+
378
+ **Special thanks to**: Aemon Algiz.
379
+
380
+ **Patreon special mentions**: Pierre Kircher, Stanislav Ovsiannikov, Michael Levine, Eugene Pentland, Andrey, 준교 김, Randy H, Fred von Graf, Artur Olbinski, Caitlyn Gatomon, terasurfer, Jeff Scroggin, James Bentley, Vadim, Gabriel Puliatti, Harry Royden McLaughlin, Sean Connelly, Dan Guido, Edmond Seymore, Alicia Loh, subjectnull, AzureBlack, Manuel Alberto Morcote, Thomas Belote, Lone Striker, Chris Smitley, Vitor Caleffi, Johann-Peter Hartmann, Clay Pascal, biorpg, Brandon Frisco, sidney chen, transmissions 11, Pedro Madruga, jinyuan sun, Ajan Kanaga, Emad Mostaque, Trenton Dambrowitz, Jonathan Leane, Iucharbius, usrbinkat, vamX, George Stoitzev, Luke Pendergrass, theTransient, Olakabola, Swaroop Kallakuri, Cap'n Zoog, Brandon Phillips, Michael Dempsey, Nikolai Manek, danny, Matthew Berman, Gabriel Tamborski, alfie_i, Raymond Fosdick, Tom X Nguyen, Raven Klaugh, LangChain4j, Magnesian, Illia Dulskyi, David Ziegler, Mano Prime, Luis Javier Navarrete Lozano, Erik Bjäreholt, 阿明, Nathan Dryer, Alex, Rainer Wilmers, zynix, TL, Joseph William Delisle, John Villwock, Nathan LeClaire, Willem Michiel, Joguhyik, GodLy, OG, Alps Aficionado, Jeffrey Morgan, ReadyPlayerEmma, Tiffany J. Kim, Sebastain Graf, Spencer Kim, Michael Davis, webtim, Talal Aujan, knownsqashed, John Detwiler, Imad Khwaja, Deo Leter, Jerry Meng, Elijah Stavena, Rooh Singh, Pieter, SuperWojo, Alexandros Triantafyllidis, Stephen Murray, Ai Maven, ya boyyy, Enrico Ros, Ken Nordquist, Deep Realms, Nicholas, Spiking Neurons AB, Elle, Will Dee, Jack West, RoA, Luke @flexchar, Viktor Bowallius, Derek Yates, Subspace Studios, jjj, Toran Billups, Asp the Wyvern, Fen Risland, Ilya, NimbleBox.ai, Chadd, Nitin Borwankar, Emre, Mandus, Leonard Tan, Kalila, K, Trailburnt, S_X, Cory Kujawski
381
+
382
+
383
+ Thank you to all my generous patrons and donaters!
384
+
385
+ And thank you again to a16z for their generous grant.
386
+
387
+ <!-- footer end -->
388
+
389
+ # Original model card: PocketDoc Labs's Dans AdventurousWinds Mk2 7B
390
+
391
+
392
+ **16k training sequences**
393
+
394
+ # What is the model for?
395
+
396
+ This model is proficient in crafting text-based adventure games. It can both concise replies and more expansive, novel-like descriptions. The ability to alternate between these two response styles can be triggered by a distinct system message.
397
+
398
+ # What's in the sausage?
399
+
400
+ This model was trained on [Mistral-7b](https://huggingface.co/mistralai/Mistral-7B-v0.1) using a custom version of the floyd and cys datasets from the skein text adventure dataset. The dataset has been improved over what was used in my previous model Dans-AdventurousWinds, in addition it had been trained on 16k sequence lengths.
401
+
402
+ ## Prompt format and examples:
403
+ #### Format description:
404
+
405
+ Traditional adventure format with a description of the genre, tags, and other misc information at the top followed by an optional introductory message. User messages are prefixed with two new lines and "> ", model messages are one new line after the last user message or the description message if an introductory message is desired.
406
+
407
+ #### Examples of shorter responses:
408
+
409
+
410
+ > [Genres: Science Fiction]
411
+ > [Tags: humor, old school, sci fi]
412
+ > [Mode: Adventure]
413
+ > [Description: A puzzle about committing acts of financial skulduggery and exploiting ridiculous magical items.]
414
+ > [Misc: Writing era: 1993]
415
+ > [Intro]
416
+ > You are an interstellar trader.
417
+ >
418
+ > On your way to the galactic capital of Coruscant to sell a large quantity of fettucini, you make a detour through a planetary system with a reputation for being dangerous and unstable. The reason is simple -- there is a very powerful magical item known as "The Sword Of Damocles" up for sale. You have no idea what it does, but you've heard that the previous owners all ended up dead or broke. In other words, these people were so desperate to get rid of the sword that they would probably be willing to take almost any price. It sounds like a great deal!
419
+ >
420
+ > Of course, you don't have enough money to buy the sword outright, which means that you will need to find some way to finance the purchase. There is only one possible source of funds in this part of space -- the loan sharks who operate out of a nearby planet called Riggerton. But these loans come at a high interest rate; if you can't pay them back quickly, you may end up losing everything.
421
+ >
422
+ > You also know that there are several potential buyers vying for ownership of the sword, including some of the most ruthless criminals in the galaxy. These people might be willing to kill each other over this object, making it more valuable than ever before! However, they are notoriously paranoid and suspicious, so you must proceed with extreme caution when dealing with them...
423
+ >
424
+ > Finally, there is always the chance that someone else will beat you to the punch by buying the sword first. If that happens then you won't be able to afford it anymore anyway, so maybe it doesn't matter too much?
425
+ >
426
+ > In any case, good luck! And remember: never borrow money from anyone unless you absolutely trust him completely. Otherwise he could turn around and sell YOU into slavery instead!
427
+ >
428
+ > Ready? Then let's begin...
429
+ >
430
+ > \> You snap out of your daydream and remember you're still in port.
431
+ > You should probably get ready to go somewhere now...
432
+ >
433
+ > There are three main places where traders usually hang out: the docking bay (where ships land), the casino (a place where people gamble) and the black market (an illegal bazaar). Each has its own advantages and disadvantages depending on what kind of goods you want to trade. For example, the docking bay is the safest option because it's run by the government, but it charges higher taxes; while the black market is riskier but cheaper.
434
+ >
435
+ > So where do you think you ought to go?
436
+ >
437
+ > \> You get ready for launch
438
+ > Okay, I guess we better start looking for something interesting then...
439
+ >
440
+ > Before we leave though, I just wanted to mention that there are two ways to travel between planets: hyperspace jumps and wormholes. Both methods require special technology that only exists inside starships, but they work differently.
441
+ >
442
+ > A hyperspace jump involves using a hyperdrive engine to accelerate faster than light speed until you reach another galaxy entirely. Once there, you slow down again and return home. This method takes longer than a wormhole, but it allows you to visit distant worlds without having to worry about getting lost along the way.
443
+ >
444
+ > Wormholes however, allow you to travel instantly across vast distances without needing to slow down at either end. Unfortunately, this type of transportation isn't available everywhere, plus it requires extremely powerful computers to map out their locations accurately. Still, if you happen to find yourself near one of these things then I strongly recommend taking advantage of it since it saves time.
445
+ >
446
+ > Anyway, let me know whenever you're ready to go. We'll see how far away our next stop lies...
447
+ >
448
+ > \> You check the database on wormhole technology
449
+ > Okay, here goes nothing...
450
+ >
451
+ > According to my research, there are currently three types of wormholes known to science: stable, unstable and artificial. Stable ones occur naturally throughout the universe and tend to stay open permanently. Unstable ones close after passing through once, whereas artificially created ones remain open indefinitely.
452
+ >
453
+ > As far as I know, none of these types are suitable for commercial use yet. However, scientists believe that further development will eventually lead to practical applications in areas such as teleportation and faster-than-light travel. Until then though, I doubt whether anything useful can be achieved simply by reading books about the subject.
454
+ >
455
+ > Sorry if I disappointed you there, but I hope this information proves useful nonetheless. Good luck with whatever comes next!
456
+ >
457
+ > P.S.: Before leaving, please ensure that all loose objects have been put away properly. Otherwise they could fall off the ship during flight and cause damage later on. Thanks!
458
+
459
+
460
+ #### Examples of longer novel like responses:
461
+
462
+
463
+ > [Genres: grimdark fantasy] [Tags: Fantasy, Grimdark, Serious, Villain Protagonist, War] [Description: This story is definitely more "story" than "game", however there are two distinct paths that can be followed, each with their own pitfalls and additional choices. This story can get long, and assuming you're surviving, years do pass in it and you and your environment will change.] [First message intro] [Mode: Interactive Storyteller]
464
+ > You have been a mercenary for many years now. You are an accomplished warrior and battlefield commander. Your company consists of about 50 men and women. Most are veteran soldiers from different countries, some even from as far away as the Americas. They are all loyal to you. The only thing keeping them from being devoted followers would be your atheism.
465
+ >
466
+ > The war has raged on for many years now. The enemy, the Kingdom of Erenland, is a nation of fanatics who worship a single god called Galdrin. Their religion spread across the land like wildfire after their king ascended to the throne. He declared himself a prophet and made his people believe they were invincible. They started invading neighboring nations to bring them into the fold. The king of your homeland, King Dagor, was one of the first to resist this. When he refused to allow missionaries into his country, the Erenlanders invaded anyway. It took several years before King Dagor managed to gather enough forces to repel the invasion. The war lasted for decades and finally ended when Dagor's grandson ascended to the throne. At that point, both sides realized how much blood had already been spilled and agreed to a truce.
467
+ >
468
+ > Unfortunately, the peace didn't last very long. A few years ago, King Dagor II died without any children. His cousin became the new monarch but she was weak and incompetent. She allowed her advisors to make most of the important decisions while she spent her time partying with nobles from other nations. One of these advisors convinced the queen to send troops to help quell rebellions that were taking place in the Erenlander cities. These rebellions were caused by dissatisfaction with the way the crown was handling things. They wanted to overthrow their ruler and install a new one that would listen to them.
469
+ >
470
+ > When word reached the court that the rebels had succeeded in killing the king, everyone panicked. The Queen ordered her army to march north immediately. Unfortunately, she hadn't thought through what would happen if the enemy army attacked during this period of chaos. The result was disastrous. The Erenlanders caught our army completely off guard and annihilated us almost entirely. Only a handful survived to tell the tale. Among those survivors was you.
471
+ >
472
+ > You have come back home to bury your fallen comrades. You know you won't find rest until you avenge their deaths. But where do you begin? How do you stop an entire nation from going to war against yours? And how do you convince others to join you when they see you as nothing more than a madman bent on destruction?
473
+ >
474
+ > These questions haunt you every night. You lie awake staring at the ceiling wondering how you could possibly make things right again. Then you remember something...
475
+ >
476
+ > There was once a great hero named Galadar who lived hundreds of years ago. He fought against tyranny and oppression throughout his lifetime. People said that he possessed magical powers which gave him strength beyond anything mortal. Some even claimed that he walked among the stars. After retiring from active duty, Galadar vanished mysteriously. No one knows where he went or why. Rumors say that he returned to fight alongside the gods against evil forces threatening to destroy existence itself. Whatever happened to him, no one knows for sure. All we do know is that his legacy lives on today through those who follow his example. Perhaps you too can become such a person. Perhaps you can use your talents to save the world from darkness just like he did so long ago. If you feel ready, then take up arms and prepare yourself for battle!
477
+ >
478
+ > Your journey begins here...
479
+ >
480
+ > You wake up feeling refreshed after a good night's sleep. You look around your bedroom and notice that everything seems normal. There isn't anyone else around except for your wife, who lies sleeping next to you. You turn towards her and smile softly. She stirs slightly and mumbles something incoherent. You stroke her hair gently and whisper sweet nothings into her ear. Soon she falls back asleep and you decide to leave her alone.
481
+ >
482
+ > As soon as you step outside your house, you hear voices coming from behind you. Turning quickly, you spot three young boys running down the street toward you. They stop suddenly and stare at you wide eyed. "Are you the man who killed the giants?" one asks nervously.
483
+ >
484
+ > You nod slowly. "Yes," you reply.
485
+ >
486
+ > "Then I guess we should thank you." Another boy adds.
487
+ >
488
+ > "Yeah," says the third one. "We heard that giants ate babies."
489
+ >
490
+ > You shake your head sadly. "No," you explain. "Giants don't eat babies. That's just a myth."
491
+ >
492
+ > "Oh really?" the first boy says skeptically. "Well then why did my parents move away from their village?"
493
+ >
494
+ > "I dunno," you shrug. "Maybe because they believed the same thing you did."
495
+ >
496
+ > The three kids look surprised. Then they laugh heartily together. "Haha!" they giggle. "That's funny!"
497
+ >
498
+ > You grin back at them. "Thanks."
499
+ >
500
+ > They run off laughing hysterically. You chuckle quietly to yourself. Kids are always full of surprises.
501
+ >
502
+ > After spending some quality time with your family, you return home early in the afternoon. You grab a cup of tea and sit down at the kitchen table to read the newspaper. As usual, most of the stories involve wars somewhere else in the world. There aren't any articles related to your own conflict yet though. Maybe tomorrow...
503
+ >
504
+ > Suddenly, you hear loud knocking on the front door. You stand up abruptly and rush over to answer it. Standing before you is an old man wearing a long beard and holding a staff in his hand. He looks familiar somehow.
505
+ >
506
+ > "Hello sir," he greets politely. "My name is Galanis. I am here representing the Academy of Magic Studies."
507
+ >
508
+ > "Ah yes," you respond. "I remember seeing advertisements for your school everywhere recently. What can I do for you?"
509
+ >
510
+ > "Well sir," he begins, "we have received reports that you possess certain abilities which fall under our area of expertise. Specifically, we understand that you are capable of controlling fire using mental telepathy. Is this true?"
511
+ >
512
+ > You nod slowly. "It certainly is."
513
+ >
514
+ > "Excellent," he smiles happily. "In light of these circumstances, I would like to offer you a position teaching at our academy. We require instructors skilled in various aspects of magic including conjuration, enchantment, necromancy, divination, alchemy, and astrology."
515
+ >
516
+ > You shake your head firmly. "I appreciate the offer Mr. Galanis but I must decline. My duties lie elsewhere right now."
517
+ >
518
+ > His face falls momentarily. "Very well then," he sighs dejectedly. "Perhaps another opportunity will arise later on."
519
+ >
520
+ > With that said, he turns around and leaves without saying another word. You watch him depart silently wondering whether you should have accepted his proposal. On the one hand, it might provide some distraction from the war. On the other hand, you doubt you could ever fit into such a structured environment. Besides, you wouldn't want to spend years away from home either. In the end, you decide to stay put and continue doing what you've always done best - fighting for justice.
521
+ >
522
+ > \> You go to the great library
523
+ > You enter the Great Library of Alexandria hoping to gain knowledge about the Erenlander religion. Unfortunately, you find out that nobody there knows anything about it. The closest thing resembling a book on the subject is a small pamphlet titled "A Brief Overview Of Religion". According to its author, the writer claims that religions differ mainly due to differences between societies. Each society creates its own beliefs based upon its unique experiences. Since no two cultures are alike, there cannot be any universal truth regarding divine matters. Therefore, there is no reason to expect one religion to be superior over another.
524
+ >
525
+ > You think deeply about this concept. Does it apply to the Erenlander faith? Are their beliefs simply an expression of local customs rather than absolute truths? Or does their doctrine truly reflect reality? These thoughts weigh heavily upon your mind. Suddenly, you hear someone calling your name. Turning around, you spot a librarian approaching you.
526
+ >
527
+ > "Mr. Thane," he says cheerfully. "Can I help you find something specific?"
528
+ >
529
+ > "Actually yes," you reply. "Do you happen to know anything about the Erenlander religion?"
530
+ >
531
+ > He scratches his chin thoughtfully. "Not really," he admits. "But let me show you something anyway." He leads you over to a large table covered with books. Picking one up randomly, he starts reading aloud from it.
532
+ >
533
+ > "According to ancient legends, Galdrin created the universe out of nothingness. Before that, nothing existed except pure chaos. Out of this void came forth life and light. With these gifts, Galdrin blessed humanity with wisdom and understanding. Through hard work and determination, humankind learned how to cultivate crops, build shelters, manufacture weapons, develop technology, establish governments, maintain order, and defend itself against enemies. By following the teachings of Galdrin, humans were able to rise above mere animals and achieve greatness beyond compare. Those who rejected his teachings fell victim to ignorance and decay. Eventually, their civilization collapsed leaving only ruins behind. Today, descendants of those original settlers still live amongst us. Although their culture has changed considerably since antiquity, they retain many traditions common among modern-day peoples. Their language remains virtually unchanged despite centuries of contact with foreign languages. Their art forms range widely ranging from poetry to sculpture to music. Their religion continues to flourish despite attempts to suppress it throughout history. And most importantly, their belief system continues to guide them along the path of righteousness."
534
+ >
535
+ > You listen intently as he speaks. His words seem familiar somehow. Has he told you this story before? Or perhaps it was passed down through generations within your family? Either way, you find yourself drawn into the narrative. Before long, you forget everything else happening around you. Everything fades away except for the sound of his voice echoing throughout your ears.
536
+ >
537
+ > "So why did Galdrin create the world?" the librarian finishes. "Because he loved us," he answers softly. "And because he knew we needed somewhere safe to call home."
538
+ >
539
+ > You nod slowly. "Thank you," you murmur. "That was quite interesting."
540
+ >
541
+ > "Glad to hear it," he grins broadly. "If you ever need anything else, please feel free to ask."
542
+ >
543
+ > You bid farewell to the librarian and walk back home. During the journey, you ponder over what you learned earlier. Did Galdrin actually exist? Was he real or imaginary? Could he possibly be connected to the Erenlander faith somehow? So many questions remain unanswered. Still, you sense that something significant occurred tonight. Something special transpired inside the library walls. Now, you must figure out exactly what happened.
544
+
545
+
546
+ # Some quick and dirty training details:
547
+
548
+ - [<img src="https://raw.githubusercontent.com/OpenAccess-AI-Collective/axolotl/main/image/axolotl-badge-web.png" alt="Built with Axolotl" width="150" height="24"/>](https://github.com/OpenAccess-AI-Collective/axolotl)
549
+ - Sequence length: 16384
550
+ - \# of epochs: 3
551
+ - Training time: 5 hours
552
+ - Hardware: 4x RTX 4090
553
+ - Training type: QLoRA
554
+ - PEFT R/A: 32/32
555
+
556
+
557
+ # Credits:
558
+ ### Skein Text Adventure Data:
559
+
560
+ Thank you to the [Kobold AI](https://huggingface.co/KoboldAI) community for curating the Skein dataset, which is pivotal to this model's capabilities.