TheBloke commited on
Commit
f396abd
1 Parent(s): 7c73d7b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +13 -27
README.md CHANGED
@@ -32,41 +32,27 @@ This model works best with the following prompt template:
32
  ### Assistant:
33
  ```
34
 
35
- ## Provided files
36
- | Name | Quant method | Bits | Size | RAM required | Use case |
37
- | ---- | ---- | ---- | ---- | ---- | ----- |
38
- `stable-vicuna-13B.ggml.q4_0.bin` | q4_0 | 4bit | 8.14GB | 10.5GB | Maximum compatibility |
39
- `stable-vicuna-13B.ggml.q4_2.bin` | q4_2 | 4bit | 8.14GB | 10.5GB | Best compromise between resources, speed and quality |
40
- `stable-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. |
41
- `stable-vicuna-13B.ggml.q5_1.bin` | q5_1 | 5bit | 9.76GB | 12.25GB | Brand new 5bit method. Slightly higher resource usage than q5_0.|
42
-
43
- * The q4_0 file provides lower quality, but maximal compatibility. It will work with past and future versions of llama.cpp
44
- * 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.
45
- * The q5_0 file is using brand new 5bit method released 26th April. This is the 5bit equivalent of q4_0.
46
- * The q5_1 file is using brand new 5bit method released 26th April. This is the 5bit equivalent of q4_1.
47
-
48
- ## q4_2 compatibility
49
-
50
- 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.
51
 
52
- 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.
53
 
54
- If and when the q4_2 file no longer works with recent versions of llama.cpp I will endeavour to update it.
55
 
56
- If you want to ensure guaranteed compatibility with a wide range of llama.cpp versions, use the q4_0 file.
57
 
58
- ## q5_0 and q5_1 compatibility
59
-
60
- 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.
61
-
62
- Don't expect any third-party UIs/tools to support them yet.
 
63
 
64
  ## How to run in `llama.cpp`
65
 
66
  I use the following command line; adjust for your tastes and needs:
67
 
68
  ```
69
- ./main -t 18 -m stable-vicuna-13B.ggml.q4_2.bin --color -c 2048 --temp 0.7 --repeat_penalty 1.1 -n -1 -r "### Human:" -p "### Human: write a story about llamas ### Assistant:"
70
  ```
71
 
72
  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`.
@@ -77,9 +63,9 @@ GGML models can be loaded into text-generation-webui by installing the llama.cpp
77
 
78
  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).
79
 
80
- Note: at this time text-generation-webui will not support the new q5 quantisation methods.
81
 
82
- **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.
83
 
84
  # Original StableVicuna-13B model card
85
 
 
32
  ### Assistant:
33
  ```
34
 
35
+ ## REQUIRES LATEST LLAMA.CPP (May 12th 2023 - commit b9fd7ee)!
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
36
 
37
+ llama.cpp recently made a breaking change to its quantisation methods.
38
 
39
+ 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.
40
 
41
+ The previous files, which will still work in older versions of llama.cpp, can be found in branch `previous_llama`.
42
 
43
+ ## Provided files
44
+ | Name | Quant method | Bits | Size | RAM required | Use case |
45
+ | ---- | ---- | ---- | ---- | ---- | ----- |
46
+ `stable-vicuna-13B.ggml.q4_0.bin` | q4_0 | 4bit | 8.14GB | 10.5GB | 4bit. |
47
+ `stable-vicuna-13B.ggml.q5_0.bin` | q5_0 | 5bit | 8.95GB | 11.0GB | 5bit. Higher accuracy, higher resource usage and slower inference. |
48
+ `stable-vicuna-13B.ggml.q5_1.bin` | q5_1 | 5bit | 9.76GB | 12.25GB | 5bit. Higher accuracy than q5_0, but again higher resource usage and slower inference. |
49
 
50
  ## How to run in `llama.cpp`
51
 
52
  I use the following command line; adjust for your tastes and needs:
53
 
54
  ```
55
+ ./main -t 18 -m stable-vicuna-13B.ggml.q4_0.bin --color -c 2048 --temp 0.7 --repeat_penalty 1.1 -n -1 -r "### Human:" -p "### Human: write a story about llamas ### Assistant:"
56
  ```
57
 
58
  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
 
64
  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).
65
 
66
+ Note: at this time text-generation-webui may not support the May 12th updated quantisation methods.
67
 
68
+ **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 help with getting the files working in text-gen-ui sooner.
69
 
70
  # Original StableVicuna-13B model card
71