Update README.md

README.md

@@ -18,41 +18,27 @@ It was created by merging the LoRA provided in the above repo with the original
 
 The files in this repo were then quantized to 4bit and 5bit for use with [llama.cpp](https://github.com/ggerganov/llama.cpp).
 
-## Provided files
-| Name | Quant method | Bits | Size | RAM required | Use case |
-| ---- | ---- | ---- | ---- | ---- | ----- |
-`gpt4-alpaca-lora-30B.GGML.q4_0.bin` | q4_0 | 4bit | 20.3GB | 23GB | Maximum compatibility |
-`gpt4-alpaca-lora-30B.GGML.q4_2.bin` | q4_2 | 4bit | 20.3GB | 23GB | Best compromise between resources, speed and quality |
-`gpt4-alpaca-lora-30B.GGML.q5_0.bin` | q5_0 | 5bit | 22.4GB | 25GB | Brand new 5bit method. Potentially higher quality than 4bit, at cost of slightly higher resources. |
-`gpt4-alpaca-lora-30B.GGML.q5_1.bin` | q5_1 | 5bit | 24.4GB | 27GB | 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_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 UIs/tools may not support this yet.
+## Provided files
+| Name | Quant method | Bits | Size | RAM required | Use case |
+| ---- | ---- | ---- | ---- | ---- | ----- |
+`gpt4-alpaca-lora-30B.ggml.q4_0.bin` | q4_0 | 4bit | 20.3GB | 23GB | 4bit. |
+`gpt4-alpaca-lora-30B.ggml.q5_0.bin` | q5_0 | 5bit | 22.4GB | 25GB | 5bit. Higher accuracy, higher resource usage, slower inference. |
+`gpt4-alpaca-lora-30B.ggml.q5_1.bin` | q5_1 | 5bit | 24.4GB | 27GB | 5bit. Even higher accuracy and 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 gpt4-alpaca-lora-30B.GGML.q4_2.bin --color -c 2048 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "Below is an instruction that describes a task. Write a response that appropriately completes the request.
+./main -t 18 -m gpt4-alpaca-lora-30B.GGML.q4_0.bin --color -c 2048 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "Below is an instruction that describes a task. Write a response that appropriately completes the request.
 ### Instruction:
 Write a story about llamas
 ### Response:"
@@ -67,6 +53,8 @@ Create a model directory that has  `ggml` (case sensitive) in its name. Then put
 
 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 that as of May 12th, text-gen-ui likely won't support the newly updated GGML models until it's been updated.
+
 # Original GPT4 Alpaca Lora model card
 
 This repository comes with LoRA checkpoint to make LLaMA into a chatbot like language model. The checkpoint is the output of instruction following fine-tuning process with the following settings on 8xA100(40G) DGX system.