TheBloke commited on
Commit
74d2346
1 Parent(s): d6984bb

Initial GGML model commit

Browse files
Files changed (1) hide show
  1. README.md +199 -0
README.md ADDED
@@ -0,0 +1,199 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ inference: false
3
+ license: llama2
4
+ model_creator: Zaraki Quem Parte
5
+ model_link: https://huggingface.co/zarakiquemparte/zarablend-l2-7b
6
+ model_name: Zarablend L2 7B
7
+ model_type: llama
8
+ quantized_by: TheBloke
9
+ tags:
10
+ - llama2
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
+ # Zarablend L2 7B - GGML
28
+ - Model creator: [Zaraki Quem Parte](https://huggingface.co/zarakiquemparte)
29
+ - Original model: [Zarablend L2 7B](https://huggingface.co/zarakiquemparte/zarablend-l2-7b)
30
+
31
+ ## Description
32
+
33
+ This repo contains GGML format model files for [Zaraki Quem Parte's Zarablend L2 7B](https://huggingface.co/zarakiquemparte/zarablend-l2-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/Zarablend-L2-7B-GPTQ)
46
+ * [2, 3, 4, 5, 6 and 8-bit GGML models for CPU+GPU inference](https://huggingface.co/TheBloke/Zarablend-L2-7B-GGML)
47
+ * [Zaraki Quem Parte's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/zarakiquemparte/zarablend-l2-7b)
48
+
49
+ ## Prompt template: Alpaca-InstructOnly
50
+
51
+ ```
52
+ ### Instruction:
53
+
54
+ {prompt}
55
+
56
+ ### Response:
57
+ ```
58
+
59
+ <!-- compatibility_ggml start -->
60
+ ## Compatibility
61
+
62
+ These quantised GGML files are compatible with llama.cpp as of June 6th, commit `2d43387`.
63
+
64
+ They should also be compatible with all UIs, libraries and utilities which use GGML.
65
+
66
+ ## Explanation of the new k-quant methods
67
+ <details>
68
+ <summary>Click to see details</summary>
69
+
70
+ The new methods available are:
71
+ * 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)
72
+ * 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.
73
+ * 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.
74
+ * GGML_TYPE_Q5_K - "type-1" 5-bit quantization. Same super-block structure as GGML_TYPE_Q4_K resulting in 5.5 bpw
75
+ * 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
76
+ * 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.
77
+
78
+ Refer to the Provided Files table below to see what files use which methods, and how.
79
+ </details>
80
+ <!-- compatibility_ggml end -->
81
+
82
+ ## Provided files
83
+
84
+ | Name | Quant method | Bits | Size | Max RAM required | Use case |
85
+ | ---- | ---- | ---- | ---- | ---- | ----- |
86
+ | [zarablend-l2-7b.ggmlv3.q2_K.bin](https://huggingface.co/TheBloke/Zarablend-L2-7B-GGML/blob/main/zarablend-l2-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. |
87
+ | [zarablend-l2-7b.ggmlv3.q3_K_L.bin](https://huggingface.co/TheBloke/Zarablend-L2-7B-GGML/blob/main/zarablend-l2-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 |
88
+ | [zarablend-l2-7b.ggmlv3.q3_K_M.bin](https://huggingface.co/TheBloke/Zarablend-L2-7B-GGML/blob/main/zarablend-l2-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 |
89
+ | [zarablend-l2-7b.ggmlv3.q3_K_S.bin](https://huggingface.co/TheBloke/Zarablend-L2-7B-GGML/blob/main/zarablend-l2-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 |
90
+ | [zarablend-l2-7b.ggmlv3.q4_0.bin](https://huggingface.co/TheBloke/Zarablend-L2-7B-GGML/blob/main/zarablend-l2-7b.ggmlv3.q4_0.bin) | q4_0 | 4 | 3.83 GB| 6.33 GB | Original quant method, 4-bit. |
91
+ | [zarablend-l2-7b.ggmlv3.q4_1.bin](https://huggingface.co/TheBloke/Zarablend-L2-7B-GGML/blob/main/zarablend-l2-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. |
92
+ | [zarablend-l2-7b.ggmlv3.q4_K_M.bin](https://huggingface.co/TheBloke/Zarablend-L2-7B-GGML/blob/main/zarablend-l2-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 |
93
+ | [zarablend-l2-7b.ggmlv3.q4_K_S.bin](https://huggingface.co/TheBloke/Zarablend-L2-7B-GGML/blob/main/zarablend-l2-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 |
94
+ | [zarablend-l2-7b.ggmlv3.q5_0.bin](https://huggingface.co/TheBloke/Zarablend-L2-7B-GGML/blob/main/zarablend-l2-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. |
95
+ | [zarablend-l2-7b.ggmlv3.q5_1.bin](https://huggingface.co/TheBloke/Zarablend-L2-7B-GGML/blob/main/zarablend-l2-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. |
96
+ | [zarablend-l2-7b.ggmlv3.q5_K_M.bin](https://huggingface.co/TheBloke/Zarablend-L2-7B-GGML/blob/main/zarablend-l2-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 |
97
+ | [zarablend-l2-7b.ggmlv3.q5_K_S.bin](https://huggingface.co/TheBloke/Zarablend-L2-7B-GGML/blob/main/zarablend-l2-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 |
98
+ | [zarablend-l2-7b.ggmlv3.q6_K.bin](https://huggingface.co/TheBloke/Zarablend-L2-7B-GGML/blob/main/zarablend-l2-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 |
99
+ | [zarablend-l2-7b.ggmlv3.q8_0.bin](https://huggingface.co/TheBloke/Zarablend-L2-7B-GGML/blob/main/zarablend-l2-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. |
100
+
101
+ **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.
102
+
103
+ ## How to run in `llama.cpp`
104
+
105
+ I use the following command line; adjust for your tastes and needs:
106
+
107
+ ```
108
+ ./main -t 10 -ngl 32 -m zarablend-l2-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:"
109
+ ```
110
+ 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`.
111
+
112
+ Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
113
+
114
+ 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.
115
+
116
+ If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
117
+
118
+ 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)
119
+
120
+ ## How to run in `text-generation-webui`
121
+
122
+ Further instructions here: [text-generation-webui/docs/llama.cpp.md](https://github.com/oobabooga/text-generation-webui/blob/main/docs/llama.cpp.md).
123
+
124
+ <!-- footer start -->
125
+ ## Discord
126
+
127
+ For further support, and discussions on these models and AI in general, join us at:
128
+
129
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
130
+
131
+ ## Thanks, and how to contribute.
132
+
133
+ Thanks to the [chirper.ai](https://chirper.ai) team!
134
+
135
+ 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.
136
+
137
+ 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.
138
+
139
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
140
+
141
+ * Patreon: https://patreon.com/TheBlokeAI
142
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
143
+
144
+ **Special thanks to**: Aemon Algiz.
145
+
146
+ **Patreon special mentions**: Ajan Kanaga, David Ziegler, Raymond Fosdick, SuperWojo, Sam, webtim, Steven Wood, knownsqashed, Tony Hughes, Junyu Yang, J, Olakabola, Dan Guido, Stephen Murray, John Villwock, vamX, William Sang, Sean Connelly, LangChain4j, Olusegun Samson, Fen Risland, Derek Yates, Karl Bernard, transmissions 11, Trenton Dambrowitz, Pieter, Preetika Verma, Swaroop Kallakuri, Andrey, Slarti, Jonathan Leane, Michael Levine, Kalila, Joseph William Delisle, Rishabh Srivastava, Deo Leter, Luke Pendergrass, Spencer Kim, Geoffrey Montalvo, Thomas Belote, Jeffrey Morgan, Mandus, ya boyyy, Matthew Berman, Magnesian, Ai Maven, senxiiz, Alps Aficionado, Luke @flexchar, Raven Klaugh, Imad Khwaja, Gabriel Puliatti, Johann-Peter Hartmann, usrbinkat, Spiking Neurons AB, Artur Olbinski, chris gileta, danny, Willem Michiel, WelcomeToTheClub, Deep Realms, alfie_i, Dave, Leonard Tan, NimbleBox.ai, Randy H, Daniel P. Andersen, Pyrater, Will Dee, Elle, Space Cruiser, Gabriel Tamborski, Asp the Wyvern, Illia Dulskyi, Nikolai Manek, Sid, Brandon Frisco, Nathan LeClaire, Edmond Seymore, Enrico Ros, Pedro Madruga, Eugene Pentland, John Detwiler, Mano Prime, Stanislav Ovsiannikov, Alex, Vitor Caleffi, K, biorpg, Michael Davis, Lone Striker, Pierre Kircher, theTransient, Fred von Graf, Sebastain Graf, Vadim, Iucharbius, Clay Pascal, Chadd, Mesiah Bishop, terasurfer, Rainer Wilmers, Alexandros Triantafyllidis, Stefan Sabev, Talal Aujan, Cory Kujawski, Viktor Bowallius, subjectnull, ReadyPlayerEmma, zynix
147
+
148
+
149
+ Thank you to all my generous patrons and donaters!
150
+
151
+ <!-- footer end -->
152
+
153
+ # Original model card: Zaraki Quem Parte's Zarablend L2 7B
154
+
155
+ # Model Card: Zarablend L2 7b
156
+ This model uses [Nous Hermes Llama2 7b](https://huggingface.co/NousResearch/Nous-Hermes-llama-2-7b) (66%) as a base with [Airoboros L2 7B GPT4 2.0](https://huggingface.co/jondurbin/airoboros-l2-7b-gpt4-2.0) (34%) and the result of this merge was merged with [LimaRP LLama2 7B Lora](https://huggingface.co/lemonilia/limarp-llama2).
157
+
158
+ This merge of models(hermes and airoboros) was done with this [script](https://github.com/zarakiquemparte/zaraki-tools/blob/main/merge-cli.py)
159
+
160
+ This merge of Lora with Model was done with this [script](https://github.com/zarakiquemparte/zaraki-tools/blob/main/apply-lora.py)
161
+
162
+ Merge illustration:
163
+
164
+ ![illustration](zarablend-merge-illustration.png)
165
+
166
+ ## Usage:
167
+
168
+ Since this is a merge between Nous Hermes, Airoboros and LimaRP, the following instruction formats should work:
169
+
170
+ Alpaca 2:
171
+
172
+ ```
173
+ ### Instruction:
174
+ <prompt>
175
+
176
+ ### Response:
177
+ <leave a newline blank for model to respond>
178
+ ```
179
+
180
+ LimaRP instruction format:
181
+
182
+ ```
183
+ <<SYSTEM>>
184
+ <character card and system prompt>
185
+
186
+ <<USER>>
187
+ <prompt>
188
+
189
+ <<AIBOT>>
190
+ <leave a newline blank for model to respond>
191
+ ```
192
+
193
+ ## Bias, Risks, and Limitations
194
+
195
+ This model is not intended for supplying factual information or advice in any form
196
+
197
+ ## Training Details
198
+
199
+ This model is merged and can be reproduced using the tools mentioned above. Please refer to all provided links for extra model-specific details.