upstream-archive/textgen
1
0
Fork 0
mirror of https://github.com/oobabooga/textgen.git synced 2026-07-23 11:20:54 -05:00
Code Issues Packages Projects Releases Wiki Activity

Rename project from text-generation-webui to textgen

Browse Source
This commit is contained in:
oobabooga
2026-04-13 16:42:51 -03:00
parent 61bfc2ffd5
commit 65cef2c731
39 changed files with 162 additions and 162 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.github/pull_request_template.md vendored
View File

@@ -1,3 +1,3 @@
## Checklist:
- [ ] I have read the [Contributing guidelines](https://github.com/oobabooga/text-generation-webui/wiki/Contributing-guidelines).
- [ ] I have read the [Contributing guidelines](https://github.com/oobabooga/textgen/wiki/Contributing-guidelines).

2
.github/workflows/build-everything-tgw.yml vendored
View File

@@ -4,7 +4,7 @@ on:
workflow_dispatch:
inputs:
version:
description: 'Version tag of text-generation-webui to build: v3.0'
description: 'Version tag of textgen to build: v3.0'
default: 'v3.0'
required: true
type: string

18
.github/workflows/build-portable-release-cuda.yml vendored
View File

@@ -4,7 +4,7 @@ on:
workflow_dispatch:
inputs:
version:
description: 'Version tag of text-generation-webui to build: v3.0'
description: 'Version tag of textgen to build: v3.0'
default: 'v3.0'
required: true
type: string
@@ -21,7 +21,7 @@ on:
workflow_call:
inputs:
version:
description: 'Version tag of text-generation-webui to build: v3.0'
description: 'Version tag of textgen to build: v3.0'
default: 'v3.0'
required: true
type: string
@@ -88,7 +88,7 @@ jobs:
steps:
- uses: actions/checkout@v6
with:
repository: 'oobabooga/text-generation-webui'
repository: 'oobabooga/textgen'
ref: ${{ inputs.version }}
submodules: 'recursive'
@@ -102,8 +102,8 @@ jobs:
VERSION_CLEAN="${{ inputs.version }}"
VERSION_CLEAN="${VERSION_CLEAN#v}"
cd ..
cp -r text-generation-webui "text-generation-webui-${VERSION_CLEAN}"
cd "text-generation-webui-${VERSION_CLEAN}"
cp -r textgen "textgen-${VERSION_CLEAN}"
cd "textgen-${VERSION_CLEAN}"
# Remove extensions that need additional requirements
allowed=("character_bias" "gallery" "sd_api_pictures")
@@ -133,10 +133,10 @@ jobs:
echo "Downloading Python for $PLATFORM..."
curl -L -o python-build.tar.gz "$PYTHON_URL"
tar -xzf python-build.tar.gz
mv python "text-generation-webui-${VERSION_CLEAN}/portable_env"
mv python "textgen-${VERSION_CLEAN}/portable_env"
# 3. Prepare requirements file based on CUDA version
cd "text-generation-webui-${VERSION_CLEAN}"
cd "textgen-${VERSION_CLEAN}"
if [[ "$CUDA_VERSION" == "13.1" ]]; then
REQ_FILE="requirements/portable/requirements_cuda131.txt"
else
@@ -155,11 +155,11 @@ jobs:
if [[ "$RUNNER_OS" == "Windows" ]]; then
ARCHIVE_NAME="textgen-portable-${VERSION_CLEAN}-${PLATFORM}-cuda${CUDA_VERSION}.zip"
echo "Creating archive: $ARCHIVE_NAME"
powershell -Command "Compress-Archive -Path text-generation-webui-${VERSION_CLEAN} -DestinationPath $ARCHIVE_NAME"
powershell -Command "Compress-Archive -Path textgen-${VERSION_CLEAN} -DestinationPath $ARCHIVE_NAME"
else
ARCHIVE_NAME="textgen-portable-${VERSION_CLEAN}-${PLATFORM}-cuda${CUDA_VERSION}.tar.gz"
echo "Creating archive: $ARCHIVE_NAME"
tar czf "$ARCHIVE_NAME" "text-generation-webui-${VERSION_CLEAN}"
tar czf "$ARCHIVE_NAME" "textgen-${VERSION_CLEAN}"
fi
- name: Upload files to a GitHub release

18
.github/workflows/build-portable-release-ik-cuda.yml vendored
View File

@@ -4,7 +4,7 @@ on:
workflow_dispatch:
inputs:
version:
description: 'Version tag of text-generation-webui to build: v3.0'
description: 'Version tag of textgen to build: v3.0'
default: 'v3.0'
required: true
type: string
@@ -21,7 +21,7 @@ on:
workflow_call:
inputs:
version:
description: 'Version tag of text-generation-webui to build: v3.0'
description: 'Version tag of textgen to build: v3.0'
default: 'v3.0'
required: true
type: string
@@ -88,7 +88,7 @@ jobs:
steps:
- uses: actions/checkout@v6
with:
repository: 'oobabooga/text-generation-webui'
repository: 'oobabooga/textgen'
ref: ${{ inputs.version }}
submodules: 'recursive'
@@ -102,8 +102,8 @@ jobs:
VERSION_CLEAN="${{ inputs.version }}"
VERSION_CLEAN="${VERSION_CLEAN#v}"
cd ..
cp -r text-generation-webui "text-generation-webui-ik-${VERSION_CLEAN}"
cd "text-generation-webui-ik-${VERSION_CLEAN}"
cp -r textgen "textgen-ik-${VERSION_CLEAN}"
cd "textgen-ik-${VERSION_CLEAN}"
# Remove extensions that need additional requirements
allowed=("character_bias" "gallery" "sd_api_pictures")
@@ -133,10 +133,10 @@ jobs:
echo "Downloading Python for $PLATFORM..."
curl -L -o python-build.tar.gz "$PYTHON_URL"
tar -xzf python-build.tar.gz
mv python "text-generation-webui-ik-${VERSION_CLEAN}/portable_env"
mv python "textgen-ik-${VERSION_CLEAN}/portable_env"
# 3. Prepare requirements file based on CUDA version
cd "text-generation-webui-ik-${VERSION_CLEAN}"
cd "textgen-ik-${VERSION_CLEAN}"
if [[ "$CUDA_VERSION" == "13.1" ]]; then
REQ_FILE="requirements/portable/requirements_ik_cuda131.txt"
else
@@ -158,11 +158,11 @@ jobs:
if [[ "$RUNNER_OS" == "Windows" ]]; then
ARCHIVE_NAME="textgen-portable-ik-${VERSION_CLEAN}-${PLATFORM}-cuda${CUDA_VERSION}.zip"
echo "Creating archive: $ARCHIVE_NAME"
powershell -Command "Compress-Archive -Path text-generation-webui-ik-${VERSION_CLEAN} -DestinationPath $ARCHIVE_NAME"
powershell -Command "Compress-Archive -Path textgen-ik-${VERSION_CLEAN} -DestinationPath $ARCHIVE_NAME"
else
ARCHIVE_NAME="textgen-portable-ik-${VERSION_CLEAN}-${PLATFORM}-cuda${CUDA_VERSION}.tar.gz"
echo "Creating archive: $ARCHIVE_NAME"
tar czf "$ARCHIVE_NAME" "text-generation-webui-ik-${VERSION_CLEAN}"
tar czf "$ARCHIVE_NAME" "textgen-ik-${VERSION_CLEAN}"
fi
- name: Upload files to a GitHub release

18
.github/workflows/build-portable-release-ik.yml vendored
View File

@@ -4,7 +4,7 @@ on:
workflow_dispatch:
inputs:
version:
description: 'Version tag of text-generation-webui to build: v3.0'
description: 'Version tag of textgen to build: v3.0'
default: 'v3.0'
required: true
type: string
@@ -21,7 +21,7 @@ on:
workflow_call:
inputs:
version:
description: 'Version tag of text-generation-webui to build: v3.0'
description: 'Version tag of textgen to build: v3.0'
default: 'v3.0'
required: true
type: string
@@ -87,7 +87,7 @@ jobs:
steps:
- uses: actions/checkout@v6
with:
repository: 'oobabooga/text-generation-webui'
repository: 'oobabooga/textgen'
ref: ${{ inputs.version }}
submodules: 'recursive'
@@ -101,8 +101,8 @@ jobs:
VERSION_CLEAN="${{ inputs.version }}"
VERSION_CLEAN="${VERSION_CLEAN#v}"
cd ..
cp -r text-generation-webui "text-generation-webui-ik-${VERSION_CLEAN}"
cd "text-generation-webui-ik-${VERSION_CLEAN}"
cp -r textgen "textgen-ik-${VERSION_CLEAN}"
cd "textgen-ik-${VERSION_CLEAN}"
# Remove extensions that need additional requirements
allowed=("character_bias" "gallery" "sd_api_pictures")
@@ -131,10 +131,10 @@ jobs:
cd ..
curl -L -o python-build.tar.gz "$PYTHON_URL"
tar -xzf python-build.tar.gz
mv python "text-generation-webui-ik-${VERSION_CLEAN}/portable_env"
mv python "textgen-ik-${VERSION_CLEAN}/portable_env"
# 3. Prepare requirements file
cd "text-generation-webui-ik-${VERSION_CLEAN}"
cd "textgen-ik-${VERSION_CLEAN}"
REQ_FILE="requirements/portable/requirements_ik_cpu_only.txt"
echo "Using requirements file: $REQ_FILE"
@@ -153,11 +153,11 @@ jobs:
if [[ "$RUNNER_OS" == "Windows" ]]; then
ARCHIVE_NAME="textgen-portable-ik-${VERSION_CLEAN}-${PLATFORM}.zip"
echo "Creating archive: $ARCHIVE_NAME"
powershell -Command "Compress-Archive -Path text-generation-webui-ik-${VERSION_CLEAN} -DestinationPath $ARCHIVE_NAME"
powershell -Command "Compress-Archive -Path textgen-ik-${VERSION_CLEAN} -DestinationPath $ARCHIVE_NAME"
else
ARCHIVE_NAME="textgen-portable-ik-${VERSION_CLEAN}-${PLATFORM}.tar.gz"
echo "Creating archive: $ARCHIVE_NAME"
tar czf "$ARCHIVE_NAME" "text-generation-webui-ik-${VERSION_CLEAN}"
tar czf "$ARCHIVE_NAME" "textgen-ik-${VERSION_CLEAN}"
fi
- name: Upload files to a GitHub release

18
.github/workflows/build-portable-release-rocm.yml vendored
View File

@@ -4,7 +4,7 @@ on:
workflow_dispatch:
inputs:
version:
description: 'Version tag of text-generation-webui to build: v3.0'
description: 'Version tag of textgen to build: v3.0'
default: 'v3.0'
required: true
type: string
@@ -21,7 +21,7 @@ on:
workflow_call:
inputs:
version:
description: 'Version tag of text-generation-webui to build: v3.0'
description: 'Version tag of textgen to build: v3.0'
default: 'v3.0'
required: true
type: string
@@ -87,7 +87,7 @@ jobs:
steps:
- uses: actions/checkout@v6
with:
repository: 'oobabooga/text-generation-webui'
repository: 'oobabooga/textgen'
ref: ${{ inputs.version }}
submodules: 'recursive'
@@ -101,8 +101,8 @@ jobs:
VERSION_CLEAN="${{ inputs.version }}"
VERSION_CLEAN="${VERSION_CLEAN#v}"
cd ..
cp -r text-generation-webui "text-generation-webui-${VERSION_CLEAN}"
cd "text-generation-webui-${VERSION_CLEAN}"
cp -r textgen "textgen-${VERSION_CLEAN}"
cd "textgen-${VERSION_CLEAN}"
# Remove extensions that need additional requirements
allowed=("character_bias" "gallery" "sd_api_pictures")
@@ -131,12 +131,12 @@ jobs:
echo "Downloading Python for $PLATFORM..."
curl -L -o python-build.tar.gz "$PYTHON_URL"
tar -xzf python-build.tar.gz
mv python "text-generation-webui-${VERSION_CLEAN}/portable_env"
mv python "textgen-${VERSION_CLEAN}/portable_env"
# 3. Prepare requirements file
REQ_FILE="requirements/portable/requirements_amd.txt"
cd "text-generation-webui-${VERSION_CLEAN}"
cd "textgen-${VERSION_CLEAN}"
# 4. Install packages
echo "Installing Python packages from $REQ_FILE..."
@@ -150,11 +150,11 @@ jobs:
if [[ "$RUNNER_OS" == "Windows" ]]; then
ARCHIVE_NAME="textgen-portable-${VERSION_CLEAN}-${PLATFORM}-rocm7.2.zip"
echo "Creating archive: $ARCHIVE_NAME"
powershell -Command "Compress-Archive -Path text-generation-webui-${VERSION_CLEAN} -DestinationPath $ARCHIVE_NAME"
powershell -Command "Compress-Archive -Path textgen-${VERSION_CLEAN} -DestinationPath $ARCHIVE_NAME"
else
ARCHIVE_NAME="textgen-portable-${VERSION_CLEAN}-${PLATFORM}-rocm7.2.tar.gz"
echo "Creating archive: $ARCHIVE_NAME"
tar czf "$ARCHIVE_NAME" "text-generation-webui-${VERSION_CLEAN}"
tar czf "$ARCHIVE_NAME" "textgen-${VERSION_CLEAN}"
fi
- name: Upload files to a GitHub release

18
.github/workflows/build-portable-release-vulkan.yml vendored
View File

@@ -4,7 +4,7 @@ on:
workflow_dispatch:
inputs:
version:
description: 'Version tag of text-generation-webui to build: v3.0'
description: 'Version tag of textgen to build: v3.0'
default: 'v3.0'
required: true
type: string
@@ -21,7 +21,7 @@ on:
workflow_call:
inputs:
version:
description: 'Version tag of text-generation-webui to build: v3.0'
description: 'Version tag of textgen to build: v3.0'
default: 'v3.0'
required: true
type: string
@@ -87,7 +87,7 @@ jobs:
steps:
- uses: actions/checkout@v6
with:
repository: 'oobabooga/text-generation-webui'
repository: 'oobabooga/textgen'
ref: ${{ inputs.version }}
submodules: 'recursive'
@@ -101,8 +101,8 @@ jobs:
VERSION_CLEAN="${{ inputs.version }}"
VERSION_CLEAN="${VERSION_CLEAN#v}"
cd ..
cp -r text-generation-webui "text-generation-webui-${VERSION_CLEAN}"
cd "text-generation-webui-${VERSION_CLEAN}"
cp -r textgen "textgen-${VERSION_CLEAN}"
cd "textgen-${VERSION_CLEAN}"
# Remove extensions that need additional requirements
allowed=("character_bias" "gallery" "sd_api_pictures")
@@ -131,12 +131,12 @@ jobs:
echo "Downloading Python for $PLATFORM..."
curl -L -o python-build.tar.gz "$PYTHON_URL"
tar -xzf python-build.tar.gz
mv python "text-generation-webui-${VERSION_CLEAN}/portable_env"
mv python "textgen-${VERSION_CLEAN}/portable_env"
# 3. Prepare requirements file
REQ_FILE="requirements/portable/requirements_vulkan.txt"
cd "text-generation-webui-${VERSION_CLEAN}"
cd "textgen-${VERSION_CLEAN}"
# 4. Install packages
echo "Installing Python packages from $REQ_FILE..."
@@ -150,11 +150,11 @@ jobs:
if [[ "$RUNNER_OS" == "Windows" ]]; then
ARCHIVE_NAME="textgen-portable-${VERSION_CLEAN}-${PLATFORM}-vulkan.zip"
echo "Creating archive: $ARCHIVE_NAME"
powershell -Command "Compress-Archive -Path text-generation-webui-${VERSION_CLEAN} -DestinationPath $ARCHIVE_NAME"
powershell -Command "Compress-Archive -Path textgen-${VERSION_CLEAN} -DestinationPath $ARCHIVE_NAME"
else
ARCHIVE_NAME="textgen-portable-${VERSION_CLEAN}-${PLATFORM}-vulkan.tar.gz"
echo "Creating archive: $ARCHIVE_NAME"
tar czf "$ARCHIVE_NAME" "text-generation-webui-${VERSION_CLEAN}"
tar czf "$ARCHIVE_NAME" "textgen-${VERSION_CLEAN}"
fi
- name: Upload files to a GitHub release

18
.github/workflows/build-portable-release.yml vendored
View File

@@ -4,7 +4,7 @@ on:
workflow_dispatch:
inputs:
version:
description: 'Version tag of text-generation-webui to build: v3.0'
description: 'Version tag of textgen to build: v3.0'
default: 'v3.0'
required: true
type: string
@@ -21,7 +21,7 @@ on:
workflow_call:
inputs:
version:
description: 'Version tag of text-generation-webui to build: v3.0'
description: 'Version tag of textgen to build: v3.0'
default: 'v3.0'
required: true
type: string
@@ -87,7 +87,7 @@ jobs:
steps:
- uses: actions/checkout@v6
with:
repository: 'oobabooga/text-generation-webui'
repository: 'oobabooga/textgen'
ref: ${{ inputs.version }}
submodules: 'recursive'
@@ -101,8 +101,8 @@ jobs:
VERSION_CLEAN="${{ inputs.version }}"
VERSION_CLEAN="${VERSION_CLEAN#v}"
cd ..
cp -r text-generation-webui "text-generation-webui-${VERSION_CLEAN}"
cd "text-generation-webui-${VERSION_CLEAN}"
cp -r textgen "textgen-${VERSION_CLEAN}"
cd "textgen-${VERSION_CLEAN}"
# Remove extensions that need additional requirements
allowed=("character_bias" "gallery" "sd_api_pictures")
@@ -146,10 +146,10 @@ jobs:
cd ..
curl -L -o python-build.tar.gz "$PYTHON_URL"
tar -xzf python-build.tar.gz
mv python "text-generation-webui-${VERSION_CLEAN}/portable_env"
mv python "textgen-${VERSION_CLEAN}/portable_env"
# 3. Prepare requirements file based on platform
cd "text-generation-webui-${VERSION_CLEAN}"
cd "textgen-${VERSION_CLEAN}"
# Select requirements file based on platform
if [[ "$RUNNER_OS" == "macOS" ]]; then
@@ -176,11 +176,11 @@ jobs:
if [[ "$RUNNER_OS" == "Windows" ]]; then
ARCHIVE_NAME="textgen-portable-${VERSION_CLEAN}-${PLATFORM}.zip"
echo "Creating archive: $ARCHIVE_NAME"
powershell -Command "Compress-Archive -Path text-generation-webui-${VERSION_CLEAN} -DestinationPath $ARCHIVE_NAME"
powershell -Command "Compress-Archive -Path textgen-${VERSION_CLEAN} -DestinationPath $ARCHIVE_NAME"
else
ARCHIVE_NAME="textgen-portable-${VERSION_CLEAN}-${PLATFORM}.tar.gz"
echo "Creating archive: $ARCHIVE_NAME"
tar czf "$ARCHIVE_NAME" "text-generation-webui-${VERSION_CLEAN}"
tar czf "$ARCHIVE_NAME" "textgen-${VERSION_CLEAN}"
fi
- name: Upload files to a GitHub release

10
Colab-TextGen-GPU.ipynb
View File

@@ -20,11 +20,11 @@
{
"cell_type": "markdown",
"source": [
"# oobabooga/text-generation-webui\n",
"# oobabooga/textgen\n",
"\n",
"After running both cells, a public gradio URL will appear at the bottom in around 10 minutes. You can optionally generate an API link.\n",
"\n",
"* Project page: https://github.com/oobabooga/text-generation-webui\n",
"* Project page: https://github.com/oobabooga/textgen\n",
"* Gradio server status: https://status.gradio.app/"
],
"metadata": {
@@ -59,11 +59,11 @@
"os.environ.pop('PYTHONPATH', None)\n",
"os.environ.pop('MPLBACKEND', None)\n",
"\n",
"if Path.cwd().name != 'text-generation-webui':\n",
"if Path.cwd().name != 'textgen':\n",
" print(\"\\033[1;32;1m\\n --> Installing the web UI. This will take a while, but after the initial setup, you can download and test as many models as you like.\\033[0;37;0m\\n\")\n",
"\n",
" !git clone https://github.com/oobabooga/text-generation-webui\n",
" %cd text-generation-webui\n",
" !git clone https://github.com/oobabooga/textgen\n",
" %cd textgen\n",
"\n",
" # Install the project in an isolated environment\n",
" !GPU_CHOICE=A \\\n",

38
README.md
View File

@@ -25,20 +25,20 @@ My GGUF quantization benchmarks on [LocalBench](https://localbench.substack.com)
## Features
- **Easy setup**: [Portable builds](https://github.com/oobabooga/text-generation-webui/releases) (zero setup, just unzip and run) for GGUF models on Windows/Linux/macOS, or a one-click installer for the full feature set.
- **Easy setup**: [Portable builds](https://github.com/oobabooga/textgen/releases) (zero setup, just unzip and run) for GGUF models on Windows/Linux/macOS, or a one-click installer for the full feature set.
- **Multiple backends**: [llama.cpp](https://github.com/ggerganov/llama.cpp), [ik_llama.cpp](https://github.com/ikawrakow/ik_llama.cpp), [Transformers](https://github.com/huggingface/transformers), [ExLlamaV3](https://github.com/turboderp-org/exllamav3), and [TensorRT-LLM](https://github.com/NVIDIA/TensorRT-LLM). Switch between backends and models without restarting.
- **OpenAI/Anthropic-compatible API**: Chat, Completions, and Messages endpoints with tool-calling support. Use as a local drop-in replacement for the OpenAI/Anthropic APIs ([examples](https://github.com/oobabooga/text-generation-webui/wiki/12-%E2%80%90-OpenAI-API#examples)).
- **Tool-calling**: Models can call custom functions during chat, including web search, page fetching, and math. Each tool is a single `.py` file. MCP servers are also supported ([tutorial](https://github.com/oobabooga/text-generation-webui/wiki/Tool-Calling-Tutorial)).
- **Vision (multimodal)**: Attach images to messages for visual understanding ([tutorial](https://github.com/oobabooga/text-generation-webui/wiki/Multimodal-Tutorial)).
- **OpenAI/Anthropic-compatible API**: Chat, Completions, and Messages endpoints with tool-calling support. Use as a local drop-in replacement for the OpenAI/Anthropic APIs ([examples](https://github.com/oobabooga/textgen/wiki/12-%E2%80%90-OpenAI-API#examples)).
- **Tool-calling**: Models can call custom functions during chat, including web search, page fetching, and math. Each tool is a single `.py` file. MCP servers are also supported ([tutorial](https://github.com/oobabooga/textgen/wiki/Tool-Calling-Tutorial)).
- **Vision (multimodal)**: Attach images to messages for visual understanding ([tutorial](https://github.com/oobabooga/textgen/wiki/Multimodal-Tutorial)).
- **File attachments**: Upload text files, PDF documents, and .docx documents to talk about their contents.
- **Training**: Fine-tune LoRAs on multi-turn chat or raw text datasets. Supports resuming interrupted runs ([tutorial](https://github.com/oobabooga/text-generation-webui/wiki/05-%E2%80%90-Training-Tab)).
- **Image generation**: A dedicated tab for `diffusers` models like **Z-Image-Turbo**. Features 4-bit/8-bit quantization and a persistent gallery with metadata ([tutorial](https://github.com/oobabooga/text-generation-webui/wiki/Image-Generation-Tutorial)).
- **Training**: Fine-tune LoRAs on multi-turn chat or raw text datasets. Supports resuming interrupted runs ([tutorial](https://github.com/oobabooga/textgen/wiki/05-%E2%80%90-Training-Tab)).
- **Image generation**: A dedicated tab for `diffusers` models like **Z-Image-Turbo**. Features 4-bit/8-bit quantization and a persistent gallery with metadata ([tutorial](https://github.com/oobabooga/textgen/wiki/Image-Generation-Tutorial)).
- 100% offline and private, with zero telemetry, external resources, or remote update requests.
- `instruct` mode for instruction-following (like ChatGPT), and `chat-instruct`/`chat` modes for talking to custom characters. Prompts are automatically formatted with Jinja2 templates.
- Edit messages, navigate between message versions, and branch conversations at any point.
- Free-form text generation in the Notebook tab without being limited to chat turns.
- Dark/light themes, syntax highlighting for code blocks, and LaTeX rendering for mathematical expressions.
- Extension support, with built-in and user-contributed extensions available. See the [wiki](https://github.com/oobabooga/text-generation-webui/wiki/07-%E2%80%90-Extensions) and [extensions directory](https://github.com/oobabooga/text-generation-webui-extensions) for details.
- Extension support, with built-in and user-contributed extensions available. See the [wiki](https://github.com/oobabooga/textgen/wiki/07-%E2%80%90-Extensions) and [extensions directory](https://github.com/oobabooga/textgen-extensions) for details.
## How to install
@@ -46,7 +46,7 @@ My GGUF quantization benchmarks on [LocalBench](https://localbench.substack.com)
No installation needed – just download, unzip and run. All dependencies included.
Download from here: **https://github.com/oobabooga/text-generation-webui/releases**
Download from here: **https://github.com/oobabooga/textgen/releases**
- Builds are provided for Linux, Windows, and macOS, with options for CUDA, Vulkan, ROCm, and CPU-only.
- Compatible with GGUF (llama.cpp) models.
@@ -57,8 +57,8 @@ Fast setup on any Python 3.9+:
```bash
# Clone repository
git clone https://github.com/oobabooga/text-generation-webui
cd text-generation-webui
git clone https://github.com/oobabooga/textgen
cd textgen
# Create virtual environment
python -m venv venv
@@ -83,7 +83,7 @@ deactivate
For users who need additional backends (ExLlamaV3, Transformers), training, image generation, or extensions (TTS, voice input, translation, etc). Requires ~10GB disk space and downloads PyTorch.
1. Clone the repository, or [download its source code](https://github.com/oobabooga/text-generation-webui/archive/refs/heads/main.zip) and extract it.
1. Clone the repository, or [download its source code](https://github.com/oobabooga/textgen/archive/refs/heads/main.zip) and extract it.
2. Run the startup script for your OS: `start_windows.bat`, `start_linux.sh`, or `start_macos.sh`.
3. When prompted, select your GPU vendor.
4. After installation, open `http://127.0.0.1:7860` in your browser.
@@ -162,8 +162,8 @@ conda install -y -c "nvidia/label/cuda-12.8.1" cuda
#### 3. Install the web UI
```
git clone https://github.com/oobabooga/text-generation-webui
cd text-generation-webui
git clone https://github.com/oobabooga/textgen
cd textgen
pip install -r requirements/full/<requirements file according to table below>
```
@@ -181,7 +181,7 @@ Requirements file to use:
```
conda activate textgen
cd text-generation-webui
cd textgen
python server.py
```
@@ -216,7 +216,7 @@ mkdir -p user_data/logs user_data/cache
docker compose up --build
```
* You need to have Docker Compose v2.17 or higher installed. See [this guide](https://github.com/oobabooga/text-generation-webui/wiki/09-%E2%80%90-Docker) for instructions.
* You need to have Docker Compose v2.17 or higher installed. See [this guide](https://github.com/oobabooga/textgen/wiki/09-%E2%80%90-Docker) for instructions.
* For additional docker files, check out [this repository](https://github.com/Atinoda/text-generation-webui-docker).
### Updating the requirements
@@ -225,7 +225,7 @@ From time to time, the `requirements*.txt` change. To update, use these commands
```
conda activate textgen
cd text-generation-webui
cd textgen
pip install -r <requirements file that you have used> --upgrade
```
</details>
@@ -255,7 +255,7 @@ usage: server.py [-h] [--user-data-dir USER_DATA_DIR] [--multi-user] [--model MO
[--do-sample | --no-do-sample] [--dynamic-temperature | --no-dynamic-temperature] [--temperature-last | --no-temperature-last] [--sampler-priority N] [--dry-sequence-breakers N]
[--enable-thinking | --no-enable-thinking] [--reasoning-effort N] [--chat-template-file CHAT_TEMPLATE_FILE]
Text Generation Web UI
TextGen
options:
-h, --help show this help message and exit
@@ -437,7 +437,7 @@ To estimate how much memory a model will use, you can use the [GGUF Memory Calcu
Models that consist of multiple files (like 16-bit Transformers models and EXL3 models) should be placed in a subfolder inside `user_data/models`:
```
text-generation-webui
textgen
└── user_data
└── models
└── Qwen_Qwen3-8B
@@ -454,7 +454,7 @@ These formats require the one-click installer (not the portable build).
## Documentation
https://github.com/oobabooga/text-generation-webui/wiki
https://github.com/oobabooga/textgen/wiki
## Community

6
docker/TensorRT-LLM/Dockerfile
View File

@@ -9,9 +9,9 @@ WORKDIR /app
# This is needed to avoid an error about "Failed to build mpi4py" in the next command
ENV LD_LIBRARY_PATH=/usr/lib/x86_64-linux-gnu:$LD_LIBRARY_PATH
# Install text-generation-webui
RUN git clone https://github.com/oobabooga/text-generation-webui
WORKDIR /app/text-generation-webui
# Install textgen
RUN git clone https://github.com/oobabooga/textgen
WORKDIR /app/textgen
RUN pip install --break-system-packages -r requirements/full/requirements.txt
# Install TensorRT-LLM

8
docker/amd/Dockerfile
View File

@@ -10,10 +10,10 @@ RUN --mount=type=cache,target=/var/cache/apt,sharing=locked,rw \
apt install --no-install-recommends -y git vim build-essential python3-dev pip bash curl && \
rm -rf /var/lib/apt/lists/*
WORKDIR /home/app/
RUN git clone https://github.com/oobabooga/text-generation-webui.git
WORKDIR /home/app/text-generation-webui
RUN git clone https://github.com/oobabooga/textgen.git
WORKDIR /home/app/textgen
RUN GPU_CHOICE=B LAUNCH_AFTER_INSTALL=FALSE INSTALL_EXTENSIONS=TRUE ./start_linux.sh --verbose
EXPOSE ${CONTAINER_PORT:-7860} ${CONTAINER_API_PORT:-5000}
WORKDIR /home/app/text-generation-webui
WORKDIR /home/app/textgen
# set umask to ensure group read / write at runtime
CMD umask 0002 && export HOME=/home/app/text-generation-webui && ./start_linux.sh --listen
CMD umask 0002 && export HOME=/home/app/textgen && ./start_linux.sh --listen

4
docker/amd/docker-compose.yml
View File

@@ -1,6 +1,6 @@
version: "3.3"
services:
text-generation-webui:
textgen:
build:
context: .
args:
@@ -25,4 +25,4 @@ services:
security_opt:
- seccomp=unconfined
volumes:
- ./user_data:/home/app/text-generation-webui/user_data
- ./user_data:/home/app/textgen/user_data

8
docker/cpu/Dockerfile
View File

@@ -10,10 +10,10 @@ RUN --mount=type=cache,target=/var/cache/apt,sharing=locked,rw \
apt install --no-install-recommends -y git vim build-essential python3-dev pip bash curl && \
rm -rf /var/lib/apt/lists/*
WORKDIR /home/app/
RUN git clone https://github.com/oobabooga/text-generation-webui.git
WORKDIR /home/app/text-generation-webui
RUN git clone https://github.com/oobabooga/textgen.git
WORKDIR /home/app/textgen
RUN GPU_CHOICE=N LAUNCH_AFTER_INSTALL=FALSE INSTALL_EXTENSIONS=TRUE ./start_linux.sh --verbose
EXPOSE ${CONTAINER_PORT:-7860} ${CONTAINER_API_PORT:-5000}
# set umask to ensure group read / write at runtime
WORKDIR /home/app/text-generation-webui
CMD umask 0002 && export HOME=/home/app/text-generation-webui && ./start_linux.sh --listen
WORKDIR /home/app/textgen
CMD umask 0002 && export HOME=/home/app/textgen && ./start_linux.sh --listen

4
docker/cpu/docker-compose.yml
View File

@@ -1,6 +1,6 @@
version: "3.3"
services:
text-generation-webui:
textgen:
build:
context: .
args:
@@ -15,4 +15,4 @@ services:
stdin_open: true
tty: true
volumes:
- ./user_data:/home/app/text-generation-webui/user_data
- ./user_data:/home/app/textgen/user_data

8
docker/intel/Dockerfile
View File

@@ -10,10 +10,10 @@ RUN --mount=type=cache,target=/var/cache/apt,sharing=locked,rw \
apt install --no-install-recommends -y git vim build-essential python3-dev pip bash curl && \
rm -rf /var/lib/apt/lists/*
WORKDIR /home/app/
RUN git clone https://github.com/oobabooga/text-generation-webui.git
WORKDIR /home/app/text-generation-webui
RUN git clone https://github.com/oobabooga/textgen.git
WORKDIR /home/app/textgen
RUN GPU_CHOICE=D LAUNCH_AFTER_INSTALL=FALSE INSTALL_EXTENSIONS=TRUE ./start_linux.sh --verbose
EXPOSE ${CONTAINER_PORT:-7860} ${CONTAINER_API_PORT:-5000}
# set umask to ensure group read / write at runtime
WORKDIR /home/app/text-generation-webui
CMD umask 0002 && export HOME=/home/app/text-generation-webui && ./start_linux.sh --listen
WORKDIR /home/app/textgen
CMD umask 0002 && export HOME=/home/app/textgen && ./start_linux.sh --listen

4
docker/intel/docker-compose.yml
View File

@@ -1,6 +1,6 @@
version: "3.3"
services:
text-generation-webui:
textgen:
build:
context: .
args:
@@ -25,4 +25,4 @@ services:
security_opt:
- seccomp=unconfined
volumes:
- ./user_data:/home/app/text-generation-webui/user_data
- ./user_data:/home/app/textgen/user_data

8
docker/nvidia/Dockerfile
View File

@@ -11,10 +11,10 @@ RUN --mount=type=cache,target=/var/cache/apt,sharing=locked,rw \
apt install --no-install-recommends -y git vim build-essential python3-dev pip bash curl && \
rm -rf /var/lib/apt/lists/*
WORKDIR /home/app/
RUN git clone https://github.com/oobabooga/text-generation-webui.git
WORKDIR /home/app/text-generation-webui
RUN git clone https://github.com/oobabooga/textgen.git
WORKDIR /home/app/textgen
RUN GPU_CHOICE=A LAUNCH_AFTER_INSTALL=FALSE INSTALL_EXTENSIONS=TRUE ./start_linux.sh --verbose
EXPOSE ${CONTAINER_PORT:-7860} ${CONTAINER_API_PORT:-5000}
WORKDIR /home/app/text-generation-webui
WORKDIR /home/app/textgen
# set umask to ensure group read / write at runtime
CMD umask 0002 && export HOME=/home/app/text-generation-webui && ./start_linux.sh --listen
CMD umask 0002 && export HOME=/home/app/textgen && ./start_linux.sh --listen

4
docker/nvidia/docker-compose.yml
View File

@@ -1,6 +1,6 @@
version: "3.3"
services:
text-generation-webui:
textgen:
build:
context: .
args:
@@ -17,7 +17,7 @@ services:
stdin_open: true
tty: true
volumes:
- ./user_data:/home/app/text-generation-webui/user_data
- ./user_data:/home/app/textgen/user_data
deploy:
resources:
reservations:

8
docs/01 - Chat Tab.md
View File

@@ -146,14 +146,14 @@ Note that you can get creative: instead of writing something trivial like "Write
And it works:
![chat-instruct](https://github.com/oobabooga/text-generation-webui/assets/112222186/e38e3469-8263-4a10-b1a1-3c955026b8e7)
![chat-instruct](https://github.com/oobabooga/textgen/assets/112222186/e38e3469-8263-4a10-b1a1-3c955026b8e7)
## Chat style
This defines the visual style of the chat UI. Each option is a CSS file defined under `text-generation-webui/css/chat_style-name.css`, where "name" is how this style is called in the dropdown menu. You can add new styles by simply copying `chat_style-cai-chat.css` to `chat_style-myNewStyle.css` and editing the contents of this new file. If you end up with a style that you like, you are highly encouraged to submit it to the repository.
This defines the visual style of the chat UI. Each option is a CSS file defined under `textgen/css/chat_style-name.css`, where "name" is how this style is called in the dropdown menu. You can add new styles by simply copying `chat_style-cai-chat.css` to `chat_style-myNewStyle.css` and editing the contents of this new file. If you end up with a style that you like, you are highly encouraged to submit it to the repository.
The styles are only applied to chat and chat-instruct modes. Instruct mode has its separate style defined in `text-generation-webui/css/html_instruct_style.css`.
The styles are only applied to chat and chat-instruct modes. Instruct mode has its separate style defined in `textgen/css/html_instruct_style.css`.
## Character gallery
This menu is a built-in extension defined under `text-generation-webui/extensions/gallery`. It displays a gallery with your characters, and if you click on a character, it will be automatically selected in the Character tab.
This menu is a built-in extension defined under `textgen/extensions/gallery`. It displays a gallery with your characters, and if you click on a character, it will be automatically selected in the Character tab.

2
docs/02 - Default and Notebook Tabs.md
View File

@@ -22,7 +22,7 @@ Five tabs can be found:
* **Raw**: where the raw text generated by the model appears.
* **Markdown**: it contains a "Render" button. You can click on it at any time to render the current output as markdown. This is particularly useful for models that generate LaTeX equations like GALACTICA.
* **HTML**: displays the output in an HTML style that is meant to be easier to read. Its style is defined under `text-generation-webui/css/html_readable_style.css`.
* **HTML**: displays the output in an HTML style that is meant to be easier to read. Its style is defined under `textgen/css/html_readable_style.css`.
* **Logits**: when you click on "Get next token probabilities", this tab displays the 50 most likely next tokens and their probabilities based on your current input. If "Use samplers" is checked, the probabilities will be the ones after the sampling parameters in the "Parameters" > "Generation" tab are applied. Otherwise, they will be the raw probabilities generated by the model.
* **Tokens**: allows you to tokenize your prompt and see the ID numbers for the individual tokens.

2
docs/04 - Model Tab.md
View File

@@ -92,7 +92,7 @@ If the **Autoload the model** checkbox is selected, the model will be loaded as
## LoRA dropdown
Used to apply LoRAs to the model. Note that LoRA support is not implemented for all loaders. Check the [What Works](https://github.com/oobabooga/text-generation-webui/wiki/What-Works) page for details.
Used to apply LoRAs to the model. Note that LoRA support is not implemented for all loaders. Check the [What Works](https://github.com/oobabooga/textgen/wiki/What-Works) page for details.
## Download model or LoRA

4
docs/06 - Session Tab.md
View File

@@ -9,14 +9,14 @@ Here you can restart the UI with new settings.
## Extensions & flags
* **Available extensions**: shows a list of extensions available under `text-generation-webui/extensions` and `text-generation-webui/user_data/extensions`. Note that some of these extensions may require manually installing Python requirements through the command: `pip install -r extensions/extension_name/requirements.txt`.
* **Available extensions**: shows a list of extensions available under `textgen/extensions` and `textgen/user_data/extensions`. Note that some of these extensions may require manually installing Python requirements through the command: `pip install -r extensions/extension_name/requirements.txt`.
* **Boolean command-line flags**: shows command-line flags of bool (true/false) type.
After selecting your desired flags and extensions, you can restart the UI by clicking on **Apply flags/extensions and restart**.
## Install or update an extension
In this field, you can enter the GitHub URL for an extension and press enter to either install it (i.e. cloning it into `text-generation-webui/extensions`) or update it with `git pull` in case it is already cloned.
In this field, you can enter the GitHub URL for an extension and press enter to either install it (i.e. cloning it into `textgen/extensions`) or update it with `git pull` in case it is already cloned.
Note that some extensions may include additional Python requirements. In this case, to install those you have to run the command

34
docs/07 - Extensions.md
View File

@@ -1,8 +1,8 @@
# Extensions
Extensions are defined by files named `script.py` inside subfolders of either:
- `text-generation-webui/extensions`
- `text-generation-webui/user_data/extensions`
- `textgen/extensions`
- `textgen/user_data/extensions`
They are loaded at startup if the folder name is specified after the `--extensions` flag.
@@ -10,7 +10,7 @@ For instance, `extensions/silero_tts/script.py` or `user_data/extensions/silero_
**Note:** Extensions in `user_data/extensions/` take priority over those in `extensions/` when both exist with the same name.
## [text-generation-webui-extensions](https://github.com/oobabooga/text-generation-webui-extensions)
## [textgen-extensions](https://github.com/oobabooga/textgen-extensions)
The repository above contains a directory of user extensions.
@@ -20,19 +20,19 @@ If you create an extension, you are welcome to host it in a GitHub repository an
|Extension|Description|
|---------|-----------|
|[superboogav2](https://github.com/oobabooga/text-generation-webui/tree/main/extensions/superboogav2)| Enhanced RAG extension with support for PDF, DOCX, and PPTX files. |
|[send_pictures](https://github.com/oobabooga/text-generation-webui/blob/main/extensions/send_pictures/)| Creates an image upload field that can be used to send images to the bot in chat mode. Captions are automatically generated using BLIP. |
|[coqui_tts](https://github.com/oobabooga/text-generation-webui/tree/main/extensions/coqui_tts)| Text-to-speech extension using Coqui XTTS v2. |
|[silero_tts](https://github.com/oobabooga/text-generation-webui/tree/main/extensions/silero_tts)| Text-to-speech extension using [Silero](https://github.com/snakers4/silero-models). When used in chat mode, responses are replaced with an audio widget. |
|[whisper_stt](https://github.com/oobabooga/text-generation-webui/tree/main/extensions/whisper_stt)| Allows you to enter your inputs in chat mode using your microphone. |
|[perplexity_colors](https://github.com/oobabooga/text-generation-webui/tree/main/extensions/perplexity_colors)| Colors each token in the output text by its associated probability, as derived from the model logits. |
|[google_translate](https://github.com/oobabooga/text-generation-webui/tree/main/extensions/google_translate)| Automatically translates inputs and outputs using Google Translate.|
|[gallery](https://github.com/oobabooga/text-generation-webui/blob/main/extensions/gallery/)| Creates a gallery with the chat characters and their pictures. |
|[sd_api_pictures](https://github.com/oobabooga/text-generation-webui/tree/main/extensions/sd_api_pictures)| Allows you to request pictures from the bot in chat mode, which will be generated using the AUTOMATIC1111 Stable Diffusion API. See examples [here](https://github.com/oobabooga/text-generation-webui/pull/309). |
|[long_replies](https://github.com/oobabooga/text-generation-webui/tree/main/extensions/long_replies)| Forces longer replies by suppressing early newlines in the model output. |
|[ngrok](https://github.com/oobabooga/text-generation-webui/tree/main/extensions/ngrok)| Allows you to access the web UI remotely using the ngrok reverse tunnel service (free). It's an alternative to the built-in Gradio `--share` feature. |
|[superbooga](https://github.com/oobabooga/text-generation-webui/tree/main/extensions/superbooga)| An extension that uses ChromaDB to create an arbitrarily large pseudocontext, taking as input text files, URLs, or pasted text. Based on https://github.com/kaiokendev/superbig. |
|[character_bias](https://github.com/oobabooga/text-generation-webui/tree/main/extensions/character_bias)| Just a very simple example that adds a hidden string at the beginning of the bot's reply in chat mode. |
|[superboogav2](https://github.com/oobabooga/textgen/tree/main/extensions/superboogav2)| Enhanced RAG extension with support for PDF, DOCX, and PPTX files. |
|[send_pictures](https://github.com/oobabooga/textgen/blob/main/extensions/send_pictures/)| Creates an image upload field that can be used to send images to the bot in chat mode. Captions are automatically generated using BLIP. |
|[coqui_tts](https://github.com/oobabooga/textgen/tree/main/extensions/coqui_tts)| Text-to-speech extension using Coqui XTTS v2. |
|[silero_tts](https://github.com/oobabooga/textgen/tree/main/extensions/silero_tts)| Text-to-speech extension using [Silero](https://github.com/snakers4/silero-models). When used in chat mode, responses are replaced with an audio widget. |
|[whisper_stt](https://github.com/oobabooga/textgen/tree/main/extensions/whisper_stt)| Allows you to enter your inputs in chat mode using your microphone. |
|[perplexity_colors](https://github.com/oobabooga/textgen/tree/main/extensions/perplexity_colors)| Colors each token in the output text by its associated probability, as derived from the model logits. |
|[google_translate](https://github.com/oobabooga/textgen/tree/main/extensions/google_translate)| Automatically translates inputs and outputs using Google Translate.|
|[gallery](https://github.com/oobabooga/textgen/blob/main/extensions/gallery/)| Creates a gallery with the chat characters and their pictures. |
|[sd_api_pictures](https://github.com/oobabooga/textgen/tree/main/extensions/sd_api_pictures)| Allows you to request pictures from the bot in chat mode, which will be generated using the AUTOMATIC1111 Stable Diffusion API. See examples [here](https://github.com/oobabooga/textgen/pull/309). |
|[long_replies](https://github.com/oobabooga/textgen/tree/main/extensions/long_replies)| Forces longer replies by suppressing early newlines in the model output. |
|[ngrok](https://github.com/oobabooga/textgen/tree/main/extensions/ngrok)| Allows you to access the web UI remotely using the ngrok reverse tunnel service (free). It's an alternative to the built-in Gradio `--share` feature. |
|[superbooga](https://github.com/oobabooga/textgen/tree/main/extensions/superbooga)| An extension that uses ChromaDB to create an arbitrarily large pseudocontext, taking as input text files, URLs, or pasted text. Based on https://github.com/kaiokendev/superbig. |
|[character_bias](https://github.com/oobabooga/textgen/tree/main/extensions/character_bias)| Just a very simple example that adds a hidden string at the beginning of the bot's reply in chat mode. |
## How to write an extension
@@ -104,7 +104,7 @@ only the first declaration encountered will be used and the rest will be ignored
## A full example
The source code below can be found at [extensions/example/script.py](https://github.com/oobabooga/text-generation-webui/tree/main/extensions/example/script.py).
The source code below can be found at [extensions/example/script.py](https://github.com/oobabooga/textgen/tree/main/extensions/example/script.py).
```python
"""

2
docs/08 - Additional Tips.md
View File

@@ -1,6 +1,6 @@
## Audio notification
If your computer takes a long time to generate each response for the model that you are using, you can enable an audio notification for when the response is completed. This feature was kindly contributed by HappyWorldGames in [#1277](https://github.com/oobabooga/text-generation-webui/pull/1277).
If your computer takes a long time to generate each response for the model that you are using, you can enable an audio notification for when the response is completed. This feature was kindly contributed by HappyWorldGames in [#1277](https://github.com/oobabooga/textgen/pull/1277).
### Installation

2
docs/09 - Docker.md
View File

@@ -27,7 +27,7 @@ There are four Docker variants available under `docker/`:
To launch (using NVIDIA as an example):
```bash
cd text-generation-webui/docker/nvidia
cd textgen/docker/nvidia
cp ../.env.example .env
# Optionally edit .env to customize ports, TORCH_CUDA_ARCH_LIST, etc.
docker compose up --build

2
docs/12 - OpenAI API.md
View File

@@ -19,7 +19,7 @@ Add `--api` to your command-line flags.
### Examples
For the documentation with all the endpoints, parameters and their types, consult `http://127.0.0.1:5000/docs` or the [typing.py](https://github.com/oobabooga/text-generation-webui/blob/main/modules/api/typing.py) file.
For the documentation with all the endpoints, parameters and their types, consult `http://127.0.0.1:5000/docs` or the [typing.py](https://github.com/oobabooga/textgen/blob/main/modules/api/typing.py) file.
The official examples in the [OpenAI documentation](https://platform.openai.com/docs/api-reference) should also work, and the same parameters apply (although the API here has more optional parameters).

8
docs/Image Generation Tutorial.md
View File

@@ -10,10 +10,10 @@ This feature allows you to generate images using `diffusers` models like [Tongyi
1. Clone the repository with
```
git clone https://github.com/oobabooga/text-generation-webui
git clone https://github.com/oobabooga/textgen
```
or download it from [here](https://github.com/oobabooga/text-generation-webui/archive/refs/heads/main.zip) and unzip it.
or download it from [here](https://github.com/oobabooga/textgen/archive/refs/heads/main.zip) and unzip it.
2. Use the one-click installer.
@@ -21,7 +21,7 @@ or download it from [here](https://github.com/oobabooga/text-generation-webui/ar
- Linux: Run `./start_linux.sh`
- macOS: Run `./start_macos.sh`
Note: Image generation does not work with the portable builds in `.zip` format in the [Releases page](https://github.com/oobabooga/text-generation-webui/releases). You need the "full" version of the web UI.
Note: Image generation does not work with the portable builds in `.zip` format in the [Releases page](https://github.com/oobabooga/textgen/releases). You need the "full" version of the web UI.
## Downloading a model
@@ -64,7 +64,7 @@ To use this feature, you need to load an LLM in the main "Model" page on the lef
If you have no idea what to use, do this to get started:
1. Download [Qwen3-4B-Q3_K_M.gguf](https://huggingface.co/unsloth/Qwen3-4B-GGUF/resolve/main/Qwen3-4B-Q3_K_M.gguf) to your `text-generation-webui/user_data/models` folder.
1. Download [Qwen3-4B-Q3_K_M.gguf](https://huggingface.co/unsloth/Qwen3-4B-GGUF/resolve/main/Qwen3-4B-Q3_K_M.gguf) to your `textgen/user_data/models` folder.
2. Select the model in the dropdown menu in the "Model" page.
3. Click Load.

6
docs/Multimodal Tutorial.md
View File

@@ -14,7 +14,7 @@ As an example, download
https://huggingface.co/unsloth/gemma-3-4b-it-GGUF/resolve/main/gemma-3-4b-it-Q4_K_S.gguf?download=true
to your `text-generation-webui/user_data/models` folder.
to your `textgen/user_data/models` folder.
### 3. Download the associated mmproj file to `user_data/mmproj`
@@ -22,7 +22,7 @@ Then download
https://huggingface.co/unsloth/gemma-3-4b-it-GGUF/resolve/main/mmproj-F16.gguf?download=true
to your `text-generation-webui/user_data/mmproj` folder. Name it `mmproj-gemma-3-4b-it-F16.gguf` to give it a recognizable name.
to your `textgen/user_data/mmproj` folder. Name it `mmproj-gemma-3-4b-it-F16.gguf` to give it a recognizable name.
### 4. Load the model
@@ -63,4 +63,4 @@ Examples of models that you can use:
In the page below you can find some ready-to-use examples:
[Multimodal/vision (llama.cpp and ExLlamaV3)](https://github.com/oobabooga/text-generation-webui/wiki/12-%E2%80%90-OpenAI-API#multimodalvision-llamacpp-and-exllamav3)
[Multimodal/vision (llama.cpp and ExLlamaV3)](https://github.com/oobabooga/textgen/wiki/12-%E2%80%90-OpenAI-API#multimodalvision-llamacpp-and-exllamav3)

2
docs/README.md
View File

@@ -1,5 +1,5 @@
These files are a mirror of the documentation at:
# https://github.com/oobabooga/text-generation-webui/wiki
# https://github.com/oobabooga/textgen/wiki
It is recommended to browse it there. Contributions can be sent here and will later be synced with the wiki.

2
extensions/ngrok/script.py
View File

@@ -18,7 +18,7 @@ port = shared.args.listen_port if shared.args.listen_port else '7860'
options = {
'addr': f"{host}:{port}",
'authtoken_from_env': True,
'session_metadata': 'text-generation-webui',
'session_metadata': 'textgen',
}

6
extensions/sd_api_pictures/README.MD
View File

@@ -2,7 +2,7 @@
TL;DR: Lets the bot answer you with a picture!
Stable Diffusion API pictures for TextGen, v.1.2.0
An extension to [oobabooga's textgen-webui](https://github.com/oobabooga/text-generation-webui) allowing you to receive pics generated by [Automatic1111's SD-WebUI API](https://github.com/AUTOMATIC1111/stable-diffusion-webui)
An extension to [oobabooga's TextGen](https://github.com/oobabooga/textgen) allowing you to receive pics generated by [Automatic1111's SD-WebUI API](https://github.com/AUTOMATIC1111/stable-diffusion-webui)
<details>
<summary>Interface overview</summary>
@@ -17,7 +17,7 @@ Load it in the `--chat` mode with `--extension sd_api_pictures` alongside `send_
## History
Consider the version included with [oobabooga's repository](https://github.com/oobabooga/text-generation-webui/tree/main/extensions/sd_api_pictures) to be STABLE, experimental developments and untested features are pushed in [Brawlence/SD_api_pics](https://github.com/Brawlence/SD_api_pics)
Consider the version included with [oobabooga's repository](https://github.com/oobabooga/textgen/tree/main/extensions/sd_api_pictures) to be STABLE, experimental developments and untested features are pushed in [Brawlence/SD_api_pics](https://github.com/Brawlence/SD_api_pics)
Lastest change:
1.1.0 → 1.1.1 Fixed not having Auto1111's metadata in received images
@@ -48,7 +48,7 @@ Green mark confirms the ability to communicate with Auto1111's API on this addre
### Persistents settings
Create or modify the `settings.json` in the `text-generation-webui` root directory to override the defaults
Create or modify the `settings.json` in the `textgen` root directory to override the defaults
present in script.py, ex:
```json

4
extensions/superboogav2/README.md
View File

@@ -8,7 +8,7 @@ Enhance your LLM with additional information from text, URLs, and files for more
## Installation and Activation
1. Start the conda environment by running `cmd_windows.bat` or the equivalent for your system in the root directory of `text-generation-webui`.
1. Start the conda environment by running `cmd_windows.bat` or the equivalent for your system in the root directory of `textgen`.
2. Install the necessary packages:
```
pip install -r extensions/superboogav2/requirements.txt
@@ -38,4 +38,4 @@ SuperboogaV2 utilizes MuPDF, pandas, python-docx, and python-pptx to extract tex
SuperboogaV2 processes your data into context-aware chunks, applies cleaning techniques, and stores them as embeddings to minimize redundant computations. Relevance is determined using distance calculations and prioritization of recent information.
For a detailed description and more information, refer to the comments in this pull request: [https://github.com/oobabooga/text-generation-webui/pull/3272](https://github.com/oobabooga/text-generation-webui/pull/3272)
For a detailed description and more information, refer to the comments in this pull request: [https://github.com/oobabooga/textgen/pull/3272](https://github.com/oobabooga/textgen/pull/3272)

8
modules/api/typing.py
View File

@@ -8,7 +8,7 @@ from modules import shared
class GenerationOptions(BaseModel):
preset: str | None = Field(default=None, description="The name of a file under text-generation-webui/user_data/presets (without the .yaml extension). The sampling parameters that get overwritten by this option are the keys in the default_preset() function in modules/presets.py.")
preset: str | None = Field(default=None, description="The name of a file under textgen/user_data/presets (without the .yaml extension). The sampling parameters that get overwritten by this option are the keys in the default_preset() function in modules/presets.py.")
dynatemp_low: float = shared.args.dynatemp_low
dynatemp_high: float = shared.args.dynatemp_high
dynatemp_exponent: float = shared.args.dynatemp_exponent
@@ -173,10 +173,10 @@ class ChatCompletionRequestParams(BaseModel):
mode: str = Field(default='instruct', description="Valid options: instruct, chat, chat-instruct.")
instruction_template: str | None = Field(default=None, description="An instruction template defined under text-generation-webui/user_data/instruction-templates. If not set, the correct template will be automatically obtained from the model metadata.")
instruction_template: str | None = Field(default=None, description="An instruction template defined under textgen/user_data/instruction-templates. If not set, the correct template will be automatically obtained from the model metadata.")
instruction_template_str: str | None = Field(default=None, description="A Jinja2 instruction template. If set, will take precedence over everything else.")
character: str | None = Field(default=None, description="A character defined under text-generation-webui/user_data/characters. If not set, the default \"Assistant\" character will be used.")
character: str | None = Field(default=None, description="A character defined under textgen/user_data/characters. If not set, the default \"Assistant\" character will be used.")
bot_name: str | None = Field(default=None, description="Overwrites the value set by character field.", alias="name2")
context: str | None = Field(default=None, description="Overwrites the value set by character field.")
greeting: str | None = Field(default=None, description="Overwrites the value set by character field.")
@@ -271,7 +271,7 @@ class ModelListResponse(BaseModel):
class LoadModelRequest(BaseModel):
model_name: str
args: dict | None = None
instruction_template: str | None = Field(default=None, description="An instruction template defined under text-generation-webui/user_data/instruction-templates. Sets the default template for all subsequent API requests.")
instruction_template: str | None = Field(default=None, description="An instruction template defined under textgen/user_data/instruction-templates. Sets the default template for all subsequent API requests.")
instruction_template_str: str | None = Field(default=None, description="A Jinja2 instruction template string. If set, takes precedence over instruction_template.")

2
modules/logging_colors.py
View File

@@ -1,6 +1,6 @@
import logging
logger = logging.getLogger('text-generation-webui')
logger = logging.getLogger('textgen')
def setup_logging():

2
modules/shared.py
View File

@@ -42,7 +42,7 @@ persistent_interface_state = {}
need_restart = False
# Parser copied from https://github.com/vladmandic/automatic
parser = argparse.ArgumentParser(description="Text Generation Web UI", conflict_handler='resolve', add_help=True, formatter_class=lambda prog: argparse.HelpFormatter(prog, max_help_position=55, indent_increment=2, width=200))
parser = argparse.ArgumentParser(description="TextGen", conflict_handler='resolve', add_help=True, formatter_class=lambda prog: argparse.HelpFormatter(prog, max_help_position=55, indent_increment=2, width=200))
# Basic settings
group = parser.add_argument_group('Basic settings')

2
modules/training.py
View File

@@ -40,7 +40,7 @@ def create_ui():
tmp = gr.State('')
with gr.Row():
with gr.Column():
gr.Markdown("[Tutorial](https://github.com/oobabooga/text-generation-webui/wiki/05-%E2%80%90-Training-Tab)")
gr.Markdown("[Tutorial](https://github.com/oobabooga/textgen/wiki/05-%E2%80%90-Training-Tab)")
with gr.Row():
copy_from = gr.Dropdown(label='Copy parameters from', value='None', choices=utils.get_available_loras(), elem_classes=['slim-dropdown'], interactive=not mu)

6
one_click.py
View File

@@ -324,7 +324,7 @@ def update_requirements(initial_installation=False, pull=True):
# Create .git directory if missing
if not os.path.exists(os.path.join(script_dir, ".git")):
run_cmd(
"git init -b main && git remote add origin https://github.com/oobabooga/text-generation-webui && "
"git init -b main && git remote add origin https://github.com/oobabooga/textgen && "
"git fetch && git symbolic-ref refs/remotes/origin/HEAD refs/remotes/origin/main && "
"git reset --hard origin/main && git branch --set-upstream-to=origin/main",
environment=True,
@@ -337,7 +337,7 @@ def update_requirements(initial_installation=False, pull=True):
"Your current installation uses Python {}.{}, which is outdated.\n"
"Python {} is now required. A clean installation is needed.\n\n"
"INSTRUCTIONS:\n"
"1. Delete the 'installer_files' folder in your text-generation-webui directory.\n"
"1. Delete the 'installer_files' folder in your textgen directory.\n"
"2. Run the start script again (e.g., start_windows.bat).\n\n"
"This will create a fresh environment with the latest software.".format(*sys.version_info[:2], PYTHON_VERSION)
)
@@ -350,7 +350,7 @@ def update_requirements(initial_installation=False, pull=True):
"Your current installation uses CUDA 12.4, which has been removed.\n"
"To update to the new default (CUDA 12.8), a clean installation is required.\n\n"
"INSTRUCTIONS:\n"
"1. Delete the 'installer_files' folder in your text-generation-webui directory.\n"
"1. Delete the 'installer_files' folder in your textgen directory.\n"
"2. Run the start script again (e.g., start_windows.bat).\n\n"
"This will create a fresh environment with the latest software."
)

6
server.py
View File

@@ -36,7 +36,7 @@ def signal_handler(sig, frame):
signal.signal(signal.SIGINT, signal.SIG_DFL)
signal.signal(signal.SIGTERM, signal.SIG_DFL)
logger.info("Received Ctrl+C. Shutting down Text Generation Web UI gracefully.")
logger.info("Received Ctrl+C. Shutting down TextGen gracefully.")
# Explicitly stop LlamaServer to avoid __del__ cleanup issues during shutdown
if shared.model and shared.model.__class__.__name__ == 'LlamaServer':
@@ -85,7 +85,7 @@ def create_interface():
'GRADIO_TEMP_DIR': str(gradio_temp_path)
})
title = 'Text Generation Web UI'
title = 'TextGen'
# Password authentication
auth = []
@@ -249,7 +249,7 @@ def create_interface():
if __name__ == "__main__":
logger.info("Starting Text Generation Web UI")
logger.info("Starting TextGen")
do_cmd_flags_warnings()
# Load custom settings