AI/text-generation-webui
1
0
Fork 0
mirror of https://github.com/oobabooga/text-generation-webui.git synced 2024-10-01 01:26:03 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
oobabooga 2023-04-01 14:15:19 -03:00 committed by GitHub
parent b857f4655b
commit 7ec11ae000
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
README.md
View File

@ -12,28 +12,28 @@ Its goal is to become the [AUTOMATIC1111/stable-diffusion-webui](https://github.
## Features ## Features
* Switch between different models using a dropdown menu. * Dropdown menu for switching between models
* Notebook mode that resembles OpenAI's playground. * Notebook mode that resembles OpenAI's playground
* Chat mode for conversation and role playing. * Chat mode for conversation and role playing
* Generate nice HTML output for GPT-4chan. * Nice HTML output for GPT-4chan
* Generate Markdown output for [GALACTICA](https://github.com/paperswithcode/galai), including LaTeX support. * Markdown output for [GALACTICA](https://github.com/paperswithcode/galai), including LaTeX rendering
* Support for [Pygmalion](https://huggingface.co/models?search=pygmalionai/pygmalion) and custom characters in JSON or TavernAI Character Card formats ([FAQ](https://github.com/oobabooga/text-generation-webui/wiki/Pygmalion-chat-model-FAQ)). * Custom chat characters in JSON format ([FAQ](https://github.com/oobabooga/text-generation-webui/wiki/Pygmalion-chat-model-FAQ))
* Advanced chat features (send images, get audio responses with TTS). * Advanced chat features (send images, get audio responses with TTS)
* Stream the text output in real time very efficiently. * Very efficient text streaming
* Load parameter presets from text files. * Parameter presets
* Load large models in 8-bit mode. * 8-bit mode
* Split large models across your GPU(s), CPU, and disk. * Layers splitting across GPU(s), CPU, and disk
* CPU mode. * CPU mode
* [FlexGen offload](https://github.com/oobabooga/text-generation-webui/wiki/FlexGen). * [FlexGen](https://github.com/oobabooga/text-generation-webui/wiki/FlexGen)
* [DeepSpeed ZeRO-3 offload](https://github.com/oobabooga/text-generation-webui/wiki/DeepSpeed). * [DeepSpeed ZeRO-3](https://github.com/oobabooga/text-generation-webui/wiki/DeepSpeed)
* Get responses via API, [with](https://github.com/oobabooga/text-generation-webui/blob/main/api-example-streaming.py) or [without](https://github.com/oobabooga/text-generation-webui/blob/main/api-example.py) streaming. * API [with](https://github.com/oobabooga/text-generation-webui/blob/main/api-example-streaming.py) streaming and [without](https://github.com/oobabooga/text-generation-webui/blob/main/api-example.py) streaming
* [LLaMA model, including 4-bit GPTQ support](https://github.com/oobabooga/text-generation-webui/wiki/LLaMA-model). * [LLaMA model, including 4-bit GPTQ](https://github.com/oobabooga/text-generation-webui/wiki/LLaMA-model)
* [llama.cpp support](https://github.com/oobabooga/text-generation-webui/wiki/llama.cpp-models). **\*NEW!\*** * [llama.cpp](https://github.com/oobabooga/text-generation-webui/wiki/llama.cpp-models) **\*NEW!\***
* [RWKV model](https://github.com/oobabooga/text-generation-webui/wiki/RWKV-model). * [RWKV model](https://github.com/oobabooga/text-generation-webui/wiki/RWKV-model)
* [Supports LoRAs](https://github.com/oobabooga/text-generation-webui/wiki/Using-LoRAs). * [LoRa (loading and training)](https://github.com/oobabooga/text-generation-webui/wiki/Using-LoRAs)
* Supports softprompts. * Softprompts
* [Supports extensions](https://github.com/oobabooga/text-generation-webui/wiki/Extensions). * [Extensions](https://github.com/oobabooga/text-generation-webui/wiki/Extensions)
* [Works on Google Colab](https://github.com/oobabooga/text-generation-webui/wiki/Running-on-Colab). * [Google Colab](https://github.com/oobabooga/text-generation-webui/wiki/Running-on-Colab)
## Installation ## Installation
@ -64,7 +64,7 @@ On Windows, I additionally recommend carrying out the installation on WSL instea
#### 0. Install Conda #### 0. Install Conda
Conda can be downloaded here: https://docs.conda.io/en/latest/miniconda.html https://docs.conda.io/en/latest/miniconda.html
On Linux or WSL, it can be automatically installed with these two commands: On Linux or WSL, it can be automatically installed with these two commands:
@ -134,13 +134,13 @@ You can automatically download a model from HF using the script `download-model.
python download-model.py organization/model python download-model.py organization/model
For instance: For example:
python download-model.py facebook/opt-1.3b 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. 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
[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: [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:
@ -169,8 +169,6 @@ Then browse to
`http://localhost:7860/?__theme=dark` `http://localhost:7860/?__theme=dark`
Optionally, you can use the following command-line flags: Optionally, you can use the following command-line flags:
#### Basic settings #### Basic settings
@ -261,6 +259,8 @@ Inference settings presets can be created under `presets/` as text files. These
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. 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](https://user-images.githubusercontent.com/112222186/228956352-1addbdb9-2456-465a-b51d-089f462cd385.png)
## System requirements ## System requirements
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. 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.