Update README.md
Browse files
README.md
CHANGED
@@ -66,7 +66,7 @@ These files are GGML format model files for [OpenAccess AI Collective's Minotaur
|
|
66 |
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:
|
67 |
* [text-generation-webui](https://github.com/oobabooga/text-generation-webui)
|
68 |
* [KoboldCpp](https://github.com/LostRuins/koboldcpp)
|
69 |
-
* [
|
70 |
* [llama-cpp-python](https://github.com/abetlen/llama-cpp-python)
|
71 |
* [ctransformers](https://github.com/marella/ctransformers)
|
72 |
|
@@ -78,7 +78,7 @@ GGML files are for CPU + GPU inference using [llama.cpp](https://github.com/gger
|
|
78 |
|
79 |
## A note regarding context length
|
80 |
|
81 |
-
it is currently untested as to whether the 8K context is compatible with available clients such as
|
82 |
|
83 |
If you have feedback on this, please let me know.
|
84 |
|
@@ -87,33 +87,25 @@ If you have feedback on this, please let me know.
|
|
87 |
USER: <prompt>
|
88 |
ASSISTANT:
|
89 |
```
|
90 |
-
|
91 |
<!-- compatibility_ggml start -->
|
92 |
-
##
|
93 |
-
|
94 |
-
### Original llama.cpp quant methods: `q4_0, q4_1, q5_0, q5_1, q8_0`
|
95 |
-
|
96 |
-
I have quantized these 'original' quantisation methods using an older version of llama.cpp so that they remain compatible with llama.cpp as of May 19th, commit `2d5db48`.
|
97 |
-
|
98 |
-
These are guaranteed to be compatbile with any UIs, tools and libraries released since late May.
|
99 |
|
100 |
-
|
101 |
|
102 |
-
|
|
|
|
|
|
|
|
|
|
|
103 |
|
104 |
-
|
105 |
|
106 |
-
##
|
107 |
|
108 |
-
|
109 |
-
*
|
110 |
-
* 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.
|
111 |
-
* 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.
|
112 |
-
* GGML_TYPE_Q5_K - "type-1" 5-bit quantization. Same super-block structure as GGML_TYPE_Q4_K resulting in 5.5 bpw
|
113 |
-
* 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
|
114 |
-
* 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.
|
115 |
|
116 |
-
Refer to the Provided Files table below to see what files use which methods, and how.
|
117 |
<!-- compatibility_ggml end -->
|
118 |
|
119 |
## Provided files
|
@@ -125,26 +117,8 @@ Refer to the Provided Files table below to see what files use which methods, and
|
|
125 |
| minotaur-15b.ggmlv3.q5_1.bin | q5_1 | 5 | 14.26 GB | 16.76 GB | Original llama.cpp quant method, 5-bit. Even higher accuracy, resource usage and slower inference. |
|
126 |
| minotaur-15b.ggmlv3.q8_0.bin | q8_0 | 8 | 20.11 GB | 22.61 GB | Original llama.cpp quant method, 8-bit. Almost indistinguishable from float16. High resource use and slow. Not recommended for most users. |
|
127 |
|
128 |
-
|
129 |
**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.
|
130 |
|
131 |
-
## How to run in `llama.cpp`
|
132 |
-
|
133 |
-
I use the following command line; adjust for your tastes and needs:
|
134 |
-
|
135 |
-
```
|
136 |
-
./main -t 10 -ngl 32 -m minotaur-15b.ggmlv3.q5_0.bin --color -c 2048 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "### Instruction: Write a story about llamas\n### Response:"
|
137 |
-
```
|
138 |
-
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`.
|
139 |
-
|
140 |
-
Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
|
141 |
-
|
142 |
-
If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
|
143 |
-
|
144 |
-
## How to run in `text-generation-webui`
|
145 |
-
|
146 |
-
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).
|
147 |
-
|
148 |
<!-- footer start -->
|
149 |
## Discord
|
150 |
|
|
|
66 |
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:
|
67 |
* [text-generation-webui](https://github.com/oobabooga/text-generation-webui)
|
68 |
* [KoboldCpp](https://github.com/LostRuins/koboldcpp)
|
69 |
+
* [LoLLMS Web UI](https://github.com/ParisNeo/lollms-webui)
|
70 |
* [llama-cpp-python](https://github.com/abetlen/llama-cpp-python)
|
71 |
* [ctransformers](https://github.com/marella/ctransformers)
|
72 |
|
|
|
78 |
|
79 |
## A note regarding context length
|
80 |
|
81 |
+
it is currently untested as to whether the 8K context is compatible with available clients/libraries such as KoboldCpp, ctransformers, etc.
|
82 |
|
83 |
If you have feedback on this, please let me know.
|
84 |
|
|
|
87 |
USER: <prompt>
|
88 |
ASSISTANT:
|
89 |
```
|
|
|
90 |
<!-- compatibility_ggml start -->
|
91 |
+
## Compatibilty
|
|
|
|
|
|
|
|
|
|
|
|
|
92 |
|
93 |
+
These files are **not** compatible with llama.cpp.
|
94 |
|
95 |
+
Currently they can be used with:
|
96 |
+
* KoboldCpp, a powerful inference engine based on llama.cpp, with good UI: [KoboldCpp](https://github.com/LostRuins/koboldcpp)
|
97 |
+
* The ctransformers Python library, which includes LangChain support: [ctransformers](https://github.com/marella/ctransformers)
|
98 |
+
* The LoLLMS Web UI which uses ctransformers: [LoLLMS Web UI](https://github.com/ParisNeo/lollms-webui)
|
99 |
+
* [rustformers' llm](https://github.com/rustformers/llm)
|
100 |
+
* The example `starcoder` binary provided with [ggml](https://github.com/ggerganov/ggml)
|
101 |
|
102 |
+
As other options become available I will endeavour to update them here (do let me know in the Community tab if I've missed something!)
|
103 |
|
104 |
+
## Tutorial for using LoLLMS Web UI
|
105 |
|
106 |
+
* [Text tutorial, written by **Lucas3DCG**](https://huggingface.co/TheBloke/MPT-7B-Storywriter-GGML/discussions/2#6475d914e9b57ce0caa68888)
|
107 |
+
* [Video tutorial, by LoLLMS Web UI's author **ParisNeo**](https://www.youtube.com/watch?v=ds_U0TDzbzI)
|
|
|
|
|
|
|
|
|
|
|
108 |
|
|
|
109 |
<!-- compatibility_ggml end -->
|
110 |
|
111 |
## Provided files
|
|
|
117 |
| minotaur-15b.ggmlv3.q5_1.bin | q5_1 | 5 | 14.26 GB | 16.76 GB | Original llama.cpp quant method, 5-bit. Even higher accuracy, resource usage and slower inference. |
|
118 |
| minotaur-15b.ggmlv3.q8_0.bin | q8_0 | 8 | 20.11 GB | 22.61 GB | Original llama.cpp quant method, 8-bit. Almost indistinguishable from float16. High resource use and slow. Not recommended for most users. |
|
119 |
|
|
|
120 |
**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.
|
121 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
122 |
<!-- footer start -->
|
123 |
## Discord
|
124 |
|