Mirrors/text-generation-webui
1
0
Fork 0
mirror of https://github.com/oobabooga/text-generation-webui.git synced 2024-09-20 10:35:10 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Join the installation instructions

Browse source
This commit is contained in:
oobabooga 2023-09-22 10:28:22 -07:00
parent 2d2a8cfb48
commit b4b5f45558
2 changed files with 43 additions and 63 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
INSTRUCTIONS.txt
View file

@ -1,38 +0,0 @@
Thank you for downloading oobabooga/text-generation-webui!
# Installation
Run the "start" script. It will install the web UI and all of its
dependencies inside this folder.
To launch the web UI in the future after it is already installed, run the
"start" script again.
# Updating the web UI
Run the "update" script. It will install the updates only, so it should
be much faster than the initial installation.
# Adding flags like --model, --api, etc
Open the "CMD_FLAGS.txt" file with a text editor, add your flags, and
save the file. For instance, to add the --api flag, change the file
contents to
--api
# Running an interactive shell
Sometimes you may need to install some additional Python package. To do
that, run the "cmd" script and type your commands inside the terminal
window that will appear.
# Using an AMD GPU in Linux
Requires ROCm SDK 5.4.2 or 5.4.3 to be installed. Some systems may also
need: sudo apt-get install libstdc++-12-dev
Edit the "webui.py" script using a text editor and un-comment and
modify the lines near the top of the script according to your setup. In
particular, modify the os.environ["ROCM_PATH"] = '/opt/rocm' line to
point to your ROCm installation.

68
INSTRUCTIONS-WSL.txt → docs/new/Installation Instructions.md
View file

@ -1,6 +1,41 @@
Thank you for downloading oobabooga/text-generation-webui. # Installation
# WSL setup Run the "start" script. It will install the web UI and all of its
dependencies inside this folder.
To launch the web UI in the future after it is already installed, run the
"start" script again.
## Updating the web UI
Run the "update" script. It will install the updates only, so it should
be much faster than the initial installation.
## Adding flags like --model, --api, etc
Open the "CMD_FLAGS.txt" file with a text editor, add your flags, and
save the file. For instance, to add the --api flag, change the file
contents to
--api
## Running an interactive shell
Sometimes you may need to install some additional Python package. To do
that, run the "cmd" script and type your commands inside the terminal
window that will appear.
## Using an AMD GPU in Linux
Requires ROCm SDK 5.4.2 or 5.4.3 to be installed. Some systems may also
need: sudo apt-get install libstdc++-12-dev
Edit the "webui.py" script using a text editor and un-comment and
modify the lines near the top of the script according to your setup. In
particular, modify the os.environ["ROCM_PATH"] = '/opt/rocm' line to
point to your ROCm installation.
## WSL special instructions
If you do not have WSL installed, see here: If you do not have WSL installed, see here:
https://learn.microsoft.com/en-us/windows/wsl/install https://learn.microsoft.com/en-us/windows/wsl/install
@ -28,7 +63,7 @@ Do this by using these commands:
wsl -l wsl -l
wsl -s <DistroName> wsl -s <DistroName>
# Web UI Installation ### Web UI Installation
Run the "start" script. By default it will install the web UI in WSL: Run the "start" script. By default it will install the web UI in WSL:
/home/{username}/text-gen-install /home/{username}/text-gen-install
@ -36,35 +71,18 @@ Run the "start" script. By default it will install the web UI in WSL:
To launch the web UI in the future after it is already installed, run To launch the web UI in the future after it is already installed, run
the same "start" script. Ensure that webui.py and wsl.sh are next to it! the same "start" script. Ensure that webui.py and wsl.sh are next to it!
# Updating the web UI ### Updating the web UI
Run the "update" script. This will only install the updates, so it should As an alternative to running the "update" script, you can also run "wsl.sh update" in WSL.
be much faster than the initial installation.
You can also run "wsl.sh update" in WSL. ### Running an interactive shell
# Adding flags like --chat, --notebook, etc
Edit the "webui.py" script using a text editor and add the desired flags
to the CMD_FLAGS variable at the top. It should look like this:
CMD_FLAGS = '--chat'
For instance, to add the --api flag, change it to
CMD_FLAGS = '--chat --api'
The "start" and "update" scripts will copy the edited "webui.py" to WSL
to be used by the web UI.
# Running an interactive shell
To run an interactive shell in the miniconda environment, run the "cmd" To run an interactive shell in the miniconda environment, run the "cmd"
script. This is useful for installing additional requirements manually. script. This is useful for installing additional requirements manually.
You can also run "wsl.sh cmd" in WSL. As an alternative to running the "cmd" script, you can also run "wsl.sh cmd" in WSL.
# Changing the default install location ### Changing the default install location
To change this, you will need to edit the scripts as follows: To change this, you will need to edit the scripts as follows:
wsl.sh: line ~22 INSTALL_DIR="/path/to/install/dir" wsl.sh: line ~22 INSTALL_DIR="/path/to/install/dir"