TheBloke commited on
Commit
0eca570
1 Parent(s): 7befb06

Initial GGML model commit

Browse files
Files changed (1) hide show
  1. README.md +194 -0
README.md ADDED
@@ -0,0 +1,194 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ inference: false
3
+ language:
4
+ - en
5
+ license: other
6
+ model_creator: Gryphe
7
+ model_link: https://huggingface.co/Gryphe/MythoLogic-Mini-7b
8
+ model_name: Mythologic Mini 7B
9
+ model_type: llama
10
+ quantized_by: TheBloke
11
+ ---
12
+
13
+ <!-- header start -->
14
+ <div style="width: 100%;">
15
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
16
+ </div>
17
+ <div style="display: flex; justify-content: space-between; width: 100%;">
18
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
19
+ <p><a href="https://discord.gg/theblokeai">Chat & support: my new Discord server</a></p>
20
+ </div>
21
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
22
+ <p><a href="https://www.patreon.com/TheBlokeAI">Want to contribute? TheBloke's Patreon page</a></p>
23
+ </div>
24
+ </div>
25
+ <!-- header end -->
26
+
27
+ # Mythologic Mini 7B - GGML
28
+ - Model creator: [Gryphe](https://huggingface.co/Gryphe)
29
+ - Original model: [Mythologic Mini 7B](https://huggingface.co/Gryphe/MythoLogic-Mini-7b)
30
+
31
+ ## Description
32
+
33
+ This repo contains GGML format model files for [Gryphe's Mythologic Mini 7B](https://huggingface.co/Gryphe/MythoLogic-Mini-7b).
34
+
35
+ GGML files are for CPU + GPU inference using [llama.cpp](https://github.com/ggerganov/llama.cpp) and libraries and UIs which support this format, such as:
36
+ * [text-generation-webui](https://github.com/oobabooga/text-generation-webui), the most popular web UI. Supports NVidia CUDA GPU acceleration.
37
+ * [KoboldCpp](https://github.com/LostRuins/koboldcpp), a powerful GGML web UI with GPU acceleration on all platforms (CUDA and OpenCL). Especially good for story telling.
38
+ * [LM Studio](https://lmstudio.ai/), a fully featured local GUI with GPU acceleration on both Windows (NVidia and AMD), and macOS.
39
+ * [LoLLMS Web UI](https://github.com/ParisNeo/lollms-webui), a great web UI with CUDA GPU acceleration via the c_transformers backend.
40
+ * [ctransformers](https://github.com/marella/ctransformers), a Python library with GPU accel, LangChain support, and OpenAI-compatible AI server.
41
+ * [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
42
+
43
+ ## Repositories available
44
+
45
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/MythoLogic-Mini-7B-GPTQ)
46
+ * [2, 3, 4, 5, 6 and 8-bit GGML models for CPU+GPU inference](https://huggingface.co/TheBloke/MythoLogic-Mini-7B-GGML)
47
+ * [Gryphe's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/Gryphe/MythoLogic-Mini-7b)
48
+
49
+ ## Prompt template: Alpaca
50
+
51
+ ```
52
+ Below is an instruction that describes a task. Write a response that appropriately completes the request.
53
+
54
+ ### Instruction: {prompt}
55
+
56
+ ### Response:
57
+ ```
58
+
59
+ <!-- compatibility_ggml start -->
60
+ ## Compatibility
61
+
62
+ ### Original llama.cpp quant methods: `q4_0, q4_1, q5_0, q5_1, q8_0`
63
+
64
+ These are guaranteed to be compatible with any UIs, tools and libraries released since late May. They may be phased out soon, as they are largely superseded by the new k-quant methods.
65
+
66
+ ### New k-quant methods: `q2_K, q3_K_S, q3_K_M, q3_K_L, q4_K_S, q4_K_M, q5_K_S, q6_K`
67
+
68
+ These new quantisation methods are compatible with llama.cpp as of June 6th, commit `2d43387`.
69
+
70
+ They are now also compatible with recent releases of text-generation-webui, KoboldCpp, llama-cpp-python, ctransformers, rustformers and most others. For compatibility with other tools and libraries, please check their documentation.
71
+
72
+ ## Explanation of the new k-quant methods
73
+ <details>
74
+ <summary>Click to see details</summary>
75
+
76
+ The new methods available are:
77
+ * GGML_TYPE_Q2_K - "type-1" 2-bit quantization in super-blocks containing 16 blocks, each block having 16 weight. Block scales and mins are quantized with 4 bits. This ends up effectively using 2.5625 bits per weight (bpw)
78
+ * GGML_TYPE_Q3_K - "type-0" 3-bit quantization in super-blocks containing 16 blocks, each block having 16 weights. Scales are quantized with 6 bits. This end up using 3.4375 bpw.
79
+ * GGML_TYPE_Q4_K - "type-1" 4-bit quantization in super-blocks containing 8 blocks, each block having 32 weights. Scales and mins are quantized with 6 bits. This ends up using 4.5 bpw.
80
+ * GGML_TYPE_Q5_K - "type-1" 5-bit quantization. Same super-block structure as GGML_TYPE_Q4_K resulting in 5.5 bpw
81
+ * GGML_TYPE_Q6_K - "type-0" 6-bit quantization. Super-blocks with 16 blocks, each block having 16 weights. Scales are quantized with 8 bits. This ends up using 6.5625 bpw
82
+ * GGML_TYPE_Q8_K - "type-0" 8-bit quantization. Only used for quantizing intermediate results. The difference to the existing Q8_0 is that the block size is 256. All 2-6 bit dot products are implemented for this quantization type.
83
+
84
+ Refer to the Provided Files table below to see what files use which methods, and how.
85
+ </details>
86
+ <!-- compatibility_ggml end -->
87
+
88
+ ## Provided files
89
+
90
+ | Name | Quant method | Bits | Size | Max RAM required | Use case |
91
+ | ---- | ---- | ---- | ---- | ---- | ----- |
92
+ | [mythologic-mini-7b.ggmlv3.q2_K.bin](https://huggingface.co/TheBloke/MythoLogic-Mini-7B-GGML/blob/main/mythologic-mini-7b.ggmlv3.q2_K.bin) | q2_K | 2 | 2.87 GB| 5.37 GB | New k-quant method. Uses GGML_TYPE_Q4_K for the attention.vw and feed_forward.w2 tensors, GGML_TYPE_Q2_K for the other tensors. |
93
+ | [mythologic-mini-7b.ggmlv3.q3_K_L.bin](https://huggingface.co/TheBloke/MythoLogic-Mini-7B-GGML/blob/main/mythologic-mini-7b.ggmlv3.q3_K_L.bin) | q3_K_L | 3 | 3.60 GB| 6.10 GB | New k-quant method. Uses GGML_TYPE_Q5_K for the attention.wv, attention.wo, and feed_forward.w2 tensors, else GGML_TYPE_Q3_K |
94
+ | [mythologic-mini-7b.ggmlv3.q3_K_M.bin](https://huggingface.co/TheBloke/MythoLogic-Mini-7B-GGML/blob/main/mythologic-mini-7b.ggmlv3.q3_K_M.bin) | q3_K_M | 3 | 3.28 GB| 5.78 GB | New k-quant method. Uses GGML_TYPE_Q4_K for the attention.wv, attention.wo, and feed_forward.w2 tensors, else GGML_TYPE_Q3_K |
95
+ | [mythologic-mini-7b.ggmlv3.q3_K_S.bin](https://huggingface.co/TheBloke/MythoLogic-Mini-7B-GGML/blob/main/mythologic-mini-7b.ggmlv3.q3_K_S.bin) | q3_K_S | 3 | 2.95 GB| 5.45 GB | New k-quant method. Uses GGML_TYPE_Q3_K for all tensors |
96
+ | [mythologic-mini-7b.ggmlv3.q4_0.bin](https://huggingface.co/TheBloke/MythoLogic-Mini-7B-GGML/blob/main/mythologic-mini-7b.ggmlv3.q4_0.bin) | q4_0 | 4 | 3.83 GB| 6.33 GB | Original quant method, 4-bit. |
97
+ | [mythologic-mini-7b.ggmlv3.q4_1.bin](https://huggingface.co/TheBloke/MythoLogic-Mini-7B-GGML/blob/main/mythologic-mini-7b.ggmlv3.q4_1.bin) | q4_1 | 4 | 4.24 GB| 6.74 GB | Original quant method, 4-bit. Higher accuracy than q4_0 but not as high as q5_0. However has quicker inference than q5 models. |
98
+ | [mythologic-mini-7b.ggmlv3.q4_K_M.bin](https://huggingface.co/TheBloke/MythoLogic-Mini-7B-GGML/blob/main/mythologic-mini-7b.ggmlv3.q4_K_M.bin) | q4_K_M | 4 | 4.08 GB| 6.58 GB | New k-quant method. Uses GGML_TYPE_Q6_K for half of the attention.wv and feed_forward.w2 tensors, else GGML_TYPE_Q4_K |
99
+ | [mythologic-mini-7b.ggmlv3.q4_K_S.bin](https://huggingface.co/TheBloke/MythoLogic-Mini-7B-GGML/blob/main/mythologic-mini-7b.ggmlv3.q4_K_S.bin) | q4_K_S | 4 | 3.83 GB| 6.33 GB | New k-quant method. Uses GGML_TYPE_Q4_K for all tensors |
100
+ | [mythologic-mini-7b.ggmlv3.q5_0.bin](https://huggingface.co/TheBloke/MythoLogic-Mini-7B-GGML/blob/main/mythologic-mini-7b.ggmlv3.q5_0.bin) | q5_0 | 5 | 4.65 GB| 7.15 GB | Original quant method, 5-bit. Higher accuracy, higher resource usage and slower inference. |
101
+ | [mythologic-mini-7b.ggmlv3.q5_1.bin](https://huggingface.co/TheBloke/MythoLogic-Mini-7B-GGML/blob/main/mythologic-mini-7b.ggmlv3.q5_1.bin) | q5_1 | 5 | 5.06 GB| 7.56 GB | Original quant method, 5-bit. Even higher accuracy, resource usage and slower inference. |
102
+ | [mythologic-mini-7b.ggmlv3.q5_K_M.bin](https://huggingface.co/TheBloke/MythoLogic-Mini-7B-GGML/blob/main/mythologic-mini-7b.ggmlv3.q5_K_M.bin) | q5_K_M | 5 | 4.78 GB| 7.28 GB | New k-quant method. Uses GGML_TYPE_Q6_K for half of the attention.wv and feed_forward.w2 tensors, else GGML_TYPE_Q5_K |
103
+ | [mythologic-mini-7b.ggmlv3.q5_K_S.bin](https://huggingface.co/TheBloke/MythoLogic-Mini-7B-GGML/blob/main/mythologic-mini-7b.ggmlv3.q5_K_S.bin) | q5_K_S | 5 | 4.65 GB| 7.15 GB | New k-quant method. Uses GGML_TYPE_Q5_K for all tensors |
104
+ | [mythologic-mini-7b.ggmlv3.q6_K.bin](https://huggingface.co/TheBloke/MythoLogic-Mini-7B-GGML/blob/main/mythologic-mini-7b.ggmlv3.q6_K.bin) | q6_K | 6 | 5.53 GB| 8.03 GB | New k-quant method. Uses GGML_TYPE_Q8_K for all tensors - 6-bit quantization |
105
+ | [mythologic-mini-7b.ggmlv3.q8_0.bin](https://huggingface.co/TheBloke/MythoLogic-Mini-7B-GGML/blob/main/mythologic-mini-7b.ggmlv3.q8_0.bin) | q8_0 | 8 | 7.13 GB| 9.63 GB | Original quant method, 8-bit. Almost indistinguishable from float16. High resource use and slow. Not recommended for most users. |
106
+
107
+ **Note**: the above RAM figures assume no GPU offloading. If layers are offloaded to the GPU, this will reduce RAM usage and use VRAM instead.
108
+
109
+ ## How to run in `llama.cpp`
110
+
111
+ I use the following command line; adjust for your tastes and needs:
112
+
113
+ ```
114
+ ./main -t 10 -ngl 32 -m mythologic-mini-7b.ggmlv3.q4_K_M.bin --color -c 2048 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "### Instruction: Write a story about llamas\n### Response:"
115
+ ```
116
+ Change `-t 10` to the number of physical CPU cores you have. For example if your system has 8 cores/16 threads, use `-t 8`.
117
+
118
+ Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
119
+
120
+ If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
121
+
122
+ ## How to run in `text-generation-webui`
123
+
124
+ Further instructions here: [text-generation-webui/docs/llama.cpp-models.md](https://github.com/oobabooga/text-generation-webui/blob/main/docs/llama.cpp-models.md).
125
+
126
+ <!-- footer start -->
127
+ ## Discord
128
+
129
+ For further support, and discussions on these models and AI in general, join us at:
130
+
131
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
132
+
133
+ ## Thanks, and how to contribute.
134
+
135
+ Thanks to the [chirper.ai](https://chirper.ai) team!
136
+
137
+ 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.
138
+
139
+ 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.
140
+
141
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
142
+
143
+ * Patreon: https://patreon.com/TheBlokeAI
144
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
145
+
146
+ **Special thanks to**: Luke from CarbonQuill, Aemon Algiz.
147
+
148
+ **Patreon special mentions**: Slarti, Chadd, John Detwiler, Pieter, zynix, K, Mano Prime, ReadyPlayerEmma, Ai Maven, Leonard Tan, Edmond Seymore, Joseph William Delisle, Luke @flexchar, Fred von Graf, Viktor Bowallius, Rishabh Srivastava, Nikolai Manek, Matthew Berman, Johann-Peter Hartmann, ya boyyy, Greatston Gnanesh, Femi Adebogun, Talal Aujan, Jonathan Leane, terasurfer, David Flickinger, William Sang, Ajan Kanaga, Vadim, Artur Olbinski, Raven Klaugh, Michael Levine, Oscar Rangel, Randy H, Cory Kujawski, RoA, Dave, Alex, Alexandros Triantafyllidis, Fen Risland, Eugene Pentland, vamX, Elle, Nathan LeClaire, Khalefa Al-Ahmad, Rainer Wilmers, subjectnull, Junyu Yang, Daniel P. Andersen, SuperWojo, LangChain4j, Mandus, Kalila, Illia Dulskyi, Trenton Dambrowitz, Asp the Wyvern, Derek Yates, Jeffrey Morgan, Deep Realms, Imad Khwaja, Pyrater, Preetika Verma, biorpg, Gabriel Tamborski, Stephen Murray, Spiking Neurons AB, Iucharbius, Chris Smitley, Willem Michiel, Luke Pendergrass, Sebastain Graf, senxiiz, Will Dee, Space Cruiser, Karl Bernard, Clay Pascal, Lone Striker, transmissions 11, webtim, WelcomeToTheClub, Sam, theTransient, Pierre Kircher, chris gileta, John Villwock, Sean Connelly, Willian Hasse
149
+
150
+
151
+ Thank you to all my generous patrons and donaters!
152
+
153
+ <!-- footer end -->
154
+
155
+ # Original model card: Gryphe's Mythologic Mini 7B
156
+
157
+ ## Model details
158
+
159
+ MythoLogic-Mini-7b can be considered the little brother in my Mytho series of models: [MythoLogic-13b](https://huggingface.co/Gryphe/MythoLogic-13b) and [MythoBoros-13b](https://huggingface.co/Gryphe/MythoBoros-13b)).
160
+
161
+ Its Llama-2 core is powered by [Nous Hermes-2](https://huggingface.co/NousResearch/Nous-Hermes-llama-2-7b), which is further augmented by [Stable Beluga](https://huggingface.co/stabilityai/StableBeluga-7B) and a carefully distilled [Kimiko LoRa](https://huggingface.co/nRuaif/Kimiko_7B).
162
+
163
+ Since 7B models tend to be less capable all-rounders, more emphasis was put on improving the roleplaying aspects for this gradient merge, of which various gradients were benchmarked before settling on the configuration shown below.
164
+
165
+ ![](MythoLogic-Mini-7b.png)
166
+
167
+ In technical terms, the Hermes-2 core starts at 90% strength before fading away completely at the 12th layer level, where Stable Beluga (and Kimiko) handle the more intricate linguistic aspects.
168
+
169
+ Quantized models are available from TheBloke: [GGML](https://huggingface.co/TheBloke/MythoLogic-Mini-7b-GGML) - [GPTQ](https://huggingface.co/TheBloke/MythoLogic-Mini-7b-GPTQ) (You're the best!)
170
+
171
+ ## Prompt Format
172
+
173
+ Due to its Hermes-2 core this model works best with Alpaca formatting, so for optimal model performance, use:
174
+ ```
175
+ ### Instruction:
176
+ Your instruction or question here.
177
+ ### Response:
178
+ ```
179
+
180
+ For chat/roleplay conversations, I suggest the following structure instead:
181
+ ```
182
+ You are <AI NAME>, a friendly and supportive AI language model. We discuss all subjects freely and without bias or restrictions.
183
+ I am <YOUR NAME>, the user interacting with you through a chat conversation. Start with greeting me.
184
+
185
+ ### Instruction:
186
+ Write <AI NAME>'s next reply in a chat between <YOUR NAME> and <AI NAME>. Write a single reply only.
187
+
188
+ ### Chat History:
189
+ <AI NAME>: Good day, <YOUR NAME>! How can I assist you today?
190
+ (Etc, etc)
191
+
192
+ ### Response:
193
+ <AI NAME>:
194
+ ```