text-generation-webui/README.md

54 lines
2.4 KiB
Markdown
Raw Normal View History

2022-12-21 05:17:38 +01:00
# text-generation-webui
2022-12-21 20:49:30 +01:00
A gradio webui for running large language models locally. Supports gpt-j-6B, gpt-neox-20b, opt, galactica, and many others.
Its goal is to become the [AUTOMATIC1111/stable-diffusion-webui](https://github.com/AUTOMATIC1111/stable-diffusion-webui) of text generation.
2022-12-21 17:17:06 +01:00
2022-12-21 18:04:51 +01:00
![webui screenshot](https://github.com/oobabooga/text-generation-webui/raw/main/webui.png)
2022-12-21 17:17:06 +01:00
## Installation
conda env create -f environment.yml
2022-12-22 01:49:03 +01:00
This installs the CUDA version of pytorch, which assumes that you have a NVIDIA GPU. If you want to run this on an AMD GPU, you should install the ROCm version of pytorch instead.
2022-12-21 20:49:30 +01:00
2022-12-21 18:37:50 +01:00
## Downloading models
Models should be placed under `models/model-name`.
2022-12-21 19:00:16 +01:00
#### Hugging Face
2022-12-21 18:37:50 +01:00
Hugging Face is the main place to download models. For instance, [here](https://huggingface.co/EleutherAI/gpt-j-6B/tree/main) you can find the files for the model gpt-j-6B.
The files that you need to download and put under `models/gpt-j-6B` are the json, txt, and pytorch*.bin files. The remaining files are not necessary.
2022-12-21 19:00:16 +01:00
#### GPT-4chan
2022-12-21 18:37:50 +01:00
[GPT-4chan](https://huggingface.co/ykilcher/gpt-4chan) has been shut down from Hugging Face, so you need to download it elsewhere. You have two options:
* Torrent: [16-bit](https://archive.org/details/gpt4chan_model_float16) / [32-bit](https://archive.org/details/gpt4chan_model)
* Direct download: [16-bit](https://theswissbay.ch/pdf/_notpdf_/gpt4chan_model_float16/) / [32-bit](https://theswissbay.ch/pdf/_notpdf_/gpt4chan_model/)
2022-12-21 20:49:30 +01:00
## Converting to pytorch
This webui allows you to switch between different models on the fly, so it must be fast to load the models from disk.
One way to make this process about 10x faster is to convert the models to pytorch format using the script `convert-to-torch.py`. Create a folder called `torch-dumps` and then make the conversion with:
python convert-to-torch.py models/model-name/
The output model will be saved to `torch-dumps/model-name.pt`. This is the default way to load all models except for `gpt-neox-20b`, `opt-13b`, `OPT-13B-Erebus`, `gpt-j-6B`, and `flan-t5`. I don't remember why these models are exceptions.
2022-12-21 20:52:23 +01:00
If I get enough ⭐s on this repository, I will make the process of loading models saner and more customizable.
2022-12-21 20:49:30 +01:00
2022-12-21 17:17:06 +01:00
## Starting the webui
conda activate textgen
python server.py
Then browse to `http://localhost:7860/?__theme=dark`
2022-12-21 20:52:23 +01:00
## Contributing
Pull requests are welcome.