text-generation-webui/README.md

442 lines
24 KiB
Markdown
Raw Normal View History

2023-01-16 14:31:13 +01:00
# Text generation web UI
2022-12-21 20:49:30 +01:00
2023-08-15 20:40:37 +02:00
A Gradio web UI for Large Language Models.
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-08-15 22:16:24 +02:00
|![Image1](https://github.com/oobabooga/screenshots/raw/main/print_instruct.png) | ![Image2](https://github.com/oobabooga/screenshots/raw/main/print_chat.png) |
2023-01-15 03:25:05 +01:00
|:---:|:---:|
2023-08-15 22:16:24 +02:00
|![Image1](https://github.com/oobabooga/screenshots/raw/main/print_default.png) | ![Image2](https://github.com/oobabooga/screenshots/raw/main/print_parameters.png) |
2022-12-21 18:04:51 +01:00
2023-01-07 22:40:51 +01:00
## Features
2023-08-15 20:40:37 +02:00
* 3 interface modes: default (two columns), notebook, and chat
2023-10-05 18:22:37 +02:00
* Multiple model backends: [transformers](https://github.com/huggingface/transformers), [llama.cpp](https://github.com/ggerganov/llama.cpp), [ExLlama](https://github.com/turboderp/exllama), [ExLlamaV2](https://github.com/turboderp/exllamav2), [AutoGPTQ](https://github.com/PanQiWei/AutoGPTQ), [GPTQ-for-LLaMa](https://github.com/qwopqwop200/GPTQ-for-LLaMa), [CTransformers](https://github.com/marella/ctransformers), [AutoAWQ](https://github.com/casper-hansen/AutoAWQ)
2023-06-05 20:16:06 +02:00
* Dropdown menu for quickly switching between different models
2023-08-15 20:40:37 +02:00
* LoRA: load and unload LoRAs on the fly, train a new LoRA using QLoRA
* Precise instruction templates for chat mode, including Llama-2-chat, Alpaca, Vicuna, WizardLM, StableLM, and many others
* 4-bit, 8-bit, and CPU inference through the transformers library
* Use llama.cpp models with transformers samplers (`llamacpp_HF` loader)
2023-05-10 17:09:47 +02:00
* [Multimodal pipelines, including LLaVA and MiniGPT-4](https://github.com/oobabooga/text-generation-webui/tree/main/extensions/multimodal)
2023-08-15 20:40:37 +02:00
* [Extensions framework](docs/Extensions.md)
2023-05-10 17:48:25 +02:00
* [Custom chat characters](docs/Chat-mode.md)
2023-04-01 19:15:19 +02:00
* Very efficient text streaming
2023-06-05 20:16:06 +02:00
* Markdown output with LaTeX rendering, to use for instance with [GALACTICA](https://github.com/paperswithcode/galai)
* API, including endpoints for websocket streaming ([see the examples](https://github.com/oobabooga/text-generation-webui/blob/main/api-examples))
To learn how to use the various features, check out the Documentation: https://github.com/oobabooga/text-generation-webui/tree/main/docs
2023-01-07 22:40:51 +01:00
## Installation
2022-12-21 17:17:06 +01:00
### One-click installers
2023-09-23 04:23:16 +02:00
1) Clone or download the repository.
2023-09-23 00:20:09 +02:00
2) Run the `start_linux.sh`, `start_windows.bat`, `start_macos.sh`, or `start_wsl.bat` script depending on your OS.
3) Select your GPU vendor when asked.
2023-09-23 04:23:16 +02:00
4) Have fun!
2023-09-23 04:31:32 +02:00
#### How it works
2023-09-23 04:23:16 +02:00
The script creates a folder called `installer_files` where it sets up a Conda environment using Miniconda. The installation is self-contained: if you want to reinstall, just delete `installer_files` and run the start script again.
2023-09-22 20:52:20 +02:00
To launch the webui in the future after it is already installed, run the same `start` script.
2023-09-22 20:52:20 +02:00
2023-09-23 04:31:32 +02:00
#### Getting updates
2023-09-22 20:52:20 +02:00
2023-09-23 04:31:32 +02:00
Run `update_linux.sh`, `update_windows.bat`, `update_macos.sh`, or `update_wsl.bat`.
#### Running commands
If you ever need to install something manually in the `installer_files` environment, you can launch an interactive shell using the cmd script: `cmd_linux.sh`, `cmd_windows.bat`, `cmd_macos.sh`, or `cmd_wsl.bat`.
#### Defining command-line flags
2023-09-22 20:52:20 +02:00
To define persistent command-line flags like `--listen` or `--api`, edit the `CMD_FLAGS.txt` file with a text editor and add them there. Flags can also be provided directly to the start scripts, for instance, `./start-linux.sh --listen`.
2023-09-23 04:31:32 +02:00
#### Other info
2023-09-22 20:52:20 +02:00
* There is no need to run any of those scripts as admin/root.
2023-09-23 20:37:39 +02:00
* For additional instructions about AMD setup, WSL setup, and nvcc installation, consult [this page](https://github.com/oobabooga/text-generation-webui/blob/main/docs/One-Click-Installers.md).
2023-09-22 21:00:06 +02:00
* The installer has been tested mostly on NVIDIA GPUs. If you can find a way to improve it for your AMD/Intel Arc/Mac Metal GPU, you are highly encouraged to submit a PR to this repository. The main file to be edited is `one_click.py`.
* For automated installation, you can use the `GPU_CHOICE`, `USE_CUDA118`, `LAUNCH_AFTER_INSTALL`, and `INSTALL_EXTENSIONS` environment variables. For instance: `GPU_CHOICE=A USE_CUDA118=FALSE LAUNCH_AFTER_INSTALL=FALSE INSTALL_EXTENSIONS=FALSE ./start_linux.sh`.
### Manual installation using Conda
2023-08-15 20:40:37 +02:00
Recommended if you have some experience with the command-line.
2023-04-05 19:42:58 +02:00
#### 0. Install Conda
2023-03-29 07:24:11 +02:00
2023-04-01 19:15:19 +02:00
https://docs.conda.io/en/latest/miniconda.html
2023-08-15 20:40:37 +02:00
On Linux or WSL, it can be automatically installed with these two commands ([source](https://educe-ubc.github.io/conda.html)):
2023-03-17 23:52:22 +01:00
```
curl -sL "https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh" > "Miniconda3.sh"
bash Miniconda3.sh
```
2023-04-05 19:42:58 +02:00
#### 1. Create a new conda environment
2023-01-13 05:29:36 +01:00
```
conda create -n textgen python=3.11
2023-01-13 05:29:36 +01:00
conda activate textgen
2023-01-20 04:20:35 +01:00
```
2023-04-05 19:42:58 +02:00
#### 2. Install Pytorch
| System | GPU | Command |
|--------|---------|---------|
| Linux/WSL | NVIDIA | `pip3 install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu121` |
2023-07-26 00:13:07 +02:00
| Linux/WSL | CPU only | `pip3 install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cpu` |
2023-10-08 15:12:13 +02:00
| Linux | AMD | `pip3 install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/rocm5.6` |
2023-07-26 00:13:07 +02:00
| MacOS + MPS | Any | `pip3 install torch torchvision torchaudio` |
| Windows | NVIDIA | `pip3 install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu121` |
| Windows | CPU only | `pip3 install torch torchvision torchaudio` |
2023-02-11 11:56:12 +01:00
The up-to-date commands can be found here: https://pytorch.org/get-started/locally/.
2023-03-18 02:57:46 +01:00
For NVIDIA, you may also need to manually install the CUDA runtime libraries:
```
conda install -y -c "nvidia/label/cuda-12.1.0" cuda-runtime
```
2023-04-05 19:42:58 +02:00
#### 3. Install the web UI
2023-01-13 05:29:36 +01:00
```
git clone https://github.com/oobabooga/text-generation-webui
cd text-generation-webui
pip install -r <requirements file according to table below>
2023-01-13 05:29:36 +01:00
```
2022-12-21 17:17:06 +01:00
Requirements file to use:
2023-08-18 18:37:20 +02:00
| GPU | CPU | requirements file to use |
|--------|---------|---------|
| NVIDIA | has AVX2 | `requirements.txt` |
| NVIDIA | no AVX2 | `requirements_noavx2.txt` |
| AMD | has AVX2 | `requirements_amd.txt` |
| AMD | no AVX2 | `requirements_amd_noavx2.txt` |
| CPU only | has AVX2 | `requirements_cpu_only.txt` |
| CPU only | no AVX2 | `requirements_cpu_only_noavx2.txt` |
| Apple | Intel | `requirements_apple_intel.txt` |
| Apple | Apple Silicon | `requirements_apple_silicon.txt` |
2023-08-18 18:37:20 +02:00
##### AMD GPU on Windows
2023-08-18 18:37:20 +02:00
1) Use `requirements_cpu_only.txt` or `requirements_cpu_only_noavx2.txt` in the command above.
2) Manually install llama-cpp-python using the appropriate command for your hardware: [Installation from PyPI](https://github.com/abetlen/llama-cpp-python#installation-with-hardware-acceleration).
* Use the `LLAMA_HIPBLAS=on` toggle.
* Note the [Windows remarks](https://github.com/abetlen/llama-cpp-python#windows-remarks).
3) Manually install AutoGPTQ: [Installation](https://github.com/PanQiWei/AutoGPTQ#install-from-source).
* Perform the from-source installation - there are no prebuilt ROCm packages for Windows.
4) Manually install [ExLlama](https://github.com/turboderp/exllama) by simply cloning it into the `repositories` folder (it will be automatically compiled at runtime after that):
```sh
cd text-generation-webui
git clone https://github.com/turboderp/exllama repositories/exllama
```
2023-08-18 18:37:20 +02:00
##### Older NVIDIA GPUs
1) For Kepler GPUs and older, you will need to install CUDA 11.8 instead of 12:
2023-05-25 16:21:52 +02:00
```
pip3 install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu118
conda install -y -c "nvidia/label/cuda-11.8.0" cuda-runtime
```
2023-05-25 16:21:52 +02:00
2) bitsandbytes >= 0.39 may not work. In that case, to use `--load-in-8bit`, you may have to downgrade like this:
* Linux: `pip install bitsandbytes==0.38.1`
* Windows: `pip install https://github.com/jllllll/bitsandbytes-windows-webui/raw/main/bitsandbytes-0.38.1-py3-none-any.whl`
2023-05-25 16:21:52 +02:00
##### Manual install
The requirments*.txt above contain various precompiled wheels. If you wish to compile things manually, or if you need to because no suitable wheels are available for your hardware, you can use `requirements_nowheels.txt` and then install your desired loaders manually.
2023-03-17 23:59:37 +01:00
### Alternative: Docker
2023-04-07 03:50:58 +02:00
```
2023-04-18 17:56:37 +02:00
ln -s docker/{Dockerfile,docker-compose.yml,.dockerignore} .
2023-04-18 17:47:43 +02:00
cp docker/.env.example .env
# Edit .env and set TORCH_CUDA_ARCH_LIST based on your GPU model
2023-04-07 15:48:47 +02:00
docker compose up --build
2023-04-07 03:50:58 +02:00
```
* You need to have docker compose v2.17 or higher installed. See [this guide](https://github.com/oobabooga/text-generation-webui/blob/main/docs/Docker.md) for instructions.
2023-05-31 03:14:49 +02:00
* For additional docker files, check out [this repository](https://github.com/Atinoda/text-generation-webui-docker).
### Updating the requirements
From time to time, the `requirements*.txt` changes. To update, use these commands:
```
conda activate textgen
cd text-generation-webui
pip install -r <requirements file that you've used> --upgrade
```
2022-12-21 18:37:50 +01:00
2023-08-15 20:40:37 +02:00
## Downloading models
2023-01-06 04:13:26 +01:00
2023-08-15 20:40:37 +02:00
Models should be placed in the `text-generation-webui/models` folder. They are usually downloaded from [Hugging Face](https://huggingface.co/models?pipeline_tag=text-generation&sort=downloads).
2023-01-07 00:00:58 +01:00
2023-08-15 20:40:37 +02:00
* Transformers or GPTQ models are made of several files and must be placed in a subfolder. Example:
2023-01-07 00:00:58 +01:00
2023-08-15 20:40:37 +02:00
```
2023-08-15 21:16:21 +02:00
text-generation-webui
2023-08-15 20:40:37 +02:00
├── models
│   ├── lmsys_vicuna-33b-v1.3
│   │   ├── config.json
│   │   ├── generation_config.json
│   │   ├── pytorch_model-00001-of-00007.bin
│   │   ├── pytorch_model-00002-of-00007.bin
│   │   ├── pytorch_model-00003-of-00007.bin
│   │   ├── pytorch_model-00004-of-00007.bin
│   │   ├── pytorch_model-00005-of-00007.bin
│   │   ├── pytorch_model-00006-of-00007.bin
│   │   ├── pytorch_model-00007-of-00007.bin
│   │   ├── pytorch_model.bin.index.json
│   │   ├── special_tokens_map.json
│   │   ├── tokenizer_config.json
│   │   └── tokenizer.model
```
2023-01-07 00:00:58 +01:00
2023-09-11 16:30:56 +02:00
* GGUF models are a single file and should be placed directly into `models`. Example:
2023-01-23 14:02:35 +01:00
2023-08-15 20:40:37 +02:00
```
2023-08-15 21:21:50 +02:00
text-generation-webui
2023-08-15 20:40:37 +02:00
├── models
2023-09-15 22:00:46 +02:00
│   ├── llama-2-13b-chat.Q4_K_M.gguf
2023-08-15 20:40:37 +02:00
```
2023-07-26 05:49:00 +02:00
2023-08-30 23:19:04 +02:00
In both cases, you can use the "Model" tab of the UI to download the model from Hugging Face automatically. It is also possible to download via the command-line with `python download-model.py organization/model` (use `--help` to see all the options).
2023-07-26 05:49:00 +02:00
#### GPT-4chan
<details>
<summary>
Instructions
</summary>
[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/)
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](https://huggingface.co/EleutherAI/gpt-j-6B/raw/main/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
```
2023-08-15 22:16:24 +02:00
When you load this model in default or notebook modes, the "HTML" tab will show the generated text in 4chan format:
![Image3](https://github.com/oobabooga/screenshots/raw/main/gpt4chan.png)
2023-07-26 05:49:00 +02:00
</details>
2023-06-05 20:16:06 +02:00
2023-01-16 14:07:00 +01:00
## Starting the web UI
2022-12-21 17:17:06 +01:00
conda activate textgen
2023-03-18 01:05:17 +01:00
cd text-generation-webui
2022-12-21 17:17:06 +01:00
python server.py
Then browse to
2023-01-07 00:00:58 +01:00
`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-04-01 18:55:15 +02:00
#### Basic settings
2023-04-07 15:47:10 +02:00
| Flag | Description |
|--------------------------------------------|-------------|
| `-h`, `--help` | Show this help message and exit. |
| `--multi-user` | Multi-user mode. Chat histories are not saved or automatically loaded. WARNING: this is highly experimental. |
| `--character CHARACTER` | The name of the character to load in chat mode by default. |
2023-04-07 15:47:10 +02:00
| `--model MODEL` | Name of the model to load by default. |
| `--lora LORA [LORA ...]` | The list of LoRAs to load. If you want to load more than one LoRA, write the names separated by spaces. |
2023-04-07 15:47:10 +02:00
| `--model-dir MODEL_DIR` | Path to directory with all the models. |
| `--lora-dir LORA_DIR` | Path to directory with all the loras. |
2023-04-13 02:24:26 +02:00
| `--model-menu` | Show a model menu in the terminal when the web UI is first launched. |
2023-05-29 03:34:12 +02:00
| `--settings SETTINGS_FILE` | Load the default interface settings from this yaml file. See `settings-template.yaml` for an example. If you create a file called `settings.yaml`, this file will be loaded by default without the need to use the `--settings` flag. |
2023-04-07 15:47:10 +02:00
| `--extensions EXTENSIONS [EXTENSIONS ...]` | The list of extensions to load. If you want to load more than one extension, write the names separated by spaces. |
| `--verbose` | Print the prompts to the terminal. |
2023-09-16 06:04:51 +02:00
| `--chat-buttons` | Show buttons on chat tab instead of hover menu. |
2023-04-01 18:55:15 +02:00
#### Model loader
| Flag | Description |
|--------------------------------------------|-------------|
| `--loader LOADER` | Choose the model loader manually, otherwise, it will get autodetected. Valid options: transformers, autogptq, gptq-for-llama, exllama, exllama_hf, llamacpp, rwkv, ctransformers |
2023-04-01 18:55:15 +02:00
#### Accelerate/transformers
2023-04-07 15:47:10 +02:00
| Flag | Description |
|---------------------------------------------|-------------|
| `--cpu` | Use the CPU to generate text. Warning: Training on CPU is extremely slow.|
2023-04-07 15:47:10 +02:00
| `--auto-devices` | Automatically split the model across the available GPU(s) and CPU. |
2023-06-01 17:08:44 +02:00
| `--gpu-memory GPU_MEMORY [GPU_MEMORY ...]` | Maximum GPU memory in GiB to be allocated per GPU. Example: `--gpu-memory 10` for a single GPU, `--gpu-memory 10 5` for two GPUs. You can also set values in MiB like `--gpu-memory 3500MiB`. |
2023-04-07 15:47:10 +02:00
| `--cpu-memory CPU_MEMORY` | Maximum CPU memory in GiB to allocate for offloaded weights. Same as above.|
| `--disk` | If the model is too large for your GPU(s) and CPU combined, send the remaining layers to the disk. |
| `--disk-cache-dir DISK_CACHE_DIR` | Directory to save the disk cache to. Defaults to `cache/`. |
2023-05-25 06:14:13 +02:00
| `--load-in-8bit` | Load the model with 8-bit precision (using bitsandbytes).|
2023-04-07 15:47:10 +02:00
| `--bf16` | Load the model with bfloat16 precision. Requires NVIDIA Ampere GPU. |
| `--no-cache` | Set `use_cache` to False while generating text. This reduces the VRAM usage a bit with a performance cost. |
2023-04-10 04:08:40 +02:00
| `--xformers` | Use xformer's memory efficient attention. This should increase your tokens/s. |
| `--sdp-attention` | Use torch 2.0's sdp attention. |
| `--trust-remote-code` | Set trust_remote_code=True while loading a model. Necessary for ChatGLM and Falcon. |
2023-09-25 21:19:43 +02:00
| `--use_fast` | Set use_fast=True while loading a tokenizer. |
2023-04-01 18:55:15 +02:00
2023-05-25 06:14:13 +02:00
#### Accelerate 4-bit
⚠️ Requires minimum compute of 7.0 on Windows at the moment.
2023-05-25 06:23:46 +02:00
2023-05-25 06:14:13 +02:00
| Flag | Description |
|---------------------------------------------|-------------|
| `--load-in-4bit` | Load the model with 4-bit precision (using bitsandbytes). |
| `--compute_dtype COMPUTE_DTYPE` | compute dtype for 4-bit. Valid options: bfloat16, float16, float32. |
| `--quant_type QUANT_TYPE` | quant_type for 4-bit. Valid options: nf4, fp4. |
| `--use_double_quant` | use_double_quant for 4-bit. |
2023-09-11 16:30:56 +02:00
#### GGUF (for llama.cpp and ctransformers)
2023-04-01 18:55:15 +02:00
2023-04-07 15:47:10 +02:00
| Flag | Description |
|-------------|-------------|
| `--threads` | Number of threads to use. |
2023-10-02 06:27:04 +02:00
| `--threads-batch THREADS_BATCH` | Number of threads to use for batches/prompt processing. |
| `--n_batch` | Maximum number of prompt tokens to batch together when calling llama_eval. |
| `--n-gpu-layers N_GPU_LAYERS` | Number of layers to offload to the GPU. Only works if llama-cpp-python was compiled with BLAS. Set this to 1000000000 to offload all layers to the GPU. |
| `--n_ctx N_CTX` | Size of the prompt context. |
#### llama.cpp
2023-08-27 07:24:44 +02:00
| Flag | Description |
|---------------|---------------|
| `--mul_mat_q` | Activate new mulmat kernels. |
| `--tensor_split TENSOR_SPLIT` | Split the model across multiple GPUs, comma-separated list of proportions, e.g. 18,17 |
| `--llama_cpp_seed SEED` | Seed for llama-cpp models. Default 0 (random). |
| `--cache-capacity CACHE_CAPACITY` | Maximum cache capacity. Examples: 2000MiB, 2GiB. When provided without units, bytes will be assumed. |
|`--cfg-cache` | llamacpp_HF: Create an additional cache for CFG negative prompts. |
| `--no-mmap` | Prevent mmap from being used. |
| `--mlock` | Force the system to keep the model in RAM. |
| `--numa` | Activate NUMA task allocation for llama.cpp |
| `--cpu` | Use the CPU version of llama-cpp-python instead of the GPU-accelerated version. |
2023-04-01 18:55:15 +02:00
#### ctransformers
| Flag | Description |
|-------------|-------------|
| `--model_type MODEL_TYPE` | Model type of pre-quantized model. Currently gpt2, gptj, gptneox, falcon, llama, mpt, starcoder (gptbigcode), dollyv2, and replit are supported. |
#### AutoGPTQ
| Flag | Description |
|------------------|-------------|
| `--triton` | Use triton. |
| `--no_inject_fused_attention` | Disable the use of fused attention, which will use less VRAM at the cost of slower inference. |
| `--no_inject_fused_mlp` | Triton mode only: disable the use of fused MLP, which will use less VRAM at the cost of slower inference. |
2023-06-23 17:24:43 +02:00
| `--no_use_cuda_fp16` | This can make models faster on some systems. |
| `--desc_act` | For models that don't have a quantize_config.json, this parameter is used to define whether to set desc_act or not in BaseQuantizeConfig. |
| `--disable_exllama` | Disable ExLlama kernel, which can improve inference speed on some systems. |
#### ExLlama
| Flag | Description |
|------------------|-------------|
|`--gpu-split` | Comma-separated list of VRAM (in GB) to use per GPU device for model layers, e.g. `20,7,7` |
2023-06-26 03:49:26 +02:00
|`--max_seq_len MAX_SEQ_LEN` | Maximum sequence length. |
2023-08-24 21:27:36 +02:00
|`--cfg-cache` | ExLlama_HF: Create an additional cache for CFG negative prompts. Necessary to use CFG with that loader, but not necessary for CFG with base ExLlama. |
#### GPTQ-for-LLaMa
2023-04-01 18:55:15 +02:00
2023-04-07 15:47:10 +02:00
| Flag | Description |
|---------------------------|-------------|
2023-04-17 15:55:35 +02:00
| `--wbits WBITS` | Load a pre-quantized model with specified precision in bits. 2, 3, 4 and 8 are supported. |
| `--model_type MODEL_TYPE` | Model type of pre-quantized model. Currently LLaMA, OPT, and GPT-J are supported. |
| `--groupsize GROUPSIZE` | Group size. |
| `--pre_layer PRE_LAYER [PRE_LAYER ...]` | The number of layers to allocate to the GPU. Setting this parameter enables CPU offloading for 4-bit models. For multi-gpu, write the numbers separated by spaces, eg `--pre_layer 30 60`. |
2023-05-04 20:17:20 +02:00
| `--checkpoint CHECKPOINT` | The path to the quantized checkpoint file. If not specified, it will be automatically detected. |
| `--monkey-patch` | Apply the monkey patch for using LoRAs with quantized models.
2023-04-01 18:55:15 +02:00
#### DeepSpeed
2023-04-07 15:47:10 +02:00
| Flag | Description |
|---------------------------------------|-------------|
| `--deepspeed` | Enable the use of DeepSpeed ZeRO-3 for inference via the Transformers integration. |
2023-03-17 15:58:45 +01:00
| `--nvme-offload-dir NVME_OFFLOAD_DIR` | DeepSpeed: Directory to use for ZeRO-3 NVME offloading. |
2023-04-07 15:47:10 +02:00
| `--local_rank LOCAL_RANK` | DeepSpeed: Optional argument for distributed setups. |
2023-04-01 18:55:15 +02:00
#### RWKV
2023-04-07 15:47:10 +02:00
| Flag | Description |
|---------------------------------|-------------|
| `--rwkv-strategy RWKV_STRATEGY` | RWKV: The strategy to use while loading the model. Examples: "cpu fp32", "cuda fp16", "cuda fp16i8". |
| `--rwkv-cuda-on` | RWKV: Compile the CUDA kernel for better performance. |
2023-04-01 18:55:15 +02:00
2023-09-13 00:05:21 +02:00
#### RoPE (for llama.cpp, ExLlama, ExLlamaV2, and transformers)
| Flag | Description |
|------------------|-------------|
2023-08-25 16:08:38 +02:00
| `--alpha_value ALPHA_VALUE` | Positional embeddings alpha factor for NTK RoPE scaling. Use either this or compress_pos_emb, not both. |
| `--rope_freq_base ROPE_FREQ_BASE` | If greater than 0, will be used instead of alpha_value. Those two are related by rope_freq_base = 10000 * alpha_value ^ (64 / 63). |
| `--compress_pos_emb COMPRESS_POS_EMB` | Positional embeddings compression factor. Should be set to (context length) / (model's original context length). Equal to 1/rope_freq_scale. |
2023-04-01 18:55:15 +02:00
#### Gradio
2023-04-07 15:47:10 +02:00
| Flag | Description |
|---------------------------------------|-------------|
| `--listen` | Make the web UI reachable from your local network. |
| `--listen-host LISTEN_HOST` | The hostname that the server will use. |
2023-04-07 15:47:10 +02:00
| `--listen-port LISTEN_PORT` | The listening port that the server will use. |
| `--share` | Create a public URL. This is useful for running the web UI on Google Colab or similar. |
| `--auto-launch` | Open the web UI in the default browser upon launch. |
| `--gradio-auth USER:PWD` | set gradio authentication like "username:password"; or comma-delimit multiple like "u1:p1,u2:p2,u3:p3" |
2023-04-07 15:47:10 +02:00
| `--gradio-auth-path GRADIO_AUTH_PATH` | Set the gradio authentication file path. The file should contain one or more user:password pairs in this format: "u1:p1,u2:p2,u3:p3" |
2023-08-04 18:57:31 +02:00
| `--ssl-keyfile SSL_KEYFILE` | The path to the SSL certificate key file. |
| `--ssl-certfile SSL_CERTFILE` | The path to the SSL certificate cert file. |
2023-01-09 14:58:46 +01:00
#### API
| Flag | Description |
|---------------------------------------|-------------|
| `--api` | Enable the API extension. |
| `--public-api` | Create a public URL for the API using Cloudfare. |
| `--public-api-id PUBLIC_API_ID` | Tunnel ID for named Cloudflare Tunnel. Use together with public-api option. |
| `--api-blocking-port BLOCKING_PORT` | The listening port for the blocking API. |
| `--api-streaming-port STREAMING_PORT` | The listening port for the streaming API. |
#### Multimodal
| Flag | Description |
|---------------------------------------|-------------|
| `--multimodal-pipeline PIPELINE` | The multimodal pipeline to use. Examples: `llava-7b`, `llava-13b`. |
2023-01-06 05:33:21 +01:00
## Presets
2023-06-01 16:27:33 +02:00
Inference settings presets can be created under `presets/` as yaml files. These files are detected automatically at startup.
2023-01-06 05:33:21 +01:00
The presets that are included by default are the result of a contest that received 7215 votes. More details can be found [here](https://github.com/oobabooga/oobabooga.github.io/blob/main/arena/results.md).
2023-01-09 22:12:41 +01:00
2022-12-21 20:52:23 +01:00
## Contributing
2023-08-03 23:36:35 +02:00
If you would like to contribute to the project, check out the [Contributing guidelines](https://github.com/oobabooga/text-generation-webui/wiki/Contributing-guidelines).
2023-02-08 05:17:50 +01:00
2023-06-27 18:56:14 +02:00
## Community
2023-08-15 20:40:37 +02:00
* Subreddit: https://www.reddit.com/r/oobabooga/
2023-06-27 18:56:14 +02:00
* Discord: https://discord.gg/jwZCF2dPQN
2023-08-21 20:57:51 +02:00
## Acknowledgment
In August 2023, [Andreessen Horowitz](https://a16z.com/) (a16z) provided a generous grant to encourage and support my independent work on this project. I am **extremely** grateful for their trust and recognition, which will allow me to dedicate more time towards realizing the full potential of text-generation-webui.