Upload README.md
Browse files
README.md
ADDED
@@ -0,0 +1,503 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
---
|
2 |
+
base_model: SanjiWatsuki/Loyal-Macaroni-Maid-7B
|
3 |
+
inference: false
|
4 |
+
license: cc-by-nc-4.0
|
5 |
+
model_creator: Sanji Watsuki
|
6 |
+
model_name: Loyal Macaroni Maid 7B
|
7 |
+
model_type: mistral
|
8 |
+
prompt_template: 'Below is an instruction that describes a task. Write a response
|
9 |
+
that appropriately completes the request.
|
10 |
+
|
11 |
+
|
12 |
+
### Instruction:
|
13 |
+
|
14 |
+
{prompt}
|
15 |
+
|
16 |
+
|
17 |
+
### Response:
|
18 |
+
|
19 |
+
'
|
20 |
+
quantized_by: TheBloke
|
21 |
+
tags:
|
22 |
+
- merge
|
23 |
+
- not-for-all-audiences
|
24 |
+
- nsfw
|
25 |
+
---
|
26 |
+
<!-- markdownlint-disable MD041 -->
|
27 |
+
|
28 |
+
<!-- header start -->
|
29 |
+
<!-- 200823 -->
|
30 |
+
<div style="width: auto; margin-left: auto; margin-right: auto">
|
31 |
+
<img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
|
32 |
+
</div>
|
33 |
+
<div style="display: flex; justify-content: space-between; width: 100%;">
|
34 |
+
<div style="display: flex; flex-direction: column; align-items: flex-start;">
|
35 |
+
<p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
|
36 |
+
</div>
|
37 |
+
<div style="display: flex; flex-direction: column; align-items: flex-end;">
|
38 |
+
<p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://www.patreon.com/TheBlokeAI">Want to contribute? TheBloke's Patreon page</a></p>
|
39 |
+
</div>
|
40 |
+
</div>
|
41 |
+
<div style="text-align:center; margin-top: 0em; margin-bottom: 0em"><p style="margin-top: 0.25em; margin-bottom: 0em;">TheBloke's LLM work is generously supported by a grant from <a href="https://a16z.com">andreessen horowitz (a16z)</a></p></div>
|
42 |
+
<hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
|
43 |
+
<!-- header end -->
|
44 |
+
|
45 |
+
# Loyal Macaroni Maid 7B - GPTQ
|
46 |
+
- Model creator: [Sanji Watsuki](https://huggingface.co/SanjiWatsuki)
|
47 |
+
- Original model: [Loyal Macaroni Maid 7B](https://huggingface.co/SanjiWatsuki/Loyal-Macaroni-Maid-7B)
|
48 |
+
|
49 |
+
<!-- description start -->
|
50 |
+
# Description
|
51 |
+
|
52 |
+
This repo contains GPTQ model files for [Sanji Watsuki's Loyal Macaroni Maid 7B](https://huggingface.co/SanjiWatsuki/Loyal-Macaroni-Maid-7B).
|
53 |
+
|
54 |
+
Multiple GPTQ parameter permutations are provided; see Provided Files below for details of the options provided, their parameters, and the software used to create them.
|
55 |
+
|
56 |
+
These files were quantised using hardware kindly provided by [Massed Compute](https://massedcompute.com/).
|
57 |
+
|
58 |
+
<!-- description end -->
|
59 |
+
<!-- repositories-available start -->
|
60 |
+
## Repositories available
|
61 |
+
|
62 |
+
* [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/Loyal-Macaroni-Maid-7B-AWQ)
|
63 |
+
* [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/Loyal-Macaroni-Maid-7B-GPTQ)
|
64 |
+
* [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/Loyal-Macaroni-Maid-7B-GGUF)
|
65 |
+
* [Sanji Watsuki's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/SanjiWatsuki/Loyal-Macaroni-Maid-7B)
|
66 |
+
<!-- repositories-available end -->
|
67 |
+
|
68 |
+
<!-- prompt-template start -->
|
69 |
+
## Prompt template: Alpaca
|
70 |
+
|
71 |
+
```
|
72 |
+
Below is an instruction that describes a task. Write a response that appropriately completes the request.
|
73 |
+
|
74 |
+
### Instruction:
|
75 |
+
{prompt}
|
76 |
+
|
77 |
+
### Response:
|
78 |
+
|
79 |
+
```
|
80 |
+
|
81 |
+
<!-- prompt-template end -->
|
82 |
+
|
83 |
+
|
84 |
+
|
85 |
+
<!-- README_GPTQ.md-compatible clients start -->
|
86 |
+
## Known compatible clients / servers
|
87 |
+
|
88 |
+
GPTQ models are currently supported on Linux (NVidia/AMD) and Windows (NVidia only). macOS users: please use GGUF models.
|
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/Loyal-Macaroni-Maid-7B-GPTQ/tree/main) | 4 | 128 | Yes | 0.1 | [OpenErotica Erotiquant](https://huggingface.co/datasets/openerotica/erotiquant/viewer/) | 4096 | 4.16 GB | Yes | 4-bit, with Act Order and group size 128g. Uses even less VRAM than 64g, but with slightly lower accuracy. |
|
125 |
+
| [gptq-4bit-32g-actorder_True](https://huggingface.co/TheBloke/Loyal-Macaroni-Maid-7B-GPTQ/tree/gptq-4bit-32g-actorder_True) | 4 | 32 | Yes | 0.1 | [OpenErotica Erotiquant](https://huggingface.co/datasets/openerotica/erotiquant/viewer/) | 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/Loyal-Macaroni-Maid-7B-GPTQ/tree/gptq-8bit--1g-actorder_True) | 8 | None | Yes | 0.1 | [OpenErotica Erotiquant](https://huggingface.co/datasets/openerotica/erotiquant/viewer/) | 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/Loyal-Macaroni-Maid-7B-GPTQ/tree/gptq-8bit-128g-actorder_True) | 8 | 128 | Yes | 0.1 | [OpenErotica Erotiquant](https://huggingface.co/datasets/openerotica/erotiquant/viewer/) | 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/Loyal-Macaroni-Maid-7B-GPTQ/tree/gptq-8bit-32g-actorder_True) | 8 | 32 | Yes | 0.1 | [OpenErotica Erotiquant](https://huggingface.co/datasets/openerotica/erotiquant/viewer/) | 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/Loyal-Macaroni-Maid-7B-GPTQ/tree/gptq-4bit-64g-actorder_True) | 4 | 64 | Yes | 0.1 | [OpenErotica Erotiquant](https://huggingface.co/datasets/openerotica/erotiquant/viewer/) | 4096 | 4.29 GB | Yes | 4-bit, with Act Order and group size 64g. Uses less VRAM than 32g, but with slightly lower accuracy. |
|
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/Loyal-Macaroni-Maid-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/Loyal-Macaroni-Maid-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 `Loyal-Macaroni-Maid-7B-GPTQ`:
|
151 |
+
|
152 |
+
```shell
|
153 |
+
mkdir Loyal-Macaroni-Maid-7B-GPTQ
|
154 |
+
huggingface-cli download TheBloke/Loyal-Macaroni-Maid-7B-GPTQ --local-dir Loyal-Macaroni-Maid-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 Loyal-Macaroni-Maid-7B-GPTQ
|
161 |
+
huggingface-cli download TheBloke/Loyal-Macaroni-Maid-7B-GPTQ --revision gptq-4bit-32g-actorder_True --local-dir Loyal-Macaroni-Maid-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 Loyal-Macaroni-Maid-7B-GPTQ
|
183 |
+
HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/Loyal-Macaroni-Maid-7B-GPTQ --local-dir Loyal-Macaroni-Maid-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/Loyal-Macaroni-Maid-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/Loyal-Macaroni-Maid-7B-GPTQ`.
|
209 |
+
|
210 |
+
- To download from a specific branch, enter for example `TheBloke/Loyal-Macaroni-Maid-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: `Loyal-Macaroni-Maid-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/Loyal-Macaroni-Maid-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'''Below is an instruction that describes a task. Write a response that appropriately completes the request.
|
250 |
+
|
251 |
+
### Instruction:
|
252 |
+
{prompt}
|
253 |
+
|
254 |
+
### Response:
|
255 |
+
'''
|
256 |
+
|
257 |
+
client = InferenceClient(endpoint_url)
|
258 |
+
response = client.text_generation(
|
259 |
+
prompt_template,
|
260 |
+
max_new_tokens=128,
|
261 |
+
do_sample=True,
|
262 |
+
temperature=0.7,
|
263 |
+
top_p=0.95,
|
264 |
+
top_k=40,
|
265 |
+
repetition_penalty=1.1
|
266 |
+
)
|
267 |
+
|
268 |
+
print(f"Model output: {response}")
|
269 |
+
```
|
270 |
+
<!-- README_GPTQ.md-use-from-tgi end -->
|
271 |
+
<!-- README_GPTQ.md-use-from-python start -->
|
272 |
+
## Python code example: inference from this GPTQ model
|
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 --upgrade transformers optimum
|
280 |
+
# If using PyTorch 2.1 + CUDA 12.x:
|
281 |
+
pip3 install --upgrade auto-gptq
|
282 |
+
# or, if using PyTorch 2.1 + CUDA 11.x:
|
283 |
+
pip3 install --upgrade auto-gptq --extra-index-url https://huggingface.github.io/autogptq-index/whl/cu118/
|
284 |
+
```
|
285 |
+
|
286 |
+
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:
|
287 |
+
|
288 |
+
```shell
|
289 |
+
pip3 uninstall -y auto-gptq
|
290 |
+
git clone https://github.com/PanQiWei/AutoGPTQ
|
291 |
+
cd AutoGPTQ
|
292 |
+
git checkout v0.5.1
|
293 |
+
pip3 install .
|
294 |
+
```
|
295 |
+
|
296 |
+
### Example Python code
|
297 |
+
|
298 |
+
```python
|
299 |
+
from transformers import AutoModelForCausalLM, AutoTokenizer, pipeline
|
300 |
+
|
301 |
+
model_name_or_path = "TheBloke/Loyal-Macaroni-Maid-7B-GPTQ"
|
302 |
+
# To use a different branch, change revision
|
303 |
+
# For example: revision="gptq-4bit-32g-actorder_True"
|
304 |
+
model = AutoModelForCausalLM.from_pretrained(model_name_or_path,
|
305 |
+
device_map="auto",
|
306 |
+
trust_remote_code=False,
|
307 |
+
revision="main")
|
308 |
+
|
309 |
+
tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, use_fast=True)
|
310 |
+
|
311 |
+
prompt = "Write a story about llamas"
|
312 |
+
system_message = "You are a story writing assistant"
|
313 |
+
prompt_template=f'''Below is an instruction that describes a task. Write a response that appropriately completes the request.
|
314 |
+
|
315 |
+
### Instruction:
|
316 |
+
{prompt}
|
317 |
+
|
318 |
+
### Response:
|
319 |
+
'''
|
320 |
+
|
321 |
+
print("\n\n*** Generate:")
|
322 |
+
|
323 |
+
input_ids = tokenizer(prompt_template, return_tensors='pt').input_ids.cuda()
|
324 |
+
output = model.generate(inputs=input_ids, temperature=0.7, do_sample=True, top_p=0.95, top_k=40, max_new_tokens=512)
|
325 |
+
print(tokenizer.decode(output[0]))
|
326 |
+
|
327 |
+
# Inference can also be done using transformers' pipeline
|
328 |
+
|
329 |
+
print("*** Pipeline:")
|
330 |
+
pipe = pipeline(
|
331 |
+
"text-generation",
|
332 |
+
model=model,
|
333 |
+
tokenizer=tokenizer,
|
334 |
+
max_new_tokens=512,
|
335 |
+
do_sample=True,
|
336 |
+
temperature=0.7,
|
337 |
+
top_p=0.95,
|
338 |
+
top_k=40,
|
339 |
+
repetition_penalty=1.1
|
340 |
+
)
|
341 |
+
|
342 |
+
print(pipe(prompt_template)[0]['generated_text'])
|
343 |
+
```
|
344 |
+
<!-- README_GPTQ.md-use-from-python end -->
|
345 |
+
|
346 |
+
<!-- README_GPTQ.md-compatibility start -->
|
347 |
+
## Compatibility
|
348 |
+
|
349 |
+
The files provided are tested to work with Transformers. For non-Mistral models, AutoGPTQ can also be used directly.
|
350 |
+
|
351 |
+
[ExLlama](https://github.com/turboderp/exllama) is compatible with Llama architecture models (including Mistral, Yi, DeepSeek, SOLAR, etc) in 4-bit. Please see the Provided Files table above for per-file compatibility.
|
352 |
+
|
353 |
+
For a list of clients/servers, please see "Known compatible clients / servers", above.
|
354 |
+
<!-- README_GPTQ.md-compatibility end -->
|
355 |
+
|
356 |
+
<!-- footer start -->
|
357 |
+
<!-- 200823 -->
|
358 |
+
## Discord
|
359 |
+
|
360 |
+
For further support, and discussions on these models and AI in general, join us at:
|
361 |
+
|
362 |
+
[TheBloke AI's Discord server](https://discord.gg/theblokeai)
|
363 |
+
|
364 |
+
## Thanks, and how to contribute
|
365 |
+
|
366 |
+
Thanks to the [chirper.ai](https://chirper.ai) team!
|
367 |
+
|
368 |
+
Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
|
369 |
+
|
370 |
+
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.
|
371 |
+
|
372 |
+
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.
|
373 |
+
|
374 |
+
Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
|
375 |
+
|
376 |
+
* Patreon: https://patreon.com/TheBlokeAI
|
377 |
+
* Ko-Fi: https://ko-fi.com/TheBlokeAI
|
378 |
+
|
379 |
+
**Special thanks to**: Aemon Algiz.
|
380 |
+
|
381 |
+
**Patreon special mentions**: Michael Levine, 阿明, Trailburnt, Nikolai Manek, John Detwiler, Randy H, Will Dee, Sebastain Graf, NimbleBox.ai, Eugene Pentland, Emad Mostaque, Ai Maven, Jim Angel, Jeff Scroggin, Michael Davis, Manuel Alberto Morcote, Stephen Murray, Robert, Justin Joy, Luke @flexchar, Brandon Frisco, Elijah Stavena, S_X, Dan Guido, Undi ., Komninos Chatzipapas, Shadi, theTransient, Lone Striker, Raven Klaugh, jjj, Cap'n Zoog, Michel-Marie MAUDET (LINAGORA), Matthew Berman, David, Fen Risland, Omer Bin Jawed, Luke Pendergrass, Kalila, OG, Erik Bjäreholt, Rooh Singh, Joseph William Delisle, Dan Lewis, TL, John Villwock, AzureBlack, Brad, Pedro Madruga, Caitlyn Gatomon, K, jinyuan sun, Mano Prime, Alex, Jeffrey Morgan, Alicia Loh, Illia Dulskyi, Chadd, transmissions 11, fincy, Rainer Wilmers, ReadyPlayerEmma, knownsqashed, Mandus, biorpg, Deo Leter, Brandon Phillips, SuperWojo, Sean Connelly, Iucharbius, Jack West, Harry Royden McLaughlin, Nicholas, terasurfer, Vitor Caleffi, Duane Dunston, Johann-Peter Hartmann, David Ziegler, Olakabola, Ken Nordquist, Trenton Dambrowitz, Tom X Nguyen, Vadim, Ajan Kanaga, Leonard Tan, Clay Pascal, Alexandros Triantafyllidis, JM33133, Xule, vamX, ya boyyy, subjectnull, Talal Aujan, Alps Aficionado, wassieverse, Ari Malik, James Bentley, Woland, Spencer Kim, Michael Dempsey, Fred von Graf, Elle, zynix, William Richards, Stanislav Ovsiannikov, Edmond Seymore, Jonathan Leane, Martin Kemka, usrbinkat, Enrico Ros
|
382 |
+
|
383 |
+
|
384 |
+
Thank you to all my generous patrons and donaters!
|
385 |
+
|
386 |
+
And thank you again to a16z for their generous grant.
|
387 |
+
|
388 |
+
<!-- footer end -->
|
389 |
+
|
390 |
+
# Original model card: Sanji Watsuki's Loyal Macaroni Maid 7B
|
391 |
+
|
392 |
+
|
393 |
+
![image/png](https://huggingface.co/SanjiWatsuki/Loyal-Macaroni-Maid-7B/resolve/main/macaroni-maid.jpg)
|
394 |
+
|
395 |
+
<!-- description start -->
|
396 |
+
## Description
|
397 |
+
|
398 |
+
This repository hosts quantized GGUF files for **Loyal-Macaroni-Maid-7B**, a 7B model aimed at having engaging RP with solid character card adherence and being a smart cookie at the same time.
|
399 |
+
|
400 |
+
In my limited testing, it's a great RP model suitable for RP/ERP with sharp reasoning skills for a 7B. I expect it to both benchmark well and be a very suitable model for general use.
|
401 |
+
|
402 |
+
<!-- description end -->
|
403 |
+
<!-- prompt-template start -->
|
404 |
+
## Prompt template: Custom format, or Alpaca
|
405 |
+
|
406 |
+
### Custom format:
|
407 |
+
I found the best SillyTavern results from using the Noromaid template.
|
408 |
+
|
409 |
+
SillyTavern config files: [Context](https://files.catbox.moe/ifmhai.json), [Instruct](https://files.catbox.moe/ttw1l9.json). Additionally, here is my [Text Completion preset](https://huggingface.co/SanjiWatsuki/Loyal-Macaroni-Maid-7B/blob/main/Characters/MinP.json)
|
410 |
+
|
411 |
+
Otherwise, I tried to ensure that most of the underlying merged models were Alpaca-ish.
|
412 |
+
|
413 |
+
### Alpaca:
|
414 |
+
```
|
415 |
+
Below is an instruction that describes a task. Write a response that appropriately completes the request.
|
416 |
+
|
417 |
+
### Instruction:
|
418 |
+
{prompt}
|
419 |
+
|
420 |
+
### Response:
|
421 |
+
|
422 |
+
```
|
423 |
+
|
424 |
+
## Helpful Tips
|
425 |
+
|
426 |
+
For SFW RP, I found that I got the most use out of this model when I had an RPG Narrator in a group chat with the characters I wanted to RP with. Here is an importable character card for the best RPG Narrator I found thus far.
|
427 |
+
|
428 |
+
![image/png](https://huggingface.co/SanjiWatsuki/Loyal-Macaroni-Maid-7B/resolve/main/Characters/RPGNarrator.png)
|
429 |
+
|
430 |
+
For basic ChatGPT tasks, here is the basic Assistant card that I use. I found it works best with Default context template / Alpaca instruct template in Silly Tavern.
|
431 |
+
|
432 |
+
![image/png](https://huggingface.co/SanjiWatsuki/Loyal-Macaroni-Maid-7B/resolve/main/Characters/Indigo.png)
|
433 |
+
|
434 |
+
## Frankenstein's Merger
|
435 |
+
|
436 |
+
**tl;dr: This is a bunch of model merger slop with a bunch of RP cherries on top.**
|
437 |
+
|
438 |
+
I'll keep it a buck - I'm not a fan of this model's composition. Based on my testing, it seemed like models that were built from a merger of OpenChat-3.5/Starling and NeuralChat v3.1 had surprisingly good character card coherence for a 7B model - better than either one in isolation. This is validated both in my personal benchmarks as well as the [Ayumi NSFW ERP ALC-IQ3 metric](http://ayumi.m8geil.de/ayumi_bench_v3_results.html) which rates character card coherence and is dominated by OpenNeuralChat mergers for small models.
|
439 |
+
|
440 |
+
The issue is... prompt format.
|
441 |
+
|
442 |
+
OpenChat-3.5 uses an abomination of a prompt format with "GPT4 Correct User/Assistant" all over it in a ChatML-style prompt with extra tokens for padding and end-of-turn. NeuralChat v3.1 uses a weird Alpaca-like format with "### System/User/Assistant" all over it. Almost every RP finetune standardized on Alpaca or an expanded Alpaca with janky multi-turn prompting (since Alpaca doesn't have multi-turn prompting).
|
443 |
+
|
444 |
+
Most model mergers like [Q-bert/MetaMath-Cybertron-Starling](https://huggingface.co/Q-bert/MetaMath-Cybertron-Starling) just slam them together and toss the extra ChatML tokens, resulting in a half-Alpaca-like half-ChatML-like Frankenstein's monster. For the most part, using Alpaca as the lingua franca just kinda works but [there are exceptions that can make a generation go off the rails](https://huggingface.co/AIDC-ai-business/Marcoroni-7B-v3/discussions/6). I found this to be a bit of an issue in certain SillyTavern test cases.
|
445 |
+
|
446 |
+
Regardless, the strong Chat Arena performances from 7B models continues to lead me to believe they're the strongest base for an all-purpose model.
|
447 |
+
|
448 |
+
### The sauce (All You Need is DARE)
|
449 |
+
|
450 |
+
**tl;dr: It's an OpenChat/NeuralChat merger with as much RP as possible stuffed in using the DARE TIES merger method.**
|
451 |
+
|
452 |
+
This model is a DARE TIES merger between Toten5/Marcoroni-neural-chat-7B-v2, chargoddard/loyal-piano-m7, Undi95/Toppy-M-7B, NeverSleep/Noromaid-7b-v0.2, and athirdpath/NSFW_DPO_vmgb-7b on top of a mistralai/Mistral-7B-v0.1 base.
|
453 |
+
|
454 |
+
```
|
455 |
+
models:
|
456 |
+
- model: mistralai/Mistral-7B-v0.1
|
457 |
+
# no parameters necessary for base model
|
458 |
+
- model: Toten5/Marcoroni-neural-chat-7B-v2
|
459 |
+
parameters:
|
460 |
+
weight: 0.3
|
461 |
+
density: 0.8
|
462 |
+
- model: chargoddard/loyal-piano-m7
|
463 |
+
parameters:
|
464 |
+
weight: 0.4
|
465 |
+
density: 0.8
|
466 |
+
- model: Undi95/Toppy-M-7B
|
467 |
+
parameters:
|
468 |
+
weight: 0.2
|
469 |
+
density: 0.4
|
470 |
+
- model: NeverSleep/Noromaid-7b-v0.2
|
471 |
+
parameters:
|
472 |
+
weight: 0.2
|
473 |
+
density: 0.4
|
474 |
+
- model: athirdpath/NSFW_DPO_vmgb-7b
|
475 |
+
parameters:
|
476 |
+
weight: 0.2
|
477 |
+
density: 0.4
|
478 |
+
merge_method: dare_ties
|
479 |
+
base_model: mistralai/Mistral-7B-v0.1
|
480 |
+
parameters:
|
481 |
+
int8_mask: true
|
482 |
+
dtype: bfloat16
|
483 |
+
```
|
484 |
+
|
485 |
+
There's a lot to unpack here. I went with DARE TIES because it appeared to be a viable way to combine information into models without losing smarts. Directly SLERPing a smart cookie model with an ERP brained model will often dilute both the model's smarts and RPing ability. This is an attempt to have my cookie and eat it, too.
|
486 |
+
|
487 |
+
First, there are two high density high weight models:
|
488 |
+
|
489 |
+
[chargoddard/loyal-piano-m7](https://huggingface.co/chargoddard/loyal-piano-m7) is the easy primary model choice. It's an Alpaca prompt format model that scores highly, is very creative for a 7B, and is primarily trained on RP data.
|
490 |
+
|
491 |
+
[Toten5/Marcoroni-neural-chat-7B-v2](https://huggingface.co/Toten5/Marcoroni-neural-chat-7B-v2) is the unintuitive second model pick. It is a merger of mergers that chains back to being an OpenChat/NeuralChat merger being SLERPed back into NeuralChat a second time. Despite SLERPing NeuralChat in multiple times, it retains its high benchmark scores. I opted to pick this model as my base because I believed it was the OpenChat/NeuralChat model that benchmarked well that was closest to the O.G. NeuralChat which has the most Alpaca-like prompt.
|
492 |
+
|
493 |
+
By picking a density of 0.8, these models have a 96% chance of showing up for any TIE merger. This should ensure that there is a solid "base" of deltas from the base Mistral model that captures most of what makes these models good. High density with 0.3-0.4 weights have been shown in mergers like [jan-hq/supermario-v2](https://huggingface.co/jan-hq/supermario-v2)
|
494 |
+
|
495 |
+
Next, there are 3 RP models merged in with medium density. [Undi95/Toppy-M-7B](https://huggingface.co/Undi95/Toppy-M-7B), [NeverSleep/Noromaid-7b-v0.2](https://huggingface.co/NeverSleep/Noromaid-7b-v0.2), and [athirdpath/NSFW_DPO_vmgb-7b](https://huggingface.co/athirdpath/NSFW_DPO_vmgb-7b). Toppy-M-7B is an easy pick for being a well regarded 7B RP model - although, it is a merger of many mergers which might dilute its effectiveness as a lower density merge. NeverSleep/Noromaid-7b-v0.2 pulls in the unique private Noromaid RP dataset. Finally, athirdpath/NSFW_DPO_vmgb-7b is another Frankenstein OpenNeuralChat merger that happens to be DPOed on athirdpath's NSFW Alpaca pairs which seemed like another good RP addition to the model (plus, maybe it tilts it to being more Alpaca-flavored, idk).
|
496 |
+
|
497 |
+
By picking a density of 0.4, these models should *largely* impart some of their flavor onto the merger. I suspect the density could go even lower and the models could be used even more like a LoRA-like merger on top.
|
498 |
+
|
499 |
+
The DARE TIES merger is intentionally overweight and non-normalized at 1.3 total weight. I intentionally went overweight to try and better capture the individual characteristics from the various models. With wide mergers, a weight of 1.0 can often become incoherent like [jan-hq/supermario-v1](https://huggingface.co/jan-hq/supermario-v1).
|
500 |
+
|
501 |
+
Putting it all together, ~60% of the model is "base models" like OpenChat/NeuralChat/Loyal-Piano-M7. ~40% of the model is effectively me trying to extract RP information from existing RP models. The only non-RP model is the Marcoroni base which means that almost 80% of this model is intended for RP.
|
502 |
+
|
503 |
+
Not that the benchmarks matter, but if this merger works right, it'll be a high benchmarking 7B that is both smart and strong at RP.
|