Update README.md

README.md

@@ -18,41 +18,27 @@ It is the result of quantising to 4bit and 5bit GGML for CPU inference using [ll
 * [4bit and 5bit GGML models for CPU inference](https://huggingface.co/TheBloke/wizard-vicuna-13B-GGML).
 * [float16 HF format model for GPU inference](https://huggingface.co/TheBloke/wizard-vicuna-13B-HF).
 
-## Provided files
-| Name | Quant method | Bits | Size | RAM required | Use case |
-| ---- | ---- | ---- | ---- | ---- | ----- |
-`wizard-vicuna-13B.ggml.q4_0.bin` | q4_0 | 4bit | 8.14GB | 10.5GB | Maximum compatibility |
-`wizard-vicuna-13B.ggml.q4_2.bin` | q4_2 | 4bit | 8.14GB | 10.5GB | Best compromise between resources, speed and quality |
-`wizard-vicuna-13B.ggml.q5_0.bin` | q5_0 | 5bit | 8.95GB | 11.0GB | Brand new 5bit method. Potentially higher quality than 4bit, at cost of slightly higher resources. |
-`wizard-vicuna-13B.ggml.q5_1.bin` | q5_1 | 5bit | 9.76GB | 12.25GB | Brand new 5bit method. Slightly higher resource usage than q5_0.|
-
-* The q4_0 file provides lower quality, but maximal compatibility. It will work with past and future versions of llama.cpp
-* The q4_2 file offers the best combination of performance and quality. This format is still subject to change and there may be compatibility issues, see below.
-* The q5_0 file is using brand new 5bit method released 26th April. This is the 5bit equivalent of q4_0.
-* The q5_1 file is using brand new 5bit method released 26th April. This is the 5bit equivalent of q4_1.
-
-## q4_2 compatibility
-
-q4_2 is a relatively new 4bit quantisation method offering improved quality. However they are still under development and their formats are subject to change.
+## REQUIRES LATEST LLAMA.CPP (May 12th 2023 - commit b9fd7ee)!
 
-In order to use these files you will need to use recent llama.cpp code. And it's possible that future updates to llama.cpp could require that these files are re-generated.
+llama.cpp recently made a breaking change to its quantisation methods.
 
-If and when the q4_2 file no longer works with recent versions of llama.cpp I will endeavour to update it.
+I have re-quantised the GGML files in this repo. Therefore you will require llama.cpp compiled on May 12th or later (commit `b9fd7ee` or later) to use them.
 
-If you want to ensure guaranteed compatibility with a wide range of llama.cpp versions, use the q4_0 file.
+The previous files, which will still work in older versions of llama.cpp, can be found in branch `previous_llama`.
 
-## q5_0 and q5_1 compatibility
-
-These new methods were released to llama.cpp on 26th April. You will need to pull the latest llama.cpp code and rebuild to be able to use them.
-
-Third party tools/UIs may or may not support them. Check you're using the latest version of any such tools and ask the devs for advice if you find you can't load q5 files.
+## Provided files
+| Name | Quant method | Bits | Size | RAM required | Use case |
+| ---- | ---- | ---- | ---- | ---- | ----- |
+`wizard-vicuna-13B.ggml.q4_0.bin` | q4_0 | 4bit | 8.14GB | 10.5GB | 4-bit. |
+`wizard-vicuna-13B.ggml.q5_0.bin` | q5_0 | 5bit | 8.95GB | 11.0GB | 5-bit. Higher accuracy, higher resource usage and slower inference. |
+`wizard-vicuna-13B.ggml.q5_1.bin` | q5_1 | 5bit | 9.76GB | 12.25GB | 5-bit. Even higher accuracy, and higher resource usage and slower inference. |
 
 ## How to run in `llama.cpp`
 
 I use the following command line; adjust for your tastes and needs:
 
 ```
-./main -t 18 -m wizard-vicuna-13B.ggml.q4_2.bi --color -c 2048 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "### Instruction: write a story about llamas ### Response:"
+./main -t 18 -m wizard-vicuna-13B.ggml.q4_0.bin --color -c 2048 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "### Instruction: write a story about llamas ### Response:"
 ```
 
 Change `-t 18` to the number of physical CPU cores you have. For example if your system has 8 cores/16 threads, use `-t 8`.
@@ -63,9 +49,9 @@ GGML models can be loaded into text-generation-webui by installing the llama.cpp
 
 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).
 
-Note: at this time text-generation-webui may not support the new q5 quantisation methods.
+Note: at this time text-generation-webui may not support the new May 12th llama.cpp quantisation methods.
 
-**Thireus** has written a [great guide on how to update it to the latest llama.cpp code](https://huggingface.co/TheBloke/wizardLM-7B-GGML/discussions/5) so that these files can be used in the UI.
+**Thireus** has written a [great guide on how to update it to the latest llama.cpp code](https://huggingface.co/TheBloke/wizardLM-7B-GGML/discussions/5) which may be useful to get text-gen-ui working with the new llama.cpp quant methods sooner.
 
 # Original WizardVicuna-13B model card