A gradio web UI for running Large Language Models like LLaMA, llama.cpp, GPT-J, Pythia, OPT, and GALACTICA.

Its goal is to become the AUTOMATIC1111/stable-diffusion-webui of text generation.

Features

• Dropdown menu for switching between models
• Notebook mode that resembles OpenAI's playground
• Chat mode for conversation and role playing
• Instruct mode compatible with Alpaca, Vicuna, Open Assistant, Dolly, Koala, and ChatGLM formats
• Nice HTML output for GPT-4chan
• Markdown output for GALACTICA, including LaTeX rendering
• Custom chat characters
• Advanced chat features (send images, get audio responses with TTS)
• Very efficient text streaming
• Parameter presets
• 8-bit mode
• Layers splitting across GPU(s), CPU, and disk
• CPU mode
• FlexGen
• DeepSpeed ZeRO-3
• API with streaming and without streaming
• LLaMA model
• 4-bit GPTQ mode
• llama.cpp
• RWKV model
• LoRA (loading and training)
• Softprompts
• Extensions - see the user extensions list

Installation

One-click installers

Just download the zip above, extract it, and double click on "start". The web UI and all its dependencies will be installed in the same folder.

• The source codes are here: https://github.com/oobabooga/one-click-installers
• Huge thanks to @jllllll, @ClayShoaf, and @xNul for their contributions to these installers.
• There is no need to run the installers as admin.

Manual installation using Conda

Recommended if you have some experience with the command-line.

On Windows, I additionally recommend carrying out the installation on WSL instead of the base system: WSL installation guide.

0. Install Conda

https://docs.conda.io/en/latest/miniconda.html

On Linux or WSL, it can be automatically installed with these two commands:

curl -sL "https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh" > "Miniconda3.sh"
bash Miniconda3.sh

Source: https://educe-ubc.github.io/conda.html

0.1 (Ubuntu/WSL) Install build tools

sudo apt install build-essential

1. Create a new conda environment

conda create -n textgen python=3.10.9
conda activate textgen

2. Install Pytorch

The up to date commands can be found here: https://pytorch.org/get-started/locally/.

2.1 Special instructions

• MacOS users: #393
• AMD users: https://rentry.org/eq3hg

3. Install the web UI

git clone https://github.com/oobabooga/text-generation-webui
cd text-generation-webui
pip install -r requirements.txt

Alternative: manual Windows installation

As an alternative to the recommended WSL method, you can install the web UI natively on Windows using this guide. It will be a lot harder and the performance may be slower: Windows installation guide.

Alternative: Docker

ln -s docker/{Dockerfile,docker-compose.yml,.dockerignore} .
cp docker/.env.example .env
# Edit .env and set TORCH_CUDA_ARCH_LIST based on your GPU model
docker compose up --build

You need to have docker compose v2.17 or higher installed in your system. To see how to install docker compose itself, see the guide in here.

Contributed by @loeken in #633

Updating the requirements

From time to time, the requirements.txt changes. To update, use this command:

conda activate textgen
cd text-generation-webui
pip install -r requirements.txt --upgrade

Downloading models

Models should be placed inside the models folder.

Hugging Face is the main place to download models. These are some examples:

• Pythia
• OPT
• GALACTICA
• GPT-J 6B

You can automatically download a model from HF using the script download-model.py:

python download-model.py organization/model

For example:

python download-model.py facebook/opt-1.3b

If you want to download a model manually, note that all you need are the json, txt, and pytorch*.bin (or model*.safetensors) files. The remaining files are not necessary.

GPT-4chan

GPT-4chan has been shut down from Hugging Face, so you need to download it elsewhere. You have two options:

• Torrent: 16-bit / 32-bit
• Direct download: 16-bit / 32-bit

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.

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.
3. Download GPT-J 6B's tokenizer files (they will be automatically detected when you attempt to load GPT-4chan):

python download-model.py EleutherAI/gpt-j-6B --text-only

Starting the web UI

conda activate textgen
cd text-generation-webui
python server.py

Then browse to

http://localhost:7860/?__theme=dark

Optionally, you can use the following command-line flags:

Basic settings

Accelerate/transformers

llama.cpp

GPTQ

FlexGen

DeepSpeed

RWKV

Gradio

API

Out of memory errors? Check the low VRAM guide.

Presets

Inference settings presets can be created under presets/ as text files. These files are detected automatically at startup.

By default, 10 presets by NovelAI and KoboldAI are included. These were selected out of a sample of 43 presets after applying a K-Means clustering algorithm and selecting the elements closest to the average of each cluster.

Visualization

System requirements

Check the wiki for some examples of VRAM and RAM usage in both GPU and CPU mode.

Contributing

Pull requests, suggestions, and issue reports are welcome.

You are also welcome to review open pull requests.

Before reporting a bug, make sure that you have:

1. Created a conda environment and installed the dependencies exactly as in the Installation section above.
2. Searched to see if an issue already exists for the issue you encountered.

Credits

• Gradio dropdown menu refresh button, code for reloading the interface: https://github.com/AUTOMATIC1111/stable-diffusion-webui
• Verbose preset: Anonymous 4chan user.
• NovelAI and KoboldAI presets: https://github.com/KoboldAI/KoboldAI-Client/wiki/Settings-Presets
• Code for early stopping in chat mode, code for some of the sliders: https://github.com/PygmalionAI/gradio-ui/