Skip to content

Commit 4426f94

Browse files
authored
Update the installation instructions. Tldr use WSL
1 parent 9256e93 commit 4426f94

File tree

1 file changed

+30
-20
lines changed

1 file changed

+30
-20
lines changed

README.md

Lines changed: 30 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -34,39 +34,45 @@ Its goal is to become the [AUTOMATIC1111/stable-diffusion-webui](https://github.
3434
* [Extensions](https://github.com/oobabooga/text-generation-webui/wiki/Extensions).
3535
* [Works on Google Colab](https://github.com/oobabooga/text-generation-webui/wiki/Running-on-Colab).
3636

37-
## Installation option 1: conda
37+
## Installation
3838

39-
Open a terminal and copy and paste these commands one at a time ([install conda](https://docs.conda.io/en/latest/miniconda.html) first if you don't have it already):
39+
The recommended installation methods are the following:
40+
41+
* Linux and macOS: using conda natively.
42+
* Windows: using conda on WSL ([WSL installation guide](https://github.com/oobabooga/text-generation-webui/wiki/Windows-Subsystem-for-Linux-(Ubuntu)-Installation-Guide)).
43+
44+
Conda can be downloaded here: https://docs.conda.io/en/latest/miniconda.html
45+
46+
#### 1. Create a new conda environment
4047

4148
```
42-
conda create -n textgen
49+
conda create -n textgen python=3.10.9
4350
conda activate textgen
44-
conda install torchvision=0.14.1 torchaudio=0.13.1 pytorch-cuda=11.7 git -c pytorch -c nvidia
45-
git clone https://github.com/oobabooga/text-generation-webui
46-
cd text-generation-webui
47-
pip install -r requirements.txt
4851
```
4952

50-
The third line assumes that you have an NVIDIA GPU.
53+
#### 2. Install Pytorch
5154

52-
* If you have an AMD GPU, replace the third command with this one:
55+
| System | GPU | Command |
56+
|--------|---------|---------|
57+
| Linux/WSL | NVIDIA | `conda install pytorch torchvision torchaudio pytorch-cuda=11.7 -c pytorch -c nvidia` |
58+
| Linux | AMD | `pip3 install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/rocm5.4.2` |
59+
| MacOS + MPS (untested) | Any | `conda install pytorch torchvision torchaudio -c pytorch` |
5360

54-
```
55-
pip3 install torch torchvision=0.14.1 torchaudio=0.13.1 --extra-index-url https://download.pytorch.org/whl/rocm5.2
56-
```
57-
58-
* If you are running it in CPU mode, replace the third command with this one:
61+
The up to date commands can be found here: https://pytorch.org/get-started/locally/
62+
63+
#### 3. Install the web UI
5964

6065
```
61-
conda install pytorch torchvision=0.14.1 torchaudio=0.13.1 git -c pytorch
66+
git clone https://github.com/oobabooga/text-generation-webui
67+
cd text-generation-webui
68+
pip install -r requirements.txt
6269
```
6370

64-
> **Note**
65-
> 1. If you are on Windows, it may be easier to run the commands above in a WSL environment. The performance may also be better. A full guide can be found here: [Windows Subsystem for Linux (Ubuntu) Installation Guide
66-
](https://github.com/oobabooga/text-generation-webui/wiki/Windows-Subsystem-for-Linux-(Ubuntu)-Installation-Guide).
67-
> 2. For a more detailed, user-contributed guide, see: [Installation instructions for human beings](https://github.com/oobabooga/text-generation-webui/wiki/Installation-instructions-for-human-beings).
71+
### Alternative: native Windows installation
6872

69-
## Installation option 2: one-click installers
73+
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: [Installation instructions for human beings](https://github.com/oobabooga/text-generation-webui/wiki/Installation-instructions-for-human-beings).
74+
75+
### Alternative: one click installers
7076

7177
[oobabooga-windows.zip](https://github.com/oobabooga/one-click-installers/archive/refs/heads/oobabooga-windows.zip)
7278

@@ -77,6 +83,10 @@ Just download the zip above, extract it, and double click on "install". The web
7783
* To download a model, double click on "download-model"
7884
* To start the web UI, double click on "start-webui"
7985

86+
Source codes: https://github.com/oobabooga/one-click-installers
87+
88+
This method lags behind the newest developments and does not support 8-bit mode on Windows without additional set up.
89+
8090
## Downloading models
8191

8292
Models should be placed under `models/model-name`. For instance, `models/gpt-j-6B` for [GPT-J 6B](https://huggingface.co/EleutherAI/gpt-j-6B/tree/main).

0 commit comments

Comments
 (0)