Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated WSL documentation #6516

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+39 −1
Open

Updated WSL documentation #6516

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9635245
add note about moving existing WSL distro
jensgreven Nov 4, 2024
edef579
add note about WSL performance and clarify "put it inside WSL"
jensgreven Nov 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 39 additions & 1 deletion docs/10 - WSL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,21 @@ wsl -l
wsl -s <DistroName>
```

#### To move an existing WSL distro

If you already have installed WSL on your computer and want to move it to a path of your likinng, open cmd and enter
````
wsl --manage <distro-name> --move <path>
````
e.g.
````
wsl --manage ubuntu-22.04 --move D:\WSL\ubuntu-22.04
````

This command might not be available in your version of WSL. I cannot find information about the version it was added.
Its availability might also vary depending on whether you installed your WSL (distro) via the command line or via the
Microsoft store.

### Web UI Installation

Run the "start" script. By default it will install the web UI in WSL:
Expand Down Expand Up @@ -131,7 +146,30 @@ If you face any issues or need to troubleshoot, you can always refer to the offi

### WSL2 performance using /mnt:

When you git clone a repository, put it inside WSL and not outside. To understand more, take a look at this [issue](https://github.com/microsoft/WSL/issues/4197#issuecomment-604592340)
When you git clone a repository, put it inside WSL and not outside. To understand more, take a look at this [issue](https://github.com/microsoft/WSL/issues/4197#issuecomment-604592340).

This means, to clone the repo, do the following:
````
wsl (to enter - you guessed it - WSL)
cd ~ (to change to your home directory and enter the "WSL file system". Your WSL might start somewhere in the Windows file system at a location like "/mnt/c/Users/foo")
(maybe create a subfolder if you wish and cd to it)
git clone https://github.com/oobabooga/text-generation-webui.git
cd text-generation-webui
./start_linux.sh
````
In this case, you'd want to put your models under
````
/home/foo/text-generation-webui/models
````
If you want to access your WSL file system from windows, you can do so using the path
````
\\wsl.localhost\Ubuntu-22.04\home\foo\text-generation-webui
````
You might even have a little pengui in your Wíndows File Explorer labelled "Linux" under which you can access your
windows files.

**NEVER EVER put your models in the Windows file system (i.e. under /mnt/...) and access them from within WSL. Loading a
simple 10GB model could easily take 30+ minutes!!!**

### Bonus: Port Forwarding

Expand Down