TheBloke commited on
Commit
61a1c73
1 Parent(s): da84ba1

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +466 -0
README.md ADDED
@@ -0,0 +1,466 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: KoboldAI/LLaMA2-13B-Psyfighter2
3
+ inference: false
4
+ license: llama2
5
+ model_creator: KoboldAI
6
+ model_name: Llama2 13B Psyfighter2
7
+ model_type: llama
8
+ prompt_template: "### Instruction: \n{prompt}\n### Response:\n"
9
+ quantized_by: TheBloke
10
+ ---
11
+ <!-- markdownlint-disable MD041 -->
12
+
13
+ <!-- header start -->
14
+ <!-- 200823 -->
15
+ <div style="width: auto; margin-left: auto; margin-right: auto">
16
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
17
+ </div>
18
+ <div style="display: flex; justify-content: space-between; width: 100%;">
19
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
20
+ <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
21
+ </div>
22
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
23
+ <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>
24
+ </div>
25
+ </div>
26
+ <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>
27
+ <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
28
+ <!-- header end -->
29
+
30
+ # Llama2 13B Psyfighter2 - GPTQ
31
+ - Model creator: [KoboldAI](https://huggingface.co/KoboldAI)
32
+ - Original model: [Llama2 13B Psyfighter2](https://huggingface.co/KoboldAI/LLaMA2-13B-Psyfighter2)
33
+
34
+ <!-- description start -->
35
+ # Description
36
+
37
+ This repo contains GPTQ model files for [KoboldAI's Llama2 13B Psyfighter2](https://huggingface.co/KoboldAI/LLaMA2-13B-Psyfighter2).
38
+
39
+ 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.
40
+
41
+ These files were quantised using hardware kindly provided by [Massed Compute](https://massedcompute.com/).
42
+
43
+ <!-- description end -->
44
+ <!-- repositories-available start -->
45
+ ## Repositories available
46
+
47
+ * [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/LLaMA2-13B-Psyfighter2-AWQ)
48
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/LLaMA2-13B-Psyfighter2-GPTQ)
49
+ * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/LLaMA2-13B-Psyfighter2-GGUF)
50
+ * [KoboldAI's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/KoboldAI/LLaMA2-13B-Psyfighter2)
51
+ <!-- repositories-available end -->
52
+
53
+ <!-- prompt-template start -->
54
+ ## Prompt template: Alpaca-Tiefighter
55
+
56
+ ```
57
+ ### Instruction:
58
+ {prompt}
59
+ ### Response:
60
+
61
+ ```
62
+
63
+ <!-- prompt-template end -->
64
+
65
+
66
+
67
+ <!-- README_GPTQ.md-compatible clients start -->
68
+ ## Known compatible clients / servers
69
+
70
+ These GPTQ models are known to work in the following inference servers/webuis.
71
+
72
+ - [text-generation-webui](https://github.com/oobabooga/text-generation-webui)
73
+ - [KoboldAI United](https://github.com/henk717/koboldai)
74
+ - [LoLLMS Web UI](https://github.com/ParisNeo/lollms-webui)
75
+ - [Hugging Face Text Generation Inference (TGI)](https://github.com/huggingface/text-generation-inference)
76
+
77
+ This may not be a complete list; if you know of others, please let me know!
78
+ <!-- README_GPTQ.md-compatible clients end -->
79
+
80
+ <!-- README_GPTQ.md-provided-files start -->
81
+ ## Provided files, and GPTQ parameters
82
+
83
+ Multiple quantisation parameters are provided, to allow you to choose the best one for your hardware and requirements.
84
+
85
+ Each separate quant is in a different branch. See below for instructions on fetching from different branches.
86
+
87
+ Most GPTQ files are made with AutoGPTQ. Mistral models are currently made with Transformers.
88
+
89
+ <details>
90
+ <summary>Explanation of GPTQ parameters</summary>
91
+
92
+ - Bits: The bit size of the quantised model.
93
+ - GS: GPTQ group size. Higher numbers use less VRAM, but have lower quantisation accuracy. "None" is the lowest possible value.
94
+ - 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.
95
+ - Damp %: A GPTQ parameter that affects how samples are processed for quantisation. 0.01 is default, but 0.1 results in slightly better accuracy.
96
+ - 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).
97
+ - 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.
98
+ - ExLlama Compatibility: Whether this file can be loaded with ExLlama, which currently only supports Llama and Mistral models in 4-bit.
99
+
100
+ </details>
101
+
102
+ | Branch | Bits | GS | Act Order | Damp % | GPTQ Dataset | Seq Len | Size | ExLlama | Desc |
103
+ | ------ | ---- | -- | --------- | ------ | ------------ | ------- | ---- | ------- | ---- |
104
+ | [main](https://huggingface.co/TheBloke/LLaMA2-13B-Psyfighter2-GPTQ/tree/main) | 4 | 128 | Yes | 0.1 | [VMware Open Instruct](https://huggingface.co/datasets/VMware/open-instruct/viewer/) | 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. |
105
+ | [gptq-4bit-32g-actorder_True](https://huggingface.co/TheBloke/LLaMA2-13B-Psyfighter2-GPTQ/tree/gptq-4bit-32g-actorder_True) | 4 | 32 | Yes | 0.1 | [VMware Open Instruct](https://huggingface.co/datasets/VMware/open-instruct/viewer/) | 4096 | 8.00 GB | Yes | 4-bit, with Act Order and group size 32g. Gives highest possible inference quality, with maximum VRAM usage. |
106
+ | [gptq-8bit--1g-actorder_True](https://huggingface.co/TheBloke/LLaMA2-13B-Psyfighter2-GPTQ/tree/gptq-8bit--1g-actorder_True) | 8 | None | Yes | 0.1 | [VMware Open Instruct](https://huggingface.co/datasets/VMware/open-instruct/viewer/) | 4096 | 13.36 GB | No | 8-bit, with Act Order. No group size, to lower VRAM requirements. |
107
+ | [gptq-8bit-128g-actorder_True](https://huggingface.co/TheBloke/LLaMA2-13B-Psyfighter2-GPTQ/tree/gptq-8bit-128g-actorder_True) | 8 | 128 | Yes | 0.1 | [VMware Open Instruct](https://huggingface.co/datasets/VMware/open-instruct/viewer/) | 4096 | 13.65 GB | No | 8-bit, with group size 128g for higher inference quality and with Act Order for even higher accuracy. |
108
+ | [gptq-8bit-32g-actorder_True](https://huggingface.co/TheBloke/LLaMA2-13B-Psyfighter2-GPTQ/tree/gptq-8bit-32g-actorder_True) | 8 | 32 | Yes | 0.1 | [VMware Open Instruct](https://huggingface.co/datasets/VMware/open-instruct/viewer/) | 4096 | 14.54 GB | No | 8-bit, with group size 32g and Act Order for maximum inference quality. |
109
+ | [gptq-4bit-64g-actorder_True](https://huggingface.co/TheBloke/LLaMA2-13B-Psyfighter2-GPTQ/tree/gptq-4bit-64g-actorder_True) | 4 | 64 | Yes | 0.1 | [VMware Open Instruct](https://huggingface.co/datasets/VMware/open-instruct/viewer/) | 4096 | 7.51 GB | Yes | 4-bit, with Act Order and group size 64g. Uses less VRAM than 32g, but with slightly lower accuracy. |
110
+
111
+ <!-- README_GPTQ.md-provided-files end -->
112
+
113
+ <!-- README_GPTQ.md-download-from-branches start -->
114
+ ## How to download, including from branches
115
+
116
+ ### In text-generation-webui
117
+
118
+ To download from the `main` branch, enter `TheBloke/LLaMA2-13B-Psyfighter2-GPTQ` in the "Download model" box.
119
+
120
+ To download from another branch, add `:branchname` to the end of the download name, eg `TheBloke/LLaMA2-13B-Psyfighter2-GPTQ:gptq-4bit-32g-actorder_True`
121
+
122
+ ### From the command line
123
+
124
+ I recommend using the `huggingface-hub` Python library:
125
+
126
+ ```shell
127
+ pip3 install huggingface-hub
128
+ ```
129
+
130
+ To download the `main` branch to a folder called `LLaMA2-13B-Psyfighter2-GPTQ`:
131
+
132
+ ```shell
133
+ mkdir LLaMA2-13B-Psyfighter2-GPTQ
134
+ huggingface-cli download TheBloke/LLaMA2-13B-Psyfighter2-GPTQ --local-dir LLaMA2-13B-Psyfighter2-GPTQ --local-dir-use-symlinks False
135
+ ```
136
+
137
+ To download from a different branch, add the `--revision` parameter:
138
+
139
+ ```shell
140
+ mkdir LLaMA2-13B-Psyfighter2-GPTQ
141
+ huggingface-cli download TheBloke/LLaMA2-13B-Psyfighter2-GPTQ --revision gptq-4bit-32g-actorder_True --local-dir LLaMA2-13B-Psyfighter2-GPTQ --local-dir-use-symlinks False
142
+ ```
143
+
144
+ <details>
145
+ <summary>More advanced huggingface-cli download usage</summary>
146
+
147
+ 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.
148
+
149
+ The cache location can be changed with the `HF_HOME` environment variable, and/or the `--cache-dir` parameter to `huggingface-cli`.
150
+
151
+ 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).
152
+
153
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
154
+
155
+ ```shell
156
+ pip3 install hf_transfer
157
+ ```
158
+
159
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
160
+
161
+ ```shell
162
+ mkdir LLaMA2-13B-Psyfighter2-GPTQ
163
+ HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/LLaMA2-13B-Psyfighter2-GPTQ --local-dir LLaMA2-13B-Psyfighter2-GPTQ --local-dir-use-symlinks False
164
+ ```
165
+
166
+ Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
167
+ </details>
168
+
169
+ ### With `git` (**not** recommended)
170
+
171
+ To clone a specific branch with `git`, use a command like this:
172
+
173
+ ```shell
174
+ git clone --single-branch --branch gptq-4bit-32g-actorder_True https://huggingface.co/TheBloke/LLaMA2-13B-Psyfighter2-GPTQ
175
+ ```
176
+
177
+ 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.)
178
+
179
+ <!-- README_GPTQ.md-download-from-branches end -->
180
+ <!-- README_GPTQ.md-text-generation-webui start -->
181
+ ## How to easily download and use this model in [text-generation-webui](https://github.com/oobabooga/text-generation-webui)
182
+
183
+ Please make sure you're using the latest version of [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
184
+
185
+ 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.
186
+
187
+ 1. Click the **Model tab**.
188
+ 2. Under **Download custom model or LoRA**, enter `TheBloke/LLaMA2-13B-Psyfighter2-GPTQ`.
189
+
190
+ - To download from a specific branch, enter for example `TheBloke/LLaMA2-13B-Psyfighter2-GPTQ:gptq-4bit-32g-actorder_True`
191
+ - see Provided Files above for the list of branches for each option.
192
+
193
+ 3. Click **Download**.
194
+ 4. The model will start downloading. Once it's finished it will say "Done".
195
+ 5. In the top left, click the refresh icon next to **Model**.
196
+ 6. In the **Model** dropdown, choose the model you just downloaded: `LLaMA2-13B-Psyfighter2-GPTQ`
197
+ 7. The model will automatically load, and is now ready for use!
198
+ 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.
199
+
200
+ - 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`.
201
+
202
+ 9. Once you're ready, click the **Text Generation** tab and enter a prompt to get started!
203
+
204
+ <!-- README_GPTQ.md-text-generation-webui end -->
205
+
206
+ <!-- README_GPTQ.md-use-from-tgi start -->
207
+ ## Serving this model from Text Generation Inference (TGI)
208
+
209
+ 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`
210
+
211
+ Example Docker parameters:
212
+
213
+ ```shell
214
+ --model-id TheBloke/LLaMA2-13B-Psyfighter2-GPTQ --port 3000 --quantize gptq --max-input-length 3696 --max-total-tokens 4096 --max-batch-prefill-tokens 4096
215
+ ```
216
+
217
+ Example Python code for interfacing with TGI (requires huggingface-hub 0.17.0 or later):
218
+
219
+ ```shell
220
+ pip3 install huggingface-hub
221
+ ```
222
+
223
+ ```python
224
+ from huggingface_hub import InferenceClient
225
+
226
+ endpoint_url = "https://your-endpoint-url-here"
227
+
228
+ prompt = "Tell me about AI"
229
+ prompt_template=f'''### Instruction:
230
+ {prompt}
231
+ ### Response:
232
+ '''
233
+
234
+ client = InferenceClient(endpoint_url)
235
+ response = client.text_generation(prompt,
236
+ max_new_tokens=128,
237
+ do_sample=True,
238
+ temperature=0.7,
239
+ top_p=0.95,
240
+ top_k=40,
241
+ repetition_penalty=1.1)
242
+
243
+ print(f"Model output: {response}")
244
+ ```
245
+ <!-- README_GPTQ.md-use-from-tgi end -->
246
+ <!-- README_GPTQ.md-use-from-python start -->
247
+ ## Python code example: inference from this GPTQ model
248
+
249
+ ### Install the necessary packages
250
+
251
+ Requires: Transformers 4.33.0 or later, Optimum 1.12.0 or later, and AutoGPTQ 0.4.2 or later.
252
+
253
+ ```shell
254
+ pip3 install --upgrade transformers optimum
255
+ # If using PyTorch 2.1 + CUDA 12.x:
256
+ pip3 install --upgrade auto-gptq
257
+ # or, if using PyTorch 2.1 + CUDA 11.x:
258
+ pip3 install --upgrade auto-gptq --extra-index-url https://huggingface.github.io/autogptq-index/whl/cu118/
259
+ ```
260
+
261
+ 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:
262
+
263
+ ```shell
264
+ pip3 uninstall -y auto-gptq
265
+ git clone https://github.com/PanQiWei/AutoGPTQ
266
+ cd AutoGPTQ
267
+ git checkout v0.5.1
268
+ pip3 install .
269
+ ```
270
+
271
+ ### Example Python code
272
+
273
+ ```python
274
+ from transformers import AutoModelForCausalLM, AutoTokenizer, pipeline
275
+
276
+ model_name_or_path = "TheBloke/LLaMA2-13B-Psyfighter2-GPTQ"
277
+ # To use a different branch, change revision
278
+ # For example: revision="gptq-4bit-32g-actorder_True"
279
+ model = AutoModelForCausalLM.from_pretrained(model_name_or_path,
280
+ device_map="auto",
281
+ trust_remote_code=False,
282
+ revision="main")
283
+
284
+ tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, use_fast=True)
285
+
286
+ prompt = "Tell me about AI"
287
+ prompt_template=f'''### Instruction:
288
+ {prompt}
289
+ ### Response:
290
+ '''
291
+
292
+ print("\n\n*** Generate:")
293
+
294
+ input_ids = tokenizer(prompt_template, return_tensors='pt').input_ids.cuda()
295
+ output = model.generate(inputs=input_ids, temperature=0.7, do_sample=True, top_p=0.95, top_k=40, max_new_tokens=512)
296
+ print(tokenizer.decode(output[0]))
297
+
298
+ # Inference can also be done using transformers' pipeline
299
+
300
+ print("*** Pipeline:")
301
+ pipe = pipeline(
302
+ "text-generation",
303
+ model=model,
304
+ tokenizer=tokenizer,
305
+ max_new_tokens=512,
306
+ do_sample=True,
307
+ temperature=0.7,
308
+ top_p=0.95,
309
+ top_k=40,
310
+ repetition_penalty=1.1
311
+ )
312
+
313
+ print(pipe(prompt_template)[0]['generated_text'])
314
+ ```
315
+ <!-- README_GPTQ.md-use-from-python end -->
316
+
317
+ <!-- README_GPTQ.md-compatibility start -->
318
+ ## Compatibility
319
+
320
+ The files provided are tested to work with Transformers. For non-Mistral models, AutoGPTQ can also be used directly.
321
+
322
+ [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.
323
+
324
+ For a list of clients/servers, please see "Known compatible clients / servers", above.
325
+ <!-- README_GPTQ.md-compatibility end -->
326
+
327
+ <!-- footer start -->
328
+ <!-- 200823 -->
329
+ ## Discord
330
+
331
+ For further support, and discussions on these models and AI in general, join us at:
332
+
333
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
334
+
335
+ ## Thanks, and how to contribute
336
+
337
+ Thanks to the [chirper.ai](https://chirper.ai) team!
338
+
339
+ Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
340
+
341
+ 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.
342
+
343
+ 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.
344
+
345
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
346
+
347
+ * Patreon: https://patreon.com/TheBlokeAI
348
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
349
+
350
+ **Special thanks to**: Aemon Algiz.
351
+
352
+ **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
353
+
354
+
355
+ Thank you to all my generous patrons and donaters!
356
+
357
+ And thank you again to a16z for their generous grant.
358
+
359
+ <!-- footer end -->
360
+
361
+ # Original model card: KoboldAI's Llama2 13B Psyfighter2
362
+
363
+
364
+ # LLAMA2-13B-Psyfighter2
365
+ Psyfighter is a merged model created by the KoboldAI community members Jeb Carter and TwistedShadows and was made possible thanks to the KoboldAI merge request service.
366
+
367
+ The intent was to add medical data to supplement the models fictional ability with more details on anatomy and mental states. Due to the low ratio's of medical data and the high ratio's of fiction this model should not be used for medical advice or therapy because of its high chance of pulling in fictional data.
368
+
369
+ The following mergekit recipe was used:
370
+
371
+ ```
372
+ merge_method: task_arithmetic
373
+ base_model: TheBloke/Llama-2-13B-fp16
374
+ models:
375
+ - model: TheBloke/Llama-2-13B-fp16
376
+ - model: KoboldAI/LLaMA2-13B-Tiefighter
377
+ parameters:
378
+ weight: 1.0
379
+ - model: Doctor-Shotgun/cat-v1.0-13b
380
+ parameters:
381
+ weight: 0.01
382
+ - model: Doctor-Shotgun/llama-2-13b-chat-limarp-v2-merged
383
+ parameters:
384
+ weight: 0.02
385
+ dtype: float16
386
+ ```
387
+
388
+ *V1 of this model was published under the account of the creator of the merge
389
+
390
+ This model contains the following ingredients from their upstream models for as far as we can track them:
391
+ - KoboldAI/LLaMA2-13B-Tiefighter
392
+ - Undi95/Xwin-MLewd-13B-V0.2
393
+ - - Undi95/ReMM-S-Light
394
+ - Undi95/CreativeEngine
395
+ - Brouz/Slerpeno
396
+ - - elinas/chronos-13b-v2
397
+ - jondurbin/airoboros-l2-13b-2.1
398
+ - NousResearch/Nous-Hermes-Llama2-13b+nRuaif/Kimiko-v2
399
+ - CalderaAI/13B-Legerdemain-L2+lemonilia/limarp-llama2-v2
400
+ - - KoboldAI/LLAMA2-13B-Holodeck-1
401
+ - NousResearch/Nous-Hermes-13b
402
+ - OpenAssistant/llama2-13b-orca-8k-3319
403
+ - ehartford/WizardLM-1.0-Uncensored-Llama2-13b
404
+ - Henk717/spring-dragon
405
+ - The-Face-Of-Goonery/Huginn-v3-13b (Contains undisclosed model versions, those we assumed where possible)
406
+ - - SuperCOT (Undisclosed version)
407
+ - elinas/chronos-13b-v2 (Version assumed)
408
+ - NousResearch/Nous-Hermes-Llama2-13b
409
+ - stabilityai/StableBeluga-13B (Version assumed)
410
+ - zattio770/120-Days-of-LORA-v2-13B
411
+ - PygmalionAI/pygmalion-2-13b
412
+ - Undi95/Storytelling-v1-13B-lora
413
+ - TokenBender/sakhi_13B_roleplayer_NSFW_chat_adapter
414
+ - nRuaif/Kimiko-v2-13B
415
+ - The-Face-Of-Goonery/Huginn-13b-FP16
416
+ - - "a lot of different models, like hermes, beluga, airoboros, chronos.. limarp"
417
+ - lemonilia/LimaRP-Llama2-13B-v3-EXPERIMENT
418
+ - Xwin-LM/Xwin-LM-13B-V0.2
419
+ - PocketDoc/Dans-RetroRodeo-13b
420
+ - Blackroot/Llama-2-13B-Storywriter-LORA
421
+ - Doctor-Shotgun/cat-v1.0-13b
422
+ - Doctor-Shotgun/llama-2-13b-chat-limarp-v2-merged
423
+ - meta-llama/Llama-2-13b-chat-hf
424
+ - lemonilia/limarp-llama2-v2
425
+
426
+
427
+ While we could possibly not credit every single lora or model involved in this merged model, we'd like to thank all involved creators upstream for making this awesome model possible!
428
+ Thanks to you the AI ecosystem is thriving, and without your dedicated tuning efforts models such as this one would not be possible.
429
+
430
+ # Usage
431
+ This model is meant to be creative, If you let it improvise you get better results than if you drown it in details.
432
+
433
+ ## Story Writing
434
+ Regular story writing in the traditional way is supported, simply copy paste your story and continue writing. Optionally use an instruction in memory or an authors note to guide the direction of your story.
435
+
436
+ ### Generate a story on demand
437
+ To generate stories on demand you can use an instruction (tested in the Alpaca format) such as "Write a novel about X, use chapters and dialogue" this will generate a story. The format can vary between generations depending on how the model chooses to begin, either write what you want as shown in the earlier example or write the beginning of the story yourself so the model can follow your style. A few retries can also help if the model gets it wrong.
438
+
439
+ ## Chatbots and persona's
440
+ This model has been tested with various forms of chatting, testers have found that typically less is more and the model is good at improvising. Don't drown the model in paragraphs of detailed information, instead keep it simple first and see how far you can lean on the models own ability to figure out your character. Copy pasting paragraphs of background information is not suitable for a 13B model such as this one, code formatted characters or an instruction prompt describing who you wish to talk to goes much further.
441
+
442
+ For example, you can put this in memory in regular chat mode:
443
+ ```
444
+ ### Instruction:
445
+ Generate a conversation between Alice and Jeb where they discuss language models.
446
+ In this conversation Henk is excited to teach Alice about Psyfighter.
447
+ ### Response:
448
+ ```
449
+
450
+ Because the model is a merge of a variety of models, it should support a broad range of instruct formats, or plain chat mode. If you have a particular favourite try it, otherwise we recommend to either use the regular chat mode or Alpaca's format.
451
+
452
+ ## Instruct Prompting
453
+ This model features various instruct models on a variety of instruction styles, when testing the model we have used Alpaca for our own tests. If you prefer a different format chances are it can work.
454
+
455
+ During instructions we have observed that in some cases the adventure data can leak, it may also be worth experimenting using > as the prefix for a user command to remedy this. But this may result in a stronger fiction bias.
456
+
457
+ Keep in mind that while this model can be used as a factual instruct model, the focus was on fiction. Information provided by the model can be made up.
458
+
459
+ ## Adventuring and Adventure Games
460
+ This model contains a lora that was trained on the same adventure dataset as the KoboldAI Skein model. Adventuring is best done using an small introduction to the world and your objective while using the > prefix for a user command (KoboldAI's adventure mode).
461
+
462
+ It is possible that the model does not immediately pick up on what you wish to do and does not engage in its Adventure mode behaviour right away. Simply manually correct the output to trim excess dialogue or other undesirable behaviour and continue to submit your actions using the appropriate mode. The model should pick up on this style quickly and will correctly follow this format within 3 turns.
463
+
464
+ ## Discovered something cool and want to engage with us?
465
+ Join our community at https://koboldai.org/discord !
466
+ We can also provide assistance in making your own merges.