Update README.md

README.md

@@ -10,6 +10,54 @@ It was created by merging the deltas provided in the above repo with the origina
 
 It was then quantized to 4bit using [GPTQ-for-LLaMa](https://github.com/qwopqwop200/GPTQ-for-LLaMa).
 
+## Provided files
+
+Two model files are provided. Ideally use the `safetensors` file. Full details below:
+
+Details of the files provided:
+* `vicuna-13B-1.1-GPTQ-4bit-128g.safetensors`
+  * `safetensors` format, with improved file security, created with the latest [GPTQ-for-LLaMa](https://github.com/qwopqwop200/GPTQ-for-LLaMa) code.
+  * Command to create:
+    * `python3 llama.py vicuna-13B-1.1-HF c4 --wbits 4 --true-sequential --act-order --groupsize 128 --save_safetensors vicuna-13B-1.1-GPTQ-4bit-128g.safetensors`
+* vicuna-13B-1.1-GPTQ-4bit-128g.safetensors.no-act-order.pt`
+  * `pt` format file, created without the `--act-order` flag.
+  * This file may have slightly lower quality, but is included as it can be used without needing to compile the latest GPTQ-for-LLaMa code.
+  * It should hopefully therefore work with one-click-installers on Windows, which include the older GPTQ-for-LLaMa code.
+  * Command to create:
+    * `python3 llama.py vicuna-13B-1.1-HF c4 --wbits 4 --true-sequential --groupsize 128 --save_safetensors vicuna-13B-1.1-GPTQ-4bit-128g.no-act-order.pt`
+
+## How to run in `text-generation-webui`
+
+File `vicuna-13B-1.1-GPTQ-4bit-128g.no-act-order.pt` can be loaded the same as any other GPTQ file, without requiring any updates to [oobaboogas text-generation-webui](https://github.com/oobabooga/text-generation-webui).
+
+The other two model files were created with the latest GPTQ code, and require that the latest GPTQ-for-LLaMa is used inside the UI.
+
+Here are the commands I used to clone the Triton branch of GPTQ-for-LLaMa, clone text-generation-webui, and install GPTQ into the UI:
+```
+git clone https://github.com/qwopqwop200/GPTQ-for-LLaMa
+git clone https://github.com/oobabooga/text-generation-webui
+mkdir -p text-generation-webui/repositories
+ln -s GPTQ-for-LLaMa text-generation-webui/repositories/GPTQ-for-LLaMa
+```
+
+Then install this model into `text-generation-webui/models` and launch the UI as follows:
+```
+cd text-generation-webui
+python server.py --model vicuna-13B-1.1-GPTQ-4bit-128g --wbits 4 --groupsize 128 --model_type Llama # add any other command line args you want
+```
+
+The above commands assume you have installed all dependencies for GPTQ-for-LLaMa and text-generation-webui. Please see their respective repositories for further information.
+
+If you are on Windows, or cannot use the Triton branch of GPTQ for any other reason, you can instead use the CUDA branch:
+```
+git clone https://github.com/qwopqwop200/GPTQ-for-LLaMa -b cuda
+cd GPTQ-for-LLaMa
+python setup_cuda.py install
+```
+Then link that into `text-generation-webui/repositories` as described above.
+
+Or just use `vicuna-13B-1.1-GPTQ-4bit-128g.no-act-order.pt` as mentioned above.
+
 # Vicuna Model Card
 
 ## Model details