From b4b5f455584cc8519e78ad6717725a952a7f6ce6 Mon Sep 17 00:00:00 2001 From: oobabooga <112222186+oobabooga@users.noreply.github.com> Date: Fri, 22 Sep 2023 10:28:22 -0700 Subject: [PATCH] Join the installation instructions --- INSTRUCTIONS.txt | 38 ----------- .../new/Installation Instructions.md | 68 ++++++++++++------- 2 files changed, 43 insertions(+), 63 deletions(-) delete mode 100644 INSTRUCTIONS.txt rename INSTRUCTIONS-WSL.txt => docs/new/Installation Instructions.md (55%) diff --git a/INSTRUCTIONS.txt b/INSTRUCTIONS.txt deleted file mode 100644 index 6637b65a..00000000 --- a/INSTRUCTIONS.txt +++ /dev/null @@ -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. diff --git a/INSTRUCTIONS-WSL.txt b/docs/new/Installation Instructions.md similarity index 55% rename from INSTRUCTIONS-WSL.txt rename to docs/new/Installation Instructions.md index b2dabdd3..cd43a5f8 100644 --- a/INSTRUCTIONS-WSL.txt +++ b/docs/new/Installation Instructions.md @@ -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: https://learn.microsoft.com/en-us/windows/wsl/install @@ -28,7 +63,7 @@ Do this by using these commands: wsl -l wsl -s -# Web UI Installation +### Web UI Installation Run the "start" script. By default it will install the web UI in WSL: /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 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 -be much faster than the initial installation. +As an alternative to running the "update" script, you can also run "wsl.sh update" in WSL. -You can also run "wsl.sh update" in WSL. - -# 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 +### Running an interactive shell To run an interactive shell in the miniconda environment, run the "cmd" 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: wsl.sh: line ~22 INSTALL_DIR="/path/to/install/dir"