TheBloke commited on
Commit
0a2ccfa
1 Parent(s): 9965ef5

Initial GGML model commit

Browse files
Files changed (1) hide show
  1. README.md +188 -0
README.md ADDED
@@ -0,0 +1,188 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ inference: false
3
+ license: other
4
+ model_creator: elinas
5
+ model_link: https://huggingface.co/elinas/chronos-13b-v2
6
+ model_name: Chronos 13B v2
7
+ model_type: llama
8
+ quantized_by: TheBloke
9
+ tags:
10
+ - llama
11
+ - pytorch
12
+ - chatbot
13
+ - storywriting
14
+ - generalist-model
15
+ ---
16
+
17
+ <!-- header start -->
18
+ <div style="width: 100%;">
19
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
20
+ </div>
21
+ <div style="display: flex; justify-content: space-between; width: 100%;">
22
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
23
+ <p><a href="https://discord.gg/theblokeai">Chat & support: my new Discord server</a></p>
24
+ </div>
25
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
26
+ <p><a href="https://www.patreon.com/TheBlokeAI">Want to contribute? TheBloke's Patreon page</a></p>
27
+ </div>
28
+ </div>
29
+ <!-- header end -->
30
+
31
+ # Chronos 13B v2 - GGML
32
+ - Model creator: [elinas](https://huggingface.co/elinas)
33
+ - Original model: [Chronos 13B v2](https://huggingface.co/elinas/chronos-13b-v2)
34
+
35
+ ## Description
36
+
37
+ This repo contains GGML format model files for [elinas's Chronos 13B v2](https://huggingface.co/elinas/chronos-13b-v2).
38
+
39
+ 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:
40
+ * [text-generation-webui](https://github.com/oobabooga/text-generation-webui), the most popular web UI. Supports NVidia CUDA GPU acceleration.
41
+ * [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.
42
+ * [LM Studio](https://lmstudio.ai/), a fully featured local GUI with GPU acceleration on both Windows (NVidia and AMD), and macOS.
43
+ * [LoLLMS Web UI](https://github.com/ParisNeo/lollms-webui), a great web UI with CUDA GPU acceleration via the c_transformers backend.
44
+ * [ctransformers](https://github.com/marella/ctransformers), a Python library with GPU accel, LangChain support, and OpenAI-compatible AI server.
45
+ * [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
46
+
47
+ ## Repositories available
48
+
49
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/elinas/chronos-13b-v2-GPTQ)
50
+ * [2, 3, 4, 5, 6 and 8-bit GGML models for CPU+GPU inference](https://huggingface.co/TheBloke/Chronos-13B-v2-GGML)
51
+ * [elinas's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/elinas/chronos-13b-v2)
52
+
53
+ ## Prompt template: Alpaca
54
+
55
+ ```
56
+ Below is an instruction that describes a task. Write a response that appropriately completes the request.
57
+
58
+ ### Instruction:
59
+ {prompt}
60
+
61
+ ### Response:
62
+ ```
63
+
64
+ <!-- compatibility_ggml start -->
65
+ ## Compatibility
66
+
67
+ ### Original llama.cpp quant methods: `q4_0, q4_1, q5_0, q5_1, q8_0`
68
+
69
+ 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.
70
+
71
+ ### 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`
72
+
73
+ These new quantisation methods are compatible with llama.cpp as of June 6th, commit `2d43387`.
74
+
75
+ 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.
76
+
77
+ ## Explanation of the new k-quant methods
78
+ <details>
79
+ <summary>Click to see details</summary>
80
+
81
+ The new methods available are:
82
+ * 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)
83
+ * 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.
84
+ * 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.
85
+ * GGML_TYPE_Q5_K - "type-1" 5-bit quantization. Same super-block structure as GGML_TYPE_Q4_K resulting in 5.5 bpw
86
+ * 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
87
+ * 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.
88
+
89
+ Refer to the Provided Files table below to see what files use which methods, and how.
90
+ </details>
91
+ <!-- compatibility_ggml end -->
92
+
93
+ ## Provided files
94
+
95
+ | Name | Quant method | Bits | Size | Max RAM required | Use case |
96
+ | ---- | ---- | ---- | ---- | ---- | ----- |
97
+ | [chronos-13b-v2.ggmlv3.q2_K.bin](https://huggingface.co/TheBloke/Chronos-13B-v2-GGML/blob/main/chronos-13b-v2.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. |
98
+ | [chronos-13b-v2.ggmlv3.q3_K_L.bin](https://huggingface.co/TheBloke/Chronos-13B-v2-GGML/blob/main/chronos-13b-v2.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 |
99
+ | [chronos-13b-v2.ggmlv3.q3_K_M.bin](https://huggingface.co/TheBloke/Chronos-13B-v2-GGML/blob/main/chronos-13b-v2.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 |
100
+ | [chronos-13b-v2.ggmlv3.q3_K_S.bin](https://huggingface.co/TheBloke/Chronos-13B-v2-GGML/blob/main/chronos-13b-v2.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 |
101
+ | [chronos-13b-v2.ggmlv3.q4_0.bin](https://huggingface.co/TheBloke/Chronos-13B-v2-GGML/blob/main/chronos-13b-v2.ggmlv3.q4_0.bin) | q4_0 | 4 | 7.37 GB| 9.87 GB | Original quant method, 4-bit. |
102
+ | [chronos-13b-v2.ggmlv3.q4_1.bin](https://huggingface.co/TheBloke/Chronos-13B-v2-GGML/blob/main/chronos-13b-v2.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. |
103
+ | [chronos-13b-v2.ggmlv3.q4_K_M.bin](https://huggingface.co/TheBloke/Chronos-13B-v2-GGML/blob/main/chronos-13b-v2.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 |
104
+ | [chronos-13b-v2.ggmlv3.q4_K_S.bin](https://huggingface.co/TheBloke/Chronos-13B-v2-GGML/blob/main/chronos-13b-v2.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 |
105
+ | [chronos-13b-v2.ggmlv3.q5_0.bin](https://huggingface.co/TheBloke/Chronos-13B-v2-GGML/blob/main/chronos-13b-v2.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. |
106
+ | [chronos-13b-v2.ggmlv3.q5_1.bin](https://huggingface.co/TheBloke/Chronos-13B-v2-GGML/blob/main/chronos-13b-v2.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. |
107
+ | [chronos-13b-v2.ggmlv3.q5_K_M.bin](https://huggingface.co/TheBloke/Chronos-13B-v2-GGML/blob/main/chronos-13b-v2.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 |
108
+ | [chronos-13b-v2.ggmlv3.q5_K_S.bin](https://huggingface.co/TheBloke/Chronos-13B-v2-GGML/blob/main/chronos-13b-v2.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 |
109
+ | [chronos-13b-v2.ggmlv3.q6_K.bin](https://huggingface.co/TheBloke/Chronos-13B-v2-GGML/blob/main/chronos-13b-v2.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 |
110
+ | [chronos-13b-v2.ggmlv3.q8_0.bin](https://huggingface.co/TheBloke/Chronos-13B-v2-GGML/blob/main/chronos-13b-v2.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. |
111
+
112
+ **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.
113
+
114
+ ## How to run in `llama.cpp`
115
+
116
+ I use the following command line; adjust for your tastes and needs:
117
+
118
+ ```
119
+ ./main -t 10 -ngl 32 -m chronos-13b-v2.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:"
120
+ ```
121
+ 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`.
122
+
123
+ Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
124
+
125
+ If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
126
+
127
+ ## How to run in `text-generation-webui`
128
+
129
+ 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).
130
+
131
+ <!-- footer start -->
132
+ ## Discord
133
+
134
+ For further support, and discussions on these models and AI in general, join us at:
135
+
136
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
137
+
138
+ ## Thanks, and how to contribute.
139
+
140
+ Thanks to the [chirper.ai](https://chirper.ai) team!
141
+
142
+ 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.
143
+
144
+ 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.
145
+
146
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
147
+
148
+ * Patreon: https://patreon.com/TheBlokeAI
149
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
150
+
151
+ **Special thanks to**: Luke from CarbonQuill, Aemon Algiz.
152
+
153
+ **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
154
+
155
+
156
+ Thank you to all my generous patrons and donaters!
157
+
158
+ <!-- footer end -->
159
+
160
+ # Original model card: elinas's Chronos 13B v2
161
+
162
+
163
+ # chronos-13b-v2
164
+
165
+ This is the FP16 PyTorch / HF version of **chronos-13b-v2** based on the **LLaMA v2 Base** model.
166
+
167
+ Only use this version for further quantization or if you would like to run in full precision, as long as you have the VRAM required.
168
+
169
+ This model is primarily focused on chat, roleplay, storywriting, with good reasoning and logic.
170
+
171
+ Chronos can generate very long outputs with coherent text, largely due to the human inputs it was trained on, and it supports context length up to 4096 tokens.
172
+
173
+ This model uses Alpaca formatting, so for optimal model performance, use it to start the dialogue or story, and if you use a frontend like SillyTavern ENABLE instruction mode:
174
+ ```
175
+ ### Instruction:
176
+ Your instruction or question here.
177
+ ### Response:
178
+ ```
179
+ Not using the format will make the model perform significantly worse than intended.
180
+
181
+ ## Other Versions
182
+ [4bit GPTQ Quantized version](https://huggingface.co/elinas/chronos-13b-v2-GPTQ)
183
+
184
+ [GGML Versions provided by @TheBloke](https://huggingface.co/TheBloke/Chronos-13B-v2-GGML)
185
+
186
+ <!--**Support My Development of New Models**
187
+ <a href='https://ko-fi.com/Q5Q6MB734' target='_blank'><img height='36' style='border:0px;height:36px;'
188
+ src='https://storage.ko-fi.com/cdn/kofi1.png?v=3' border='0' alt='Support Development' /></a>-->