text-generation-webui/README.md

153 lines
6.2 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
2023-01-15 06:51:52 +01:00
A gradio webui for running large language models like gpt-j-6B, gpt-neo, opt, galactica, and pygmalion on your own computer.
2022-12-21 20:49:30 +01:00
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
2023-01-15 08:27:22 +01:00
|![Image1](https://github.com/oobabooga/screenshots/raw/main/qa.png) | ![Image2](https://github.com/oobabooga/screenshots/raw/main/chat.png) |
2023-01-15 03:25:05 +01:00
|:---:|:---:|
2023-01-15 08:27:22 +01:00
|![Image3](https://github.com/oobabooga/screenshots/raw/main/gpt4chan.png) | ![Image4](https://github.com/oobabooga/screenshots/raw/main/galactica.png) |
2022-12-21 18:04:51 +01:00
2023-01-07 22:40:51 +01:00
## Features
* Switch between different models using a dropdown menu.
2023-01-09 20:19:57 +01:00
* Generate nice HTML output for GPT-4chan.
2023-01-07 23:19:55 +01:00
* Generate Markdown output for [GALACTICA](https://github.com/paperswithcode/galai), including LaTeX support.
2023-01-07 22:40:51 +01:00
* Notebook mode that resembles OpenAI's playground.
2023-01-08 02:52:46 +01:00
* Chat mode for conversation and role playing.
2023-01-07 22:40:51 +01:00
* Load parameter presets from text files.
2023-01-11 03:30:41 +01:00
* Load large models in 8-bit mode.
* Split large models across your GPU(s) and CPU.
2023-01-09 15:11:05 +01:00
* CPU mode.
2023-01-11 20:51:32 +01:00
* Get responses via API.
2023-01-07 22:40:51 +01:00
2022-12-21 17:17:06 +01:00
## Installation
2023-01-13 05:29:36 +01:00
1. You need to have the conda environment manager installed into your system. If you don't have it already, [get miniconda here](https://docs.conda.io/en/latest/miniconda.html).
2023-01-13 05:37:12 +01:00
2. Open a terminal window and create a conda environment:
2023-01-13 05:29:36 +01:00
```
conda create -n textgen
conda activate textgen
```
3. Install the appropriate pytorch. For NVIDIA GPUs, this should work:
2023-01-13 05:29:36 +01:00
```
conda install pytorch torchvision torchaudio pytorch-cuda=11.7 -c pytorch -c nvidia
```
For AMD GPUs, you need the ROCm version of pytorch. If you don't have any GPU and want to run the webui in CPU mode, you just need the stock pytorch and should use this command instead:
2023-01-13 05:29:36 +01:00
```
conda install pytorch torchvision torchaudio -c pytorch
```
4. Clone or download this repository, and then `cd` into its directory from your terminal window.
5. Install the required Python libraries:
2023-01-13 05:29:36 +01:00
```
pip install -r requirements.txt
```
2022-12-21 17:17:06 +01:00
After these steps, you should be able to start the webui, but first you need to download some model to load.
2022-12-21 18:37:50 +01:00
## Downloading models
2023-01-06 06:12:38 +01:00
Models should be placed under `models/model-name`. For instance, `models/gpt-j-6B` for [gpt-j-6B](https://huggingface.co/EleutherAI/gpt-j-6B/tree/main).
2022-12-21 18:37:50 +01:00
2023-01-15 07:35:57 +01:00
#### Hugging Face
2022-12-21 18:37:50 +01:00
2023-01-15 07:35:57 +01:00
[Hugging Face](https://huggingface.co/models?pipeline_tag=text-generation&sort=downloads) is the main place to download models. These are some noteworthy examples:
2022-12-21 18:37:50 +01:00
2023-01-06 04:13:26 +01:00
* [gpt-j-6B](https://huggingface.co/EleutherAI/gpt-j-6B/tree/main)
* [gpt-neox-20b](https://huggingface.co/EleutherAI/gpt-neox-20b/tree/main)
2023-01-07 23:19:55 +01:00
* [OPT](https://huggingface.co/models?search=facebook/opt)
* [GALACTICA](https://huggingface.co/models?search=facebook/galactica)
2023-01-06 04:13:26 +01:00
* [\*-Erebus](https://huggingface.co/models?search=erebus)
2023-01-13 13:33:38 +01:00
* [Pygmalion](https://huggingface.co/models?search=pygmalion)
2023-01-06 04:13:26 +01:00
2023-01-06 06:12:38 +01:00
The files that you need to download are the json, txt, and pytorch\*.bin files. The remaining files are not necessary.
2022-12-21 18:37:50 +01:00
2023-01-07 00:06:24 +01:00
For your convenience, you can automatically download a model from HF using the script `download-model.py`. Its usage is very simple:
2023-01-07 00:00:58 +01:00
python download-model.py organization/model
For instance:
python download-model.py facebook/opt-1.3b
2023-01-09 20:19:57 +01:00
#### GPT-4chan
2022-12-21 18:37:50 +01:00
2023-01-09 20:19:57 +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:
2022-12-21 18:37:50 +01:00
* 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/)
2023-01-13 05:39:09 +01:00
The 32-bit version is only relevant if you intend to run the model in CPU mode. Otherwise, you should use the 16-bit version.
2023-01-13 05:37:12 +01:00
After downloading the model, follow these steps:
1. Place the files under `models/gpt4chan_model_float16` or `models/gpt4chan_model`.
2. Place GPT-J-6B's config.json file in that same folder: [config.json](https://huggingface.co/EleutherAI/gpt-j-6B/raw/main/config.json).
2023-01-12 03:01:50 +01:00
3. Download GPT-J-6B under `models/gpt-j-6B`:
2023-01-12 03:04:06 +01:00
```
python download-model.py EleutherAI/gpt-j-6B
```
2023-01-08 03:13:43 +01:00
2023-01-13 05:37:12 +01:00
You don't really need all of GPT-J's files, just the tokenizer files, but you might as well download the whole thing. Those files will be automatically detected when you attempt to load GPT-4chan.
2023-01-09 22:58:24 +01:00
#### Converting to pytorch (optional)
2022-12-21 20:49:30 +01:00
2023-01-13 05:37:12 +01:00
The script `convert-to-torch.py` allows you to convert models to .pt format, which is about 10x faster to load to the GPU:
2022-12-21 20:49:30 +01:00
2023-01-08 18:37:43 +01:00
python convert-to-torch.py models/model-name
2022-12-21 20:49:30 +01:00
2023-01-08 18:37:43 +01:00
The output model will be saved to `torch-dumps/model-name.pt`. When you load a new model, the webui first looks for this .pt file; if it is not found, it loads the model as usual from `models/model-name`.
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
2023-01-07 00:00:58 +01:00
Then browse to
`http://localhost:7860/?__theme=dark`
2023-01-07 00:07:58 +01:00
Optionally, you can use the following command-line flags:
2023-01-07 00:00:58 +01:00
2023-01-09 23:06:29 +01:00
```
-h, --help show this help message and exit
--model MODEL Name of the model to load by default.
--notebook Launch the webui in notebook mode, where the output is written to the same text
box as the input.
--chat Launch the webui in chat mode.
--cai-chat Launch the webui in chat mode with a style similar to Character.AI's. If the
file profile.png exists in the same folder as server.py, this image will be used
as the bot's profile picture.
--cpu Use the CPU to generate text.
--auto-devices Automatically split the model across the available GPU(s) and CPU.
--load-in-8bit Load the model with 8-bit precision.
2023-01-11 05:10:11 +01:00
--no-listen Make the webui unreachable from your local network.
2023-01-09 23:06:29 +01:00
```
2023-01-09 14:58:46 +01:00
2023-01-06 05:33:21 +01:00
## Presets
Inference settings presets can be created under `presets/` as text files. These files are detected automatically at startup.
2023-01-09 22:12:41 +01:00
## System requirements
2023-01-09 22:18:35 +01:00
Check the [wiki](https://github.com/oobabooga/text-generation-webui/wiki/System-requirements) for some examples of VRAM and RAM usage in both GPU and CPU mode.
2023-01-09 22:12:41 +01:00
2022-12-21 20:52:23 +01:00
## Contributing
2023-01-09 20:09:27 +01:00
Pull requests, suggestions and issue reports are welcome.
2023-01-09 20:15:54 +01:00
2023-01-15 07:00:59 +01:00
## Credits
2023-01-09 20:15:54 +01:00
2023-01-15 08:29:19 +01:00
- NovelAI and KoboldAI presets: https://github.com/KoboldAI/KoboldAI-Client/wiki/Settings-Presets
2023-01-15 07:00:59 +01:00
- Pygmalion preset: https://github.com/PygmalionAI/gradio-ui/blob/master/src/gradio_ui.py