TheBloke commited on
Commit
1eaec83
1 Parent(s): a0d940d

Initial GGML model commit

Browse files
Files changed (1) hide show
  1. README.md +225 -0
README.md ADDED
@@ -0,0 +1,225 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ inference: false
3
+ language:
4
+ - en
5
+ license: llama2
6
+ model_creator: Sao10K
7
+ model_link: https://huggingface.co/Sao10K/Stheno-L2-13B
8
+ model_name: Stheno L2 13B
9
+ model_type: llama
10
+ quantized_by: TheBloke
11
+ ---
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
+ # Stheno L2 13B - GGML
31
+ - Model creator: [Sao10K](https://huggingface.co/Sao10K)
32
+ - Original model: [Stheno L2 13B](https://huggingface.co/Sao10K/Stheno-L2-13B)
33
+
34
+ ## Description
35
+
36
+ This repo contains GGML format model files for [Sao10K's Stheno L2 13B](https://huggingface.co/Sao10K/Stheno-L2-13B).
37
+
38
+ ### Important note regarding GGML files.
39
+
40
+ The GGML format has now been superseded by GGUF. As of August 21st 2023, [llama.cpp](https://github.com/ggerganov/llama.cpp) no longer supports GGML models. Third party clients and libraries are expected to still support it for a time, but many may also drop support.
41
+
42
+ Please use the GGUF models instead.
43
+ ### About GGML
44
+
45
+ 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:
46
+ * [text-generation-webui](https://github.com/oobabooga/text-generation-webui), the most popular web UI. Supports NVidia CUDA GPU acceleration.
47
+ * [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.
48
+ * [LM Studio](https://lmstudio.ai/), a fully featured local GUI with GPU acceleration on both Windows (NVidia and AMD), and macOS.
49
+ * [LoLLMS Web UI](https://github.com/ParisNeo/lollms-webui), a great web UI with CUDA GPU acceleration via the c_transformers backend.
50
+ * [ctransformers](https://github.com/marella/ctransformers), a Python library with GPU accel, LangChain support, and OpenAI-compatible AI server.
51
+ * [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
52
+
53
+ ## Repositories available
54
+
55
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/Stheno-L2-13B-GPTQ)
56
+ * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/Stheno-L2-13B-GGUF)
57
+ * [2, 3, 4, 5, 6 and 8-bit GGML models for CPU+GPU inference (deprecated)](https://huggingface.co/TheBloke/Stheno-L2-13B-GGML)
58
+ * [Sao10K's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/Sao10K/Stheno-L2-13B)
59
+
60
+ ## Prompt template: Alpaca
61
+
62
+ ```
63
+ Below is an instruction that describes a task. Write a response that appropriately completes the request.
64
+
65
+ ### Instruction:
66
+ {prompt}
67
+
68
+ ### Response:
69
+
70
+ ```
71
+
72
+ <!-- compatibility_ggml start -->
73
+ ## Compatibility
74
+
75
+ These quantised GGML files are compatible with llama.cpp between June 6th (commit `2d43387`) and August 21st 2023.
76
+
77
+ For support with latest llama.cpp, please use GGUF files instead.
78
+
79
+ The final llama.cpp commit with support for GGML was: [dadbed99e65252d79f81101a392d0d6497b86caa](https://github.com/ggerganov/llama.cpp/commit/dadbed99e65252d79f81101a392d0d6497b86caa)
80
+
81
+ As of August 23rd 2023 they are still compatible with all UIs, libraries and utilities which use GGML. This may change in the future.
82
+
83
+ ## Explanation of the new k-quant methods
84
+ <details>
85
+ <summary>Click to see details</summary>
86
+
87
+ The new methods available are:
88
+ * 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)
89
+ * 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.
90
+ * 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.
91
+ * GGML_TYPE_Q5_K - "type-1" 5-bit quantization. Same super-block structure as GGML_TYPE_Q4_K resulting in 5.5 bpw
92
+ * 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
93
+ * 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.
94
+
95
+ Refer to the Provided Files table below to see what files use which methods, and how.
96
+ </details>
97
+ <!-- compatibility_ggml end -->
98
+
99
+ ## Provided files
100
+
101
+ | Name | Quant method | Bits | Size | Max RAM required | Use case |
102
+ | ---- | ---- | ---- | ---- | ---- | ----- |
103
+ | [stheno-l2-13b.ggmlv3.Q2_K.bin](https://huggingface.co/TheBloke/Stheno-L2-13B-GGML/blob/main/stheno-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. |
104
+ | [stheno-l2-13b.ggmlv3.Q3_K_S.bin](https://huggingface.co/TheBloke/Stheno-L2-13B-GGML/blob/main/stheno-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 |
105
+ | [stheno-l2-13b.ggmlv3.Q3_K_M.bin](https://huggingface.co/TheBloke/Stheno-L2-13B-GGML/blob/main/stheno-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 |
106
+ | [stheno-l2-13b.ggmlv3.Q3_K_L.bin](https://huggingface.co/TheBloke/Stheno-L2-13B-GGML/blob/main/stheno-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 |
107
+ | [stheno-l2-13b.ggmlv3.Q4_0.bin](https://huggingface.co/TheBloke/Stheno-L2-13B-GGML/blob/main/stheno-l2-13b.ggmlv3.Q4_0.bin) | Q4_0 | 4 | 7.37 GB| 9.87 GB | Original quant method, 4-bit. |
108
+ | [stheno-l2-13b.ggmlv3.Q4_K_S.bin](https://huggingface.co/TheBloke/Stheno-L2-13B-GGML/blob/main/stheno-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 |
109
+ | [stheno-l2-13b.ggmlv3.Q4_K_M.bin](https://huggingface.co/TheBloke/Stheno-L2-13B-GGML/blob/main/stheno-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 |
110
+ | [stheno-l2-13b.ggmlv3.Q4_1.bin](https://huggingface.co/TheBloke/Stheno-L2-13B-GGML/blob/main/stheno-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. |
111
+ | [stheno-l2-13b.ggmlv3.Q5_0.bin](https://huggingface.co/TheBloke/Stheno-L2-13B-GGML/blob/main/stheno-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. |
112
+ | [stheno-l2-13b.ggmlv3.Q5_K_S.bin](https://huggingface.co/TheBloke/Stheno-L2-13B-GGML/blob/main/stheno-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 |
113
+ | [stheno-l2-13b.ggmlv3.Q5_K_M.bin](https://huggingface.co/TheBloke/Stheno-L2-13B-GGML/blob/main/stheno-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 |
114
+ | [stheno-l2-13b.ggmlv3.Q5_1.bin](https://huggingface.co/TheBloke/Stheno-L2-13B-GGML/blob/main/stheno-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. |
115
+ | [stheno-l2-13b.ggmlv3.Q6_K.bin](https://huggingface.co/TheBloke/Stheno-L2-13B-GGML/blob/main/stheno-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 |
116
+ | [stheno-l2-13b.ggmlv3.Q8_0.bin](https://huggingface.co/TheBloke/Stheno-L2-13B-GGML/blob/main/stheno-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. |
117
+
118
+ **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.
119
+
120
+ ## How to run in `llama.cpp`
121
+
122
+ Make sure you are using `llama.cpp` from commit [dadbed99e65252d79f81101a392d0d6497b86caa](https://github.com/ggerganov/llama.cpp/commit/dadbed99e65252d79f81101a392d0d6497b86caa) or earlier.
123
+
124
+ For compatibility with latest llama.cpp, please use GGUF files instead.
125
+
126
+ ```
127
+ ./main -t 10 -ngl 32 -m stheno-l2-13b.ggmlv3.q4_K_M.bin --color -c 2048 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "Below is an instruction that describes a task. Write a response that appropriately completes the request.\n\n### Instruction:\nWrite a story about llamas\n\n### Response:"
128
+ ```
129
+ 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`.
130
+
131
+ Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
132
+
133
+ 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.
134
+
135
+ If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
136
+
137
+ 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)
138
+
139
+ ## How to run in `text-generation-webui`
140
+
141
+ Further instructions here: [text-generation-webui/docs/llama.cpp.md](https://github.com/oobabooga/text-generation-webui/blob/main/docs/llama.cpp.md).
142
+
143
+ <!-- footer start -->
144
+ <!-- 200823 -->
145
+ ## Discord
146
+
147
+ For further support, and discussions on these models and AI in general, join us at:
148
+
149
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
150
+
151
+ ## Thanks, and how to contribute.
152
+
153
+ Thanks to the [chirper.ai](https://chirper.ai) team!
154
+
155
+ 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.
156
+
157
+ 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.
158
+
159
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
160
+
161
+ * Patreon: https://patreon.com/TheBlokeAI
162
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
163
+
164
+ **Special thanks to**: Aemon Algiz.
165
+
166
+ **Patreon special mentions**: Kacper Wikieł, knownsqashed, Leonard Tan, Asp the Wyvern, Daniel P. Andersen, Luke Pendergrass, Stanislav Ovsiannikov, RoA, Dave, Ai Maven, Kalila, Will Dee, Imad Khwaja, Nitin Borwankar, Joseph William Delisle, Tony Hughes, Cory Kujawski, Rishabh Srivastava, Russ Johnson, Stephen Murray, Lone Striker, Johann-Peter Hartmann, Elle, J, Deep Realms, SuperWojo, Raven Klaugh, Sebastain Graf, ReadyPlayerEmma, Alps Aficionado, Mano Prime, Derek Yates, Gabriel Puliatti, Mesiah Bishop, Magnesian, Sean Connelly, biorpg, Iucharbius, Olakabola, Fen Risland, Space Cruiser, theTransient, Illia Dulskyi, Thomas Belote, Spencer Kim, Pieter, John Detwiler, Fred von Graf, Michael Davis, Swaroop Kallakuri, subjectnull, Clay Pascal, Subspace Studios, Chris Smitley, Enrico Ros, usrbinkat, Steven Wood, alfie_i, David Ziegler, Willem Michiel, Matthew Berman, Andrey, Pyrater, Jeffrey Morgan, vamX, LangChain4j, Luke @flexchar, Trenton Dambrowitz, Pierre Kircher, Alex, Sam, James Bentley, Edmond Seymore, Eugene Pentland, Pedro Madruga, Rainer Wilmers, Dan Guido, Nathan LeClaire, Spiking Neurons AB, Talal Aujan, zynix, Artur Olbinski, Michael Levine, 阿明, K, John Villwock, Nikolai Manek, Femi Adebogun, senxiiz, Deo Leter, NimbleBox.ai, Viktor Bowallius, Geoffrey Montalvo, Mandus, Ajan Kanaga, ya boyyy, Jonathan Leane, webtim, Brandon Frisco, danny, Alexandros Triantafyllidis, Gabriel Tamborski, Randy H, terasurfer, Vadim, Junyu Yang, Vitor Caleffi, Chadd, transmissions 11
167
+
168
+
169
+ Thank you to all my generous patrons and donaters!
170
+
171
+ And thank you again to a16z for their generous grant.
172
+
173
+ <!-- footer end -->
174
+
175
+ # Original model card: Sao10K's Stheno L2 13B
176
+
177
+
178
+ <img src="https://w.forfun.com/fetch/cb/cba2205390e517bea1ea60ca0b491af4.jpeg" style="width: 70%; min-width: 300px; display: block; margin: auto;">
179
+
180
+ An experimental merging of Several Models using two various methods, [Ties-Merge](https://github.com/cg123/ties-merge) and [BlockMerge_Gradient](https://github.com/Gryphe/BlockMerge_Gradient)
181
+
182
+ I plan for this to be the base of my Model with my own [Stheno: ERP-Based LORA] merged in, some time in the future.
183
+
184
+ Stheno:
185
+ <br>Gradient Merge of Stheno-P1 & Stheno-P2.
186
+
187
+ SISTER MODEL HERE: [Stheno-Inverted-L2-13B](https://huggingface.co/Sao10K/Stheno-Inverted-L2-13B)
188
+
189
+ Test Checklist:
190
+ <br>Censorship - Fairly Uncensored
191
+ <br>Writing - Good Prose, Fairly Descriptive
192
+ <br>NSFW - Yes
193
+ <br>IQ Level - Pretty Smart
194
+ <br>Formatting - Proper Formatting with Examples
195
+
196
+
197
+ Stheno-P1 [Ties-Merge]
198
+ <br>-----[elinas/chronos-13b-v2](https://huggingface.co/elinas/chronos-13b-v2)
199
+ <br>-----[jondurbin/airoboros-l2-13b-2.1](https://huggingface.co/jondurbin/airoboros-l2-13b-2.1)
200
+ <br>-----[NousResearch/Nous-Hermes-Llama2-13b](https://huggingface.co/NousResearch/Nous-Hermes-Llama2-13b)+[nRuaif/Kimiko-v2 **LORA**](https://huggingface.co/nRuaif/Kimiko-v2-13B)
201
+
202
+ Stheno-P2 [Ties-Merge]
203
+ <br>-----[CalderaAI/13B-Legerdemain-L2](https://huggingface.co/CalderaAI/13B-Legerdemain-L2)+[lemonilia/limarp-llama2-v2 **LORA**](https://huggingface.co/lemonilia/limarp-llama2-v2)
204
+ <br>-----[ehartford/WizardLM-1.0-Uncensored-Llama2-13b](https://huggingface.co/ehartford/WizardLM-1.0-Uncensored-Llama2-13b)
205
+ <br>-----[Henk717/spring-dragon](https://huggingface.co/Henk717/spring-dragon)
206
+
207
+ Most formats could work, but my tests have all been done in Alpaca format and it works well.
208
+ ```
209
+ ### Instruction:
210
+ Your instruction or question here.
211
+ 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.
212
+
213
+ ### Response:
214
+ ```
215
+
216
+ Below is the Illustration for the Final Merge:
217
+
218
+ ![ILLUSTRATION](https://cdn-uploads.huggingface.co/production/uploads/64be6a5376a6e2efccc638c1/z4D6eun_5ee-k5Bnf0a0j.png)
219
+
220
+ Once Again, thanks to [Chargoddard](https://huggingface.co/chargoddard) for his amazing and simple [ties-merge](https://github.com/cg123/ties-merge) script, and [Gryphe](https://huggingface.co/Gryphe) for their great [BlockMerge_Gradient](https://github.com/Gryphe/BlockMerge_Gradient) script.
221
+ Thanks to the original model creators too!
222
+
223
+ ```
224
+ Art by wada_kazu / わだかず (pixiv page private?)
225
+ ```