Mirrors/text-generation-webui
1
0
Fork 0
mirror of https://github.com/oobabooga/text-generation-webui.git synced 2024-11-21 23:57:58 +01:00
Code Issues Packages Projects Releases Wiki Activity

Rename doc file

Browse Source
This commit is contained in:
oobabooga 2023-09-22 12:16:31 -07:00
parent 0fee18e8b7
commit c33a94e381
2 changed files with 5 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -50,7 +50,7 @@ Some observations:
* There is no need to run any of those scripts as admin/root.
* If you need to move your installation folder, you will need to delete `installer_files` and install again, as some links will be broken. So choose a good location for your `text-generation-webui` folder before installing.
* Additional instructions for WSL and AMD users can be found here: [Instructions](https://github.com/oobabooga/text-generation-webui/blob/one-click/docs/new/Installation%20Instructions.md).
* Additional instructions for WSL and AMD can be found here: [Instructions](https://github.com/oobabooga/text-generation-webui/blob/one-click/docs/One-Click-Installers.md).
* The installer has been tested mostly on NVIDIA GPUs. If you can find a way to improve it for your AMD/Intel Arc/Mac Metal GPU, you are highly encouraged to submit a PR to this repository. The main file to be edited is `one_click.py`.
### Manual installation using Conda

36
docs/new/Installation Instructions.md → docs/One-Click-Installers.md
View File

@ -1,41 +1,16 @@
# 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.
# Additional one-click installers info
## 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
Edit the "one_click.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
## WSL instructions
If you do not have WSL installed, see here:
https://learn.microsoft.com/en-us/windows/wsl/install
@ -69,7 +44,7 @@ Run the "start" script. By default it will install the web UI in WSL:
/home/{username}/text-gen-install
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 one_click.py and wsl.sh are next to it!
### Updating the web UI
@ -77,9 +52,6 @@ As an alternative to running the "update" script, you can also run "wsl.sh updat
### 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.
As an alternative to running the "cmd" script, you can also run "wsl.sh cmd" in WSL.
### Changing the default install location