TheBloke commited on
Commit
353b66b
1 Parent(s): 734ca59

Initial GGML model commit

Browse files
Files changed (1) hide show
  1. README.md +183 -0
README.md ADDED
@@ -0,0 +1,183 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ inference: false
3
+ language:
4
+ - en
5
+ license: other
6
+ model_creator: Gryphe
7
+ model_link: https://huggingface.co/Gryphe/MythoLogic-L2-13b
8
+ model_name: Mythologic L2 13B
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 L2 13B - GGML
28
+ - Model creator: [Gryphe](https://huggingface.co/Gryphe)
29
+ - Original model: [Mythologic L2 13B](https://huggingface.co/Gryphe/MythoLogic-L2-13b)
30
+
31
+ ## Description
32
+
33
+ This repo contains GGML format model files for [Gryphe's Mythologic L2 13B](https://huggingface.co/Gryphe/MythoLogic-L2-13b).
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-L2-13B-GPTQ)
46
+ * [2, 3, 4, 5, 6 and 8-bit GGML models for CPU+GPU inference](https://huggingface.co/TheBloke/MythoLogic-L2-13B-GGML)
47
+ * [Gryphe's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/Gryphe/MythoLogic-L2-13b)
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:
55
+ {prompt}
56
+
57
+ ### Response:
58
+ ```
59
+
60
+ <!-- compatibility_ggml start -->
61
+ ## Compatibility
62
+
63
+ These quantised GGML files are compatible with llama.cpp as of June 6th, commit `2d43387`.
64
+
65
+ They should also be compatible with all UIs, libraries and utilities which use GGML.
66
+
67
+ ## Explanation of the new k-quant methods
68
+ <details>
69
+ <summary>Click to see details</summary>
70
+
71
+ The new methods available are:
72
+ * 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)
73
+ * 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.
74
+ * 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.
75
+ * GGML_TYPE_Q5_K - "type-1" 5-bit quantization. Same super-block structure as GGML_TYPE_Q4_K resulting in 5.5 bpw
76
+ * 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
77
+ * 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.
78
+
79
+ Refer to the Provided Files table below to see what files use which methods, and how.
80
+ </details>
81
+ <!-- compatibility_ggml end -->
82
+
83
+ ## Provided files
84
+
85
+ | Name | Quant method | Bits | Size | Max RAM required | Use case |
86
+ | ---- | ---- | ---- | ---- | ---- | ----- |
87
+ | [mythologic-l2-13b.ggmlv3.q2_K.bin](https://huggingface.co/TheBloke/MythoLogic-L2-13B-GGML/blob/main/mythologic-l2-13b.ggmlv3.q2_K.bin) | q2_K | 2 | 5.51 GB| 8.01 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. |
88
+ | [mythologic-l2-13b.ggmlv3.q3_K_L.bin](https://huggingface.co/TheBloke/MythoLogic-L2-13B-GGML/blob/main/mythologic-l2-13b.ggmlv3.q3_K_L.bin) | q3_K_L | 3 | 6.93 GB| 9.43 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 |
89
+ | [mythologic-l2-13b.ggmlv3.q3_K_M.bin](https://huggingface.co/TheBloke/MythoLogic-L2-13B-GGML/blob/main/mythologic-l2-13b.ggmlv3.q3_K_M.bin) | q3_K_M | 3 | 6.31 GB| 8.81 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 |
90
+ | [mythologic-l2-13b.ggmlv3.q3_K_S.bin](https://huggingface.co/TheBloke/MythoLogic-L2-13B-GGML/blob/main/mythologic-l2-13b.ggmlv3.q3_K_S.bin) | q3_K_S | 3 | 5.66 GB| 8.16 GB | New k-quant method. Uses GGML_TYPE_Q3_K for all tensors |
91
+ | [mythologic-l2-13b.ggmlv3.q4_0.bin](https://huggingface.co/TheBloke/MythoLogic-L2-13B-GGML/blob/main/mythologic-l2-13b.ggmlv3.q4_0.bin) | q4_0 | 4 | 7.37 GB| 9.87 GB | Original quant method, 4-bit. |
92
+ | [mythologic-l2-13b.ggmlv3.q4_1.bin](https://huggingface.co/TheBloke/MythoLogic-L2-13B-GGML/blob/main/mythologic-l2-13b.ggmlv3.q4_1.bin) | q4_1 | 4 | 8.17 GB| 10.67 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. |
93
+ | [mythologic-l2-13b.ggmlv3.q4_K_M.bin](https://huggingface.co/TheBloke/MythoLogic-L2-13B-GGML/blob/main/mythologic-l2-13b.ggmlv3.q4_K_M.bin) | q4_K_M | 4 | 7.87 GB| 10.37 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 |
94
+ | [mythologic-l2-13b.ggmlv3.q4_K_S.bin](https://huggingface.co/TheBloke/MythoLogic-L2-13B-GGML/blob/main/mythologic-l2-13b.ggmlv3.q4_K_S.bin) | q4_K_S | 4 | 7.37 GB| 9.87 GB | New k-quant method. Uses GGML_TYPE_Q4_K for all tensors |
95
+ | [mythologic-l2-13b.ggmlv3.q5_0.bin](https://huggingface.co/TheBloke/MythoLogic-L2-13B-GGML/blob/main/mythologic-l2-13b.ggmlv3.q5_0.bin) | q5_0 | 5 | 8.97 GB| 11.47 GB | Original quant method, 5-bit. Higher accuracy, higher resource usage and slower inference. |
96
+ | [mythologic-l2-13b.ggmlv3.q5_1.bin](https://huggingface.co/TheBloke/MythoLogic-L2-13B-GGML/blob/main/mythologic-l2-13b.ggmlv3.q5_1.bin) | q5_1 | 5 | 9.78 GB| 12.28 GB | Original quant method, 5-bit. Even higher accuracy, resource usage and slower inference. |
97
+ | [mythologic-l2-13b.ggmlv3.q5_K_M.bin](https://huggingface.co/TheBloke/MythoLogic-L2-13B-GGML/blob/main/mythologic-l2-13b.ggmlv3.q5_K_M.bin) | q5_K_M | 5 | 9.23 GB| 11.73 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 |
98
+ | [mythologic-l2-13b.ggmlv3.q5_K_S.bin](https://huggingface.co/TheBloke/MythoLogic-L2-13B-GGML/blob/main/mythologic-l2-13b.ggmlv3.q5_K_S.bin) | q5_K_S | 5 | 8.97 GB| 11.47 GB | New k-quant method. Uses GGML_TYPE_Q5_K for all tensors |
99
+ | [mythologic-l2-13b.ggmlv3.q6_K.bin](https://huggingface.co/TheBloke/MythoLogic-L2-13B-GGML/blob/main/mythologic-l2-13b.ggmlv3.q6_K.bin) | q6_K | 6 | 10.68 GB| 13.18 GB | New k-quant method. Uses GGML_TYPE_Q8_K for all tensors - 6-bit quantization |
100
+ | [mythologic-l2-13b.ggmlv3.q8_0.bin](https://huggingface.co/TheBloke/MythoLogic-L2-13B-GGML/blob/main/mythologic-l2-13b.ggmlv3.q8_0.bin) | q8_0 | 8 | 13.79 GB| 16.29 GB | Original quant method, 8-bit. Almost indistinguishable from float16. High resource use and slow. Not recommended for most users. |
101
+
102
+ **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.
103
+
104
+ ## How to run in `llama.cpp`
105
+
106
+ I use the following command line; adjust for your tastes and needs:
107
+
108
+ ```
109
+ ./main -t 10 -ngl 32 -m mythologic-l2-13b.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:"
110
+ ```
111
+ 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`.
112
+
113
+ Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
114
+
115
+ Change `-c 2048` to the desired sequence length for this model. For example, `-c 4096` for a Llama 2 model. For models that use RoPE, add `--rope-freq-base 10000 --rope-freq-scale 0.5` for doubled context, or `--rope-freq-base 10000 --rope-freq-scale 0.25` for 4x context.
116
+
117
+ If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
118
+
119
+ For other parameters and how to use them, please refer to [the llama.cpp documentation](https://github.com/ggerganov/llama.cpp/blob/master/examples/main/README.md)
120
+
121
+ ## How to run in `text-generation-webui`
122
+
123
+ 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).
124
+
125
+ <!-- footer start -->
126
+ ## Discord
127
+
128
+ For further support, and discussions on these models and AI in general, join us at:
129
+
130
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
131
+
132
+ ## Thanks, and how to contribute.
133
+
134
+ Thanks to the [chirper.ai](https://chirper.ai) team!
135
+
136
+ 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.
137
+
138
+ 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.
139
+
140
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
141
+
142
+ * Patreon: https://patreon.com/TheBlokeAI
143
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
144
+
145
+ **Special thanks to**: Luke from CarbonQuill, Aemon Algiz.
146
+
147
+ **Patreon special mentions**: Willem Michiel, Ajan Kanaga, Cory Kujawski, Alps Aficionado, Nikolai Manek, Jonathan Leane, Stanislav Ovsiannikov, Michael Levine, Luke Pendergrass, Sid, K, Gabriel Tamborski, Clay Pascal, Kalila, William Sang, Will Dee, Pieter, Nathan LeClaire, ya boyyy, David Flickinger, vamX, Derek Yates, Fen Risland, Jeffrey Morgan, webtim, Daniel P. Andersen, Chadd, Edmond Seymore, Pyrater, Olusegun Samson, Lone Striker, biorpg, alfie_i, Mano Prime, Chris Smitley, Dave, zynix, Trenton Dambrowitz, Johann-Peter Hartmann, Magnesian, Spencer Kim, John Detwiler, Iucharbius, Gabriel Puliatti, LangChain4j, Luke @flexchar, Vadim, Rishabh Srivastava, Preetika Verma, Ai Maven, Femi Adebogun, WelcomeToTheClub, Leonard Tan, Imad Khwaja, Steven Wood, Stefan Sabev, Sebastain Graf, usrbinkat, Dan Guido, Sam, Eugene Pentland, Mandus, transmissions 11, Slarti, Karl Bernard, Spiking Neurons AB, Artur Olbinski, Joseph William Delisle, ReadyPlayerEmma, Olakabola, Asp the Wyvern, Space Cruiser, Matthew Berman, Randy H, subjectnull, danny, John Villwock, Illia Dulskyi, Rainer Wilmers, theTransient, Pierre Kircher, Alexandros Triantafyllidis, Viktor Bowallius, terasurfer, Deep Realms, SuperWojo, senxiiz, Oscar Rangel, Alex, Stephen Murray, Talal Aujan, Raven Klaugh, Sean Connelly, Raymond Fosdick, Fred von Graf, chris gileta, Junyu Yang, Elle
148
+
149
+
150
+ Thank you to all my generous patrons and donaters!
151
+
152
+ <!-- footer end -->
153
+
154
+ # Original model card: Gryphe's Mythologic L2 13B
155
+
156
+ The Llama 2 sequel to my [original experiment](https://huggingface.co/Gryphe/MythoLogic-13b) with gradient merges using [the following script](https://github.com/Gryphe/BlockMerge_Gradient). Its three models ([Hermes](https://huggingface.co/NousResearch/Nous-Hermes-Llama2-13b), [Chronos](https://huggingface.co/elinas/chronos-13b-v2) and [Airoboros](https://huggingface.co/jondurbin/airoboros-l2-13b-gpt4-2.0)) are almost evenly divided over the layer structure this time. Airoboros was the "wildcard model" due to its superior ability to understand complex instructions.
157
+
158
+ Quantized models are available from TheBloke: [GGML](https://huggingface.co/TheBloke/MythoLogic-L2-13B-GGML) - [GPTQ](https://huggingface.co/TheBloke/MythoLogic-L2-13B-GPTQ) (You're the best!)
159
+
160
+ ## Model details
161
+
162
+ As before, the main objective was to create an all-round model with improved roleplaying capabilities. MythoLogic-L2 differs from its predecessor in that it focuses primarily on the understanding of instructions and personalities of complex character cards.
163
+
164
+ Illustrated below are the gradients used for this specific L2 recipe, with the top of the image representing layer 0 and the bottom layer 40.
165
+
166
+ ![](MythoLogic-L2.png)
167
+
168
+ ## Prompt Format
169
+
170
+ This model primarily uses (and was heavily tested with) Alpaca formatting, so for optimal model performance, use:
171
+ ```
172
+ <System prompt/Character Card>
173
+
174
+ ### Instruction:
175
+ Your instruction or question here.
176
+ For roleplay purposes, I suggest the following - Write <CHAR NAME>'s next reply in a chat between <YOUR NAME> and <CHAR NAME>. Write a single reply only.
177
+
178
+ ### Response:
179
+ ```
180
+
181
+ ---
182
+ license: other
183
+ ---