TheBloke commited on
Commit
15aed6e
1 Parent(s): e2a2efc

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +465 -0
README.md ADDED
@@ -0,0 +1,465 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: FPHam/Writing_Partner_Mistral_7B
3
+ inference: false
4
+ language:
5
+ - en
6
+ license: apache-2.0
7
+ model_creator: FPHam
8
+ model_name: Writing Partner Mistral 7B
9
+ model_type: mistral
10
+ prompt_template: '<|im_start|>system
11
+
12
+ {system_message}<|im_end|>
13
+
14
+ <|im_start|>user
15
+
16
+ {prompt}<|im_end|>
17
+
18
+ <|im_start|>assistant
19
+
20
+ '
21
+ quantized_by: TheBloke
22
+ tags:
23
+ - mistral
24
+ - instruct
25
+ - finetune
26
+ - chatml
27
+ - gpt4
28
+ ---
29
+ <!-- markdownlint-disable MD041 -->
30
+
31
+ <!-- header start -->
32
+ <!-- 200823 -->
33
+ <div style="width: auto; margin-left: auto; margin-right: auto">
34
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
35
+ </div>
36
+ <div style="display: flex; justify-content: space-between; width: 100%;">
37
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
38
+ <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
39
+ </div>
40
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
41
+ <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>
42
+ </div>
43
+ </div>
44
+ <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>
45
+ <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
46
+ <!-- header end -->
47
+
48
+ # Writing Partner Mistral 7B - GPTQ
49
+ - Model creator: [FPHam](https://huggingface.co/FPHam)
50
+ - Original model: [Writing Partner Mistral 7B](https://huggingface.co/FPHam/Writing_Partner_Mistral_7B)
51
+
52
+ <!-- description start -->
53
+ # Description
54
+
55
+ This repo contains GPTQ model files for [FPHam's Writing Partner Mistral 7B](https://huggingface.co/FPHam/Writing_Partner_Mistral_7B).
56
+
57
+ 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.
58
+
59
+ These files were quantised using hardware kindly provided by [Massed Compute](https://massedcompute.com/).
60
+
61
+ <!-- description end -->
62
+ <!-- repositories-available start -->
63
+ ## Repositories available
64
+
65
+ * [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/Writing_Partner_Mistral_7B-AWQ)
66
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/Writing_Partner_Mistral_7B-GPTQ)
67
+ * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/Writing_Partner_Mistral_7B-GGUF)
68
+ * [FPHam's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/FPHam/Writing_Partner_Mistral_7B)
69
+ <!-- repositories-available end -->
70
+
71
+ <!-- prompt-template start -->
72
+ ## Prompt template: ChatML
73
+
74
+ ```
75
+ <|im_start|>system
76
+ {system_message}<|im_end|>
77
+ <|im_start|>user
78
+ {prompt}<|im_end|>
79
+ <|im_start|>assistant
80
+
81
+ ```
82
+
83
+ <!-- prompt-template end -->
84
+
85
+
86
+
87
+ <!-- README_GPTQ.md-compatible clients start -->
88
+ ## Known compatible clients / servers
89
+
90
+ These GPTQ models are known to work in the following inference servers/webuis.
91
+
92
+ - [text-generation-webui](https://github.com/oobabooga/text-generation-webui)
93
+ - [KoboldAI United](https://github.com/henk717/koboldai)
94
+ - [LoLLMS Web UI](https://github.com/ParisNeo/lollms-webui)
95
+ - [Hugging Face Text Generation Inference (TGI)](https://github.com/huggingface/text-generation-inference)
96
+
97
+ This may not be a complete list; if you know of others, please let me know!
98
+ <!-- README_GPTQ.md-compatible clients end -->
99
+
100
+ <!-- README_GPTQ.md-provided-files start -->
101
+ ## Provided files, and GPTQ parameters
102
+
103
+ Multiple quantisation parameters are provided, to allow you to choose the best one for your hardware and requirements.
104
+
105
+ Each separate quant is in a different branch. See below for instructions on fetching from different branches.
106
+
107
+ Most GPTQ files are made with AutoGPTQ. Mistral models are currently made with Transformers.
108
+
109
+ <details>
110
+ <summary>Explanation of GPTQ parameters</summary>
111
+
112
+ - Bits: The bit size of the quantised model.
113
+ - GS: GPTQ group size. Higher numbers use less VRAM, but have lower quantisation accuracy. "None" is the lowest possible value.
114
+ - 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.
115
+ - Damp %: A GPTQ parameter that affects how samples are processed for quantisation. 0.01 is default, but 0.1 results in slightly better accuracy.
116
+ - 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).
117
+ - 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.
118
+ - ExLlama Compatibility: Whether this file can be loaded with ExLlama, which currently only supports Llama and Mistral models in 4-bit.
119
+
120
+ </details>
121
+
122
+ | Branch | Bits | GS | Act Order | Damp % | GPTQ Dataset | Seq Len | Size | ExLlama | Desc |
123
+ | ------ | ---- | -- | --------- | ------ | ------------ | ------- | ---- | ------- | ---- |
124
+ | [main](https://huggingface.co/TheBloke/Writing_Partner_Mistral_7B-GPTQ/tree/main) | 4 | 128 | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-raw-v1) | 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. |
125
+ | [gptq-4bit-32g-actorder_True](https://huggingface.co/TheBloke/Writing_Partner_Mistral_7B-GPTQ/tree/gptq-4bit-32g-actorder_True) | 4 | 32 | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-raw-v1) | 4096 | 4.57 GB | Yes | 4-bit, with Act Order and group size 32g. Gives highest possible inference quality, with maximum VRAM usage. |
126
+ | [gptq-8bit--1g-actorder_True](https://huggingface.co/TheBloke/Writing_Partner_Mistral_7B-GPTQ/tree/gptq-8bit--1g-actorder_True) | 8 | None | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-raw-v1) | 4096 | 7.52 GB | No | 8-bit, with Act Order. No group size, to lower VRAM requirements. |
127
+ | [gptq-8bit-128g-actorder_True](https://huggingface.co/TheBloke/Writing_Partner_Mistral_7B-GPTQ/tree/gptq-8bit-128g-actorder_True) | 8 | 128 | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-raw-v1) | 4096 | 7.68 GB | No | 8-bit, with group size 128g for higher inference quality and with Act Order for even higher accuracy. |
128
+ | [gptq-8bit-32g-actorder_True](https://huggingface.co/TheBloke/Writing_Partner_Mistral_7B-GPTQ/tree/gptq-8bit-32g-actorder_True) | 8 | 32 | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-raw-v1) | 4096 | 8.17 GB | No | 8-bit, with group size 32g and Act Order for maximum inference quality. |
129
+ | [gptq-4bit-64g-actorder_True](https://huggingface.co/TheBloke/Writing_Partner_Mistral_7B-GPTQ/tree/gptq-4bit-64g-actorder_True) | 4 | 64 | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-raw-v1) | 4096 | 4.30 GB | Yes | 4-bit, with Act Order and group size 64g. Uses less VRAM than 32g, but with slightly lower accuracy. |
130
+
131
+ <!-- README_GPTQ.md-provided-files end -->
132
+
133
+ <!-- README_GPTQ.md-download-from-branches start -->
134
+ ## How to download, including from branches
135
+
136
+ ### In text-generation-webui
137
+
138
+ To download from the `main` branch, enter `TheBloke/Writing_Partner_Mistral_7B-GPTQ` in the "Download model" box.
139
+
140
+ To download from another branch, add `:branchname` to the end of the download name, eg `TheBloke/Writing_Partner_Mistral_7B-GPTQ:gptq-4bit-32g-actorder_True`
141
+
142
+ ### From the command line
143
+
144
+ I recommend using the `huggingface-hub` Python library:
145
+
146
+ ```shell
147
+ pip3 install huggingface-hub
148
+ ```
149
+
150
+ To download the `main` branch to a folder called `Writing_Partner_Mistral_7B-GPTQ`:
151
+
152
+ ```shell
153
+ mkdir Writing_Partner_Mistral_7B-GPTQ
154
+ huggingface-cli download TheBloke/Writing_Partner_Mistral_7B-GPTQ --local-dir Writing_Partner_Mistral_7B-GPTQ --local-dir-use-symlinks False
155
+ ```
156
+
157
+ To download from a different branch, add the `--revision` parameter:
158
+
159
+ ```shell
160
+ mkdir Writing_Partner_Mistral_7B-GPTQ
161
+ huggingface-cli download TheBloke/Writing_Partner_Mistral_7B-GPTQ --revision gptq-4bit-32g-actorder_True --local-dir Writing_Partner_Mistral_7B-GPTQ --local-dir-use-symlinks False
162
+ ```
163
+
164
+ <details>
165
+ <summary>More advanced huggingface-cli download usage</summary>
166
+
167
+ 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.
168
+
169
+ The cache location can be changed with the `HF_HOME` environment variable, and/or the `--cache-dir` parameter to `huggingface-cli`.
170
+
171
+ 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).
172
+
173
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
174
+
175
+ ```shell
176
+ pip3 install hf_transfer
177
+ ```
178
+
179
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
180
+
181
+ ```shell
182
+ mkdir Writing_Partner_Mistral_7B-GPTQ
183
+ HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/Writing_Partner_Mistral_7B-GPTQ --local-dir Writing_Partner_Mistral_7B-GPTQ --local-dir-use-symlinks False
184
+ ```
185
+
186
+ Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
187
+ </details>
188
+
189
+ ### With `git` (**not** recommended)
190
+
191
+ To clone a specific branch with `git`, use a command like this:
192
+
193
+ ```shell
194
+ git clone --single-branch --branch gptq-4bit-32g-actorder_True https://huggingface.co/TheBloke/Writing_Partner_Mistral_7B-GPTQ
195
+ ```
196
+
197
+ 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.)
198
+
199
+ <!-- README_GPTQ.md-download-from-branches end -->
200
+ <!-- README_GPTQ.md-text-generation-webui start -->
201
+ ## How to easily download and use this model in [text-generation-webui](https://github.com/oobabooga/text-generation-webui)
202
+
203
+ Please make sure you're using the latest version of [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
204
+
205
+ 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.
206
+
207
+ 1. Click the **Model tab**.
208
+ 2. Under **Download custom model or LoRA**, enter `TheBloke/Writing_Partner_Mistral_7B-GPTQ`.
209
+
210
+ - To download from a specific branch, enter for example `TheBloke/Writing_Partner_Mistral_7B-GPTQ:gptq-4bit-32g-actorder_True`
211
+ - see Provided Files above for the list of branches for each option.
212
+
213
+ 3. Click **Download**.
214
+ 4. The model will start downloading. Once it's finished it will say "Done".
215
+ 5. In the top left, click the refresh icon next to **Model**.
216
+ 6. In the **Model** dropdown, choose the model you just downloaded: `Writing_Partner_Mistral_7B-GPTQ`
217
+ 7. The model will automatically load, and is now ready for use!
218
+ 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.
219
+
220
+ - 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`.
221
+
222
+ 9. Once you're ready, click the **Text Generation** tab and enter a prompt to get started!
223
+
224
+ <!-- README_GPTQ.md-text-generation-webui end -->
225
+
226
+ <!-- README_GPTQ.md-use-from-tgi start -->
227
+ ## Serving this model from Text Generation Inference (TGI)
228
+
229
+ 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`
230
+
231
+ Example Docker parameters:
232
+
233
+ ```shell
234
+ --model-id TheBloke/Writing_Partner_Mistral_7B-GPTQ --port 3000 --quantize gptq --max-input-length 3696 --max-total-tokens 4096 --max-batch-prefill-tokens 4096
235
+ ```
236
+
237
+ Example Python code for interfacing with TGI (requires huggingface-hub 0.17.0 or later):
238
+
239
+ ```shell
240
+ pip3 install huggingface-hub
241
+ ```
242
+
243
+ ```python
244
+ from huggingface_hub import InferenceClient
245
+
246
+ endpoint_url = "https://your-endpoint-url-here"
247
+
248
+ prompt = "Tell me about AI"
249
+ prompt_template=f'''<|im_start|>system
250
+ {system_message}<|im_end|>
251
+ <|im_start|>user
252
+ {prompt}<|im_end|>
253
+ <|im_start|>assistant
254
+ '''
255
+
256
+ client = InferenceClient(endpoint_url)
257
+ response = client.text_generation(prompt,
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
+ print(f"Model output: {response}")
266
+ ```
267
+ <!-- README_GPTQ.md-use-from-tgi end -->
268
+ <!-- README_GPTQ.md-use-from-python start -->
269
+ ## Python code example: inference from this GPTQ model
270
+
271
+ ### Install the necessary packages
272
+
273
+ Requires: Transformers 4.33.0 or later, Optimum 1.12.0 or later, and AutoGPTQ 0.4.2 or later.
274
+
275
+ ```shell
276
+ pip3 install --upgrade transformers optimum
277
+ # If using PyTorch 2.1 + CUDA 12.x:
278
+ pip3 install --upgrade auto-gptq
279
+ # or, if using PyTorch 2.1 + CUDA 11.x:
280
+ pip3 install --upgrade auto-gptq --extra-index-url https://huggingface.github.io/autogptq-index/whl/cu118/
281
+ ```
282
+
283
+ 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:
284
+
285
+ ```shell
286
+ pip3 uninstall -y auto-gptq
287
+ git clone https://github.com/PanQiWei/AutoGPTQ
288
+ cd AutoGPTQ
289
+ git checkout v0.5.1
290
+ pip3 install .
291
+ ```
292
+
293
+ ### Example Python code
294
+
295
+ ```python
296
+ from transformers import AutoModelForCausalLM, AutoTokenizer, pipeline
297
+
298
+ model_name_or_path = "TheBloke/Writing_Partner_Mistral_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'''<|im_start|>system
310
+ {system_message}<|im_end|>
311
+ <|im_start|>user
312
+ {prompt}<|im_end|>
313
+ <|im_start|>assistant
314
+ '''
315
+
316
+ print("\n\n*** Generate:")
317
+
318
+ input_ids = tokenizer(prompt_template, return_tensors='pt').input_ids.cuda()
319
+ output = model.generate(inputs=input_ids, temperature=0.7, do_sample=True, top_p=0.95, top_k=40, max_new_tokens=512)
320
+ print(tokenizer.decode(output[0]))
321
+
322
+ # Inference can also be done using transformers' pipeline
323
+
324
+ print("*** Pipeline:")
325
+ pipe = pipeline(
326
+ "text-generation",
327
+ model=model,
328
+ tokenizer=tokenizer,
329
+ max_new_tokens=512,
330
+ do_sample=True,
331
+ temperature=0.7,
332
+ top_p=0.95,
333
+ top_k=40,
334
+ repetition_penalty=1.1
335
+ )
336
+
337
+ print(pipe(prompt_template)[0]['generated_text'])
338
+ ```
339
+ <!-- README_GPTQ.md-use-from-python end -->
340
+
341
+ <!-- README_GPTQ.md-compatibility start -->
342
+ ## Compatibility
343
+
344
+ The files provided are tested to work with Transformers. For non-Mistral models, AutoGPTQ can also be used directly.
345
+
346
+ [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.
347
+
348
+ For a list of clients/servers, please see "Known compatible clients / servers", above.
349
+ <!-- README_GPTQ.md-compatibility end -->
350
+
351
+ <!-- footer start -->
352
+ <!-- 200823 -->
353
+ ## Discord
354
+
355
+ For further support, and discussions on these models and AI in general, join us at:
356
+
357
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
358
+
359
+ ## Thanks, and how to contribute
360
+
361
+ Thanks to the [chirper.ai](https://chirper.ai) team!
362
+
363
+ Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
364
+
365
+ 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.
366
+
367
+ 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.
368
+
369
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
370
+
371
+ * Patreon: https://patreon.com/TheBlokeAI
372
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
373
+
374
+ **Special thanks to**: Aemon Algiz.
375
+
376
+ **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
377
+
378
+
379
+ Thank you to all my generous patrons and donaters!
380
+
381
+ And thank you again to a16z for their generous grant.
382
+
383
+ <!-- footer end -->
384
+
385
+ # Original model card: FPHam's Writing Partner Mistral 7B
386
+
387
+
388
+ <!-- header start -->
389
+ <div style="display: flex; flex-direction: column; align-items: center;">
390
+ </div>
391
+ <div style="width: 100%;">
392
+ <img src="https://huggingface.co/FPHam/Writing_Partner_Mistral_7B/resolve/main/writer5.jpg" alt="Writing Partner" style="width: 70%; min-width: 200px; display: block; margin: auto;">
393
+ </div>
394
+ <div style="display: flex; flex-direction: column; align-items: center;">
395
+ <p><a href="https://ko-fi.com/Q5Q5MOB4M">Support me at Ko-fi</a></p>
396
+ </div>
397
+ <!-- header end -->
398
+
399
+
400
+ Hi there! I'm your writing assistant.
401
+
402
+ Think of me as your partner in crime---or rather, your partner in writing. When you hit a wall (and trust me, you will), I'll be there to knock it down for you.
403
+
404
+ If you find yourself stumped, I can help you think outside the box, whether you need to figure out what happens next, develop interesting sidekicks, or create a believable love interest. And if you get stuck on names for people or places, well, that's my specialty.
405
+
406
+ Just give me a shout if you have questions, need advice, or want to bounce an idea off someone. Together, we'll turn your novel into a best seller!
407
+
408
+ # Intended Use
409
+
410
+ The purpose of this model isn't to write content for you (although it can), but rather to engage in a conversation about your writing process.
411
+
412
+ # Model uses ChatML
413
+
414
+ ```
415
+ <|im_start|>system
416
+ <|im_end|>
417
+ <|im_start|>user
418
+ How to plot my story?<|im_end|>
419
+ <|im_start|>assistant
420
+ ```
421
+
422
+ Example 1: (I had ChatGPT generate a paragraph for a sci-fi story.)
423
+
424
+ Here is an opening of my story:
425
+
426
+ In the distant reaches of the cosmos, where starlight weaves a tapestry of unknown wonders, Captain Alara Voss navigated her spacecraft, the Celestial Serenity, through the interstellar currents. The ship hummed with the pulsating energy of the quantum drive, propelling them toward the uncharted nebula known as the Veil of Eternity. Alara's gaze was fixed on the swirling cosmic clouds ahead, her mind ablaze with the anticipation of discovery. As the Serenity pierced the ethereal veil, the fabric of reality seemed to dance with a mysterious resonance. Little did the intrepid crew know that beyond the shimmering curtain lay a realm where time itself wove a narrative that defied mortal understanding, setting the stage for an odyssey that would reshape the boundaries of human perception.
427
+
428
+ >I like this opening! It sets up some interesting questions and intrigue right off the bat. But I do think you might want to reconsider your point of view in the first paragraph. Right now it sounds more like a summary than an actual scene because there isn't any dialogue or action. Consider starting with something more immediate, perhaps from Alara's perspective. You could even begin with her looking out at the stars, thinking about what she sees. This will give us a chance to get to know her better before you launch into the big picture stuff. Here's an example:
429
+ >
430
+ >Alara Voss leaned against the cold metal railing of the observation deck, staring out into the infinite expanse of blackness that surrounded her ship. Stars dotted the night sky like scattered diamonds, each one a potential destination, each one a mystery waiting to be solved. She took a deep breath and let it out slowly, savoring the feeling of freedom that washed over her. It had been months since they'd left Earth, and already their journey had taken them light-years away from everything they knew. Her thoughts were interrupted by the low hum of the quantum drive kicking in, signaling that they were ready to make another jump. She watched as the stars began to blur together, forming a shimmering pathway that led the way to their next adventure.
431
+ >
432
+ >"Captain," came the voice of her second-in-command over the intercom. "We're entering the Veil of Eternity."
433
+ >
434
+ >"Thank you, Ensign," Alara replied, not taking her eyes off the swirling vortex ahead. "Let's see what lies beyond."
435
+
436
+
437
+ Example 2:
438
+
439
+ How to write proper dialogue?
440
+
441
+ >Dialogue is a very important part of writing fiction. It's the way characters speak, and it helps define who they are. It also moves the story forward and adds tension, humor, or emotion. Dialogue must be realistic and natural-sounding, but it doesn't have to be boring. You want your readers to pay attention to what the characters are saying, so make sure that each line of dialogue counts.
442
+ >
443
+ >Here are some tips on how to write good dialogue:
444
+ >
445
+ >- Keep it short. Long speeches get tedious quickly. If one character talks for more than two sentences, break up his speech with an action or interjection from another character.
446
+ >
447
+ >- Use contractions (I'm, he'll). They sound more like real conversation than formal language does.
448
+ >
449
+ >- Vary sentence structure. This makes dialogue easier to read and understand.
450
+ >
451
+ >- Don't use slang unless it fits the setting or character perfectly. Slang dates easily and may not mean anything to future generations.
452
+ >
453
+ >- Avoid using too many adverbs in dialogue tags. Instead of "he said loudly," try something like "he bellowed." Or "she whispered."
454
+ >
455
+ >- Be careful not to give away too much information in dialogue tags. For example, if you say "Sarah laughed nervously," you're telling the reader she was nervous rather than showing her anxiety through her words or actions.
456
+ >
457
+ >- Make sure your characters don't all talk alike. Each person should have a unique voice, based on his background, education, age, gender, etc.
458
+ >
459
+ >- Don't forget about body language. The way someone holds himself, sits, stands, fidgets, or looks at others can add depth to a scene.
460
+ >
461
+ >- Use dialogue to reveal character traits and motivations. Listen carefully to people around you, and then translate those conversations onto paper.
462
+ >
463
+ >- Finally, remember that dialogue needs to serve a purpose in your story. Whether it advances the plot, sets the mood, or creates conflict, every word spoken by your characters should move the narrative along.
464
+
465
+