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 --chat, --notebook, 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

--chat --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.