TheBloke commited on
Commit
0c678f4
1 Parent(s): cfb8d12

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: other
4
+ model_creator: lmsys
5
+ model_link: https://huggingface.co/lmsys/vicuna-13b-v1.5-16k
6
+ model_name: Vicuna 13B v1.5 16K
7
+ model_type: llama
8
+ quantized_by: TheBloke
9
+ ---
10
+
11
+ <!-- header start -->
12
+ <div style="width: 100%;">
13
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
14
+ </div>
15
+ <div style="display: flex; justify-content: space-between; width: 100%;">
16
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
17
+ <p><a href="https://discord.gg/theblokeai">Chat & support: my new Discord server</a></p>
18
+ </div>
19
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
20
+ <p><a href="https://www.patreon.com/TheBlokeAI">Want to contribute? TheBloke's Patreon page</a></p>
21
+ </div>
22
+ </div>
23
+ <!-- header end -->
24
+
25
+ # Vicuna 13B v1.5 16K - GGML
26
+ - Model creator: [lmsys](https://huggingface.co/lmsys)
27
+ - Original model: [Vicuna 13B v1.5 16K](https://huggingface.co/lmsys/vicuna-13b-v1.5-16k)
28
+
29
+ ## Description
30
+
31
+ This repo contains GGML format model files for [lmsys's Vicuna 13B v1.5 16K](https://huggingface.co/lmsys/vicuna-13b-v1.5-16k).
32
+
33
+ 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:
34
+ * [text-generation-webui](https://github.com/oobabooga/text-generation-webui), the most popular web UI. Supports NVidia CUDA GPU acceleration.
35
+ * [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.
36
+ * [LM Studio](https://lmstudio.ai/), a fully featured local GUI with GPU acceleration on both Windows (NVidia and AMD), and macOS.
37
+ * [LoLLMS Web UI](https://github.com/ParisNeo/lollms-webui), a great web UI with CUDA GPU acceleration via the c_transformers backend.
38
+ * [ctransformers](https://github.com/marella/ctransformers), a Python library with GPU accel, LangChain support, and OpenAI-compatible AI server.
39
+ * [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
40
+
41
+ ## Repositories available
42
+
43
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/vicuna-13B-v1.5-16K-GPTQ)
44
+ * [2, 3, 4, 5, 6 and 8-bit GGML models for CPU+GPU inference](https://huggingface.co/TheBloke/vicuna-13B-v1.5-16K-GGML)
45
+ * [lmsys's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/lmsys/vicuna-13b-v1.5-16k)
46
+
47
+ ## Prompt template: Vicuna
48
+
49
+ ```
50
+ A chat between a curious user and an artificial intelligence assistant. The assistant gives helpful, detailed, and polite answers to the user's questions.
51
+
52
+ USER: {prompt}
53
+ ASSISTANT:
54
+ ```
55
+
56
+ <!-- compatibility_ggml start -->
57
+ ## Compatibility
58
+
59
+ ### Original llama.cpp quant methods: `q4_0, q4_1, q5_0, q5_1, q8_0`
60
+
61
+ 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.
62
+
63
+ ### 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`
64
+
65
+ These new quantisation methods are compatible with llama.cpp as of June 6th, commit `2d43387`.
66
+
67
+ 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.
68
+
69
+ ## Explanation of the new k-quant methods
70
+ <details>
71
+ <summary>Click to see details</summary>
72
+
73
+ The new methods available are:
74
+ * 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)
75
+ * 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.
76
+ * 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.
77
+ * GGML_TYPE_Q5_K - "type-1" 5-bit quantization. Same super-block structure as GGML_TYPE_Q4_K resulting in 5.5 bpw
78
+ * 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
79
+ * 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.
80
+
81
+ Refer to the Provided Files table below to see what files use which methods, and how.
82
+ </details>
83
+ <!-- compatibility_ggml end -->
84
+
85
+ ## Provided files
86
+
87
+ | Name | Quant method | Bits | Size | Max RAM required | Use case |
88
+ | ---- | ---- | ---- | ---- | ---- | ----- |
89
+ | [vicuna-13b-v1.5-16k.ggmlv3.q2_K.bin](https://huggingface.co/TheBloke/vicuna-13B-v1.5-16K-GGML/blob/main/vicuna-13b-v1.5-16k.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. |
90
+ | [vicuna-13b-v1.5-16k.ggmlv3.q3_K_L.bin](https://huggingface.co/TheBloke/vicuna-13B-v1.5-16K-GGML/blob/main/vicuna-13b-v1.5-16k.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 |
91
+ | [vicuna-13b-v1.5-16k.ggmlv3.q3_K_M.bin](https://huggingface.co/TheBloke/vicuna-13B-v1.5-16K-GGML/blob/main/vicuna-13b-v1.5-16k.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 |
92
+ | [vicuna-13b-v1.5-16k.ggmlv3.q3_K_S.bin](https://huggingface.co/TheBloke/vicuna-13B-v1.5-16K-GGML/blob/main/vicuna-13b-v1.5-16k.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 |
93
+ | [vicuna-13b-v1.5-16k.ggmlv3.q4_0.bin](https://huggingface.co/TheBloke/vicuna-13B-v1.5-16K-GGML/blob/main/vicuna-13b-v1.5-16k.ggmlv3.q4_0.bin) | q4_0 | 4 | 7.37 GB| 9.87 GB | Original quant method, 4-bit. |
94
+ | [vicuna-13b-v1.5-16k.ggmlv3.q4_1.bin](https://huggingface.co/TheBloke/vicuna-13B-v1.5-16K-GGML/blob/main/vicuna-13b-v1.5-16k.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. |
95
+ | [vicuna-13b-v1.5-16k.ggmlv3.q4_K_M.bin](https://huggingface.co/TheBloke/vicuna-13B-v1.5-16K-GGML/blob/main/vicuna-13b-v1.5-16k.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 |
96
+ | [vicuna-13b-v1.5-16k.ggmlv3.q4_K_S.bin](https://huggingface.co/TheBloke/vicuna-13B-v1.5-16K-GGML/blob/main/vicuna-13b-v1.5-16k.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 |
97
+ | [vicuna-13b-v1.5-16k.ggmlv3.q5_0.bin](https://huggingface.co/TheBloke/vicuna-13B-v1.5-16K-GGML/blob/main/vicuna-13b-v1.5-16k.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. |
98
+ | [vicuna-13b-v1.5-16k.ggmlv3.q5_1.bin](https://huggingface.co/TheBloke/vicuna-13B-v1.5-16K-GGML/blob/main/vicuna-13b-v1.5-16k.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. |
99
+ | [vicuna-13b-v1.5-16k.ggmlv3.q5_K_M.bin](https://huggingface.co/TheBloke/vicuna-13B-v1.5-16K-GGML/blob/main/vicuna-13b-v1.5-16k.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 |
100
+ | [vicuna-13b-v1.5-16k.ggmlv3.q5_K_S.bin](https://huggingface.co/TheBloke/vicuna-13B-v1.5-16K-GGML/blob/main/vicuna-13b-v1.5-16k.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 |
101
+ | [vicuna-13b-v1.5-16k.ggmlv3.q6_K.bin](https://huggingface.co/TheBloke/vicuna-13B-v1.5-16K-GGML/blob/main/vicuna-13b-v1.5-16k.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 |
102
+ | [vicuna-13b-v1.5-16k.ggmlv3.q8_0.bin](https://huggingface.co/TheBloke/vicuna-13B-v1.5-16K-GGML/blob/main/vicuna-13b-v1.5-16k.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. |
103
+
104
+ **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.
105
+
106
+ ## How to run in `llama.cpp`
107
+
108
+ I use the following command line; adjust for your tastes and needs:
109
+
110
+ ```
111
+ ./main -t 10 -ngl 32 -m vicuna-13b-v1.5-16k.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:"
112
+ ```
113
+ 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`.
114
+
115
+ Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
116
+
117
+ If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
118
+
119
+ ## How to run in `text-generation-webui`
120
+
121
+ 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).
122
+
123
+ <!-- footer start -->
124
+ ## Discord
125
+
126
+ For further support, and discussions on these models and AI in general, join us at:
127
+
128
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
129
+
130
+ ## Thanks, and how to contribute.
131
+
132
+ Thanks to the [chirper.ai](https://chirper.ai) team!
133
+
134
+ 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.
135
+
136
+ 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.
137
+
138
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
139
+
140
+ * Patreon: https://patreon.com/TheBlokeAI
141
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
142
+
143
+ **Special thanks to**: Luke from CarbonQuill, Aemon Algiz.
144
+
145
+ **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
146
+
147
+
148
+ Thank you to all my generous patrons and donaters!
149
+
150
+ <!-- footer end -->
151
+
152
+ # Original model card: lmsys's Vicuna 13B v1.5 16K
153
+
154
+
155
+ **Note:** This is a preview version. A slightly better checkpoint will be uploaded soon.
156
+
157
+ # Vicuna Model Card
158
+
159
+ ## Model Details
160
+
161
+ Vicuna is a chat assistant trained by fine-tuning Llama 2 on user-shared conversations collected from ShareGPT.
162
+
163
+ - **Developed by:** [LMSYS](https://lmsys.org/)
164
+ - **Model type:** An auto-regressive language model based on the transformer architecture
165
+ - **License:** Llama 2 Community License Agreement
166
+ - **Finetuned from model:** [Llama 2](https://arxiv.org/abs/2307.09288)
167
+
168
+ ### Model Sources
169
+
170
+ - **Repository:** https://github.com/lm-sys/FastChat
171
+ - **Blog:** https://lmsys.org/blog/2023-03-30-vicuna/
172
+ - **Paper:** https://arxiv.org/abs/2306.05685
173
+ - **Demo:** https://chat.lmsys.org/
174
+
175
+ ## Uses
176
+
177
+ The primary use of Vicuna is research on large language models and chatbots.
178
+ The primary intended users of the model are researchers and hobbyists in natural language processing, machine learning, and artificial intelligence.
179
+
180
+ ## How to Get Started with the Model
181
+
182
+ - Command line interface: https://github.com/lm-sys/FastChat#vicuna-weights
183
+ - APIs (OpenAI API, Huggingface API): https://github.com/lm-sys/FastChat/tree/main#api
184
+
185
+ ## Training Details
186
+
187
+ Vicuna v1.5 (16k) is fine-tuned from Llama 2 with supervised instruction fine-tuning and linear RoPE scaling.
188
+ The training data is around 125K conversations collected from ShareGPT.com. These conversations are packed into sequences that contain 16K tokens each.
189
+ See more details in the "Training Details of Vicuna Models" section in the appendix of this [paper](https://arxiv.org/pdf/2306.05685.pdf).
190
+
191
+ ## Evaluation
192
+
193
+ ![Evaluation Results](https://github.com/lm-sys/lm-sys.github.io/blob/main/public/images/webdata/vicuna_v1.5_eval.png?raw=true)
194
+
195
+ Vicuna is evaluated with standard benchmarks, human preference, and LLM-as-a-judge. See more details in this [paper](https://arxiv.org/pdf/2306.05685.pdf) and [leaderboard](https://huggingface.co/spaces/lmsys/chatbot-arena-leaderboard).
196
+
197
+ ## Difference between different versions of Vicuna
198
+
199
+ See [vicuna_weights_version.md](https://github.com/lm-sys/FastChat/blob/main/docs/vicuna_weights_version.md)