You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This can sometimes happen and appears to be related to `uv.lockfile` permissions, this can usually be fixed with `F1 -> Rebuild container`, or if that fails delete the uv lockfile and then rebuild the container.
11
-
If both of these fail then there may be a legitimate package versioning issue, ask for help on the discord!
3
+
This folder contains the devcontainer setup used by InvokeAI.
4
+
If you are not familiar with devcontainers, we encourage you to check out the VSCode [devcontainer tutorial](https://code.visualstudio.com/docs/devcontainers/tutorial) for more information!
5
+
But in short; devcontainers are a one click solution to build, launch, and install an isolated/containerized development environment which is setup specifically for writing code for this repository.
6
+
This means you can get started with development without having to manually install any dependencies or tools or manage configuration files, the container automatically does all of it for you.
12
7
13
8
## VSCode Workspace
14
9
@@ -32,3 +27,48 @@ All normal development tooling will work as expected, including:
32
27
- Import resolution.
33
28
- Linting and formatting.
34
29
- Type checking.
30
+
31
+
## Common Problems
32
+
33
+
### Launching backend after container rebuild results in package related error
This can sometimes happen and appears to be related to `uv.lockfile` permissions, this can usually be fixed with `F1 -> Rebuild container`, or if that fails delete the uv lockfile and then rebuild the container.
37
+
If both of these fail then there may be a legitimate package versioning issue, ask for help on the discord!
38
+
39
+
### Python Hot-Reloading not working
40
+
41
+
First check the backend logs and verify that "Juririgged" has logged a message indicating it detected and is watching the file in question.
If you have verified that the file is being watched, but the changes are not being picked up, then continue reading the next section.
50
+
If the below sections do not apply to you, then it is an issue with [jurigged](https://github.com/breuleux/jurigged).
51
+
52
+
### Jurigged not picking up changes
53
+
54
+
If you are developing on a Windows machine running [WSL](https://code.visualstudio.com/docs/remote/wsl-tutorial), then [this issue link is relevant to you](https://github.com/microsoft/WSL/issues/4739)
55
+
In short, WSL2 does not support propagating windows file system events to 'inotify' events for the linux virtual machine.
56
+
57
+
To fix this, it is strongly recommended that you store your code on the WSL filesystem instead of the Windows filesystem.
58
+
59
+
#### Option 1: Clone the repository within the WSL filesystem
60
+
61
+
Open VSCode and press `F1` and select **WSL: Connect to WSL**, this will open a new VSCode window connected to the WSL filesystem.
62
+
Afterwards, you can clone the InvokeAI repository using the command line, or by using the VSCode _Explore_ panel(_Ctrl+Shift+E_) which will show a **Clone Repository** button when no folder is opened.
63
+
64
+
#### Option 2: Move existing code to the WSL filesystem
65
+
66
+
First, open windows file explorer and enter `\\wsl$` in the address bar, this will show your WSL distributions.
67
+
More information can be found at [this link](https://learn.microsoft.com/en-us/windows/wsl/filesystems#view-your-current-directory-in-windows-file-explorer).
68
+
69
+
Next, open your preferred WSL distribution (default: _Ubuntu_) and decide where you want to store your code, its typically wise to use a path under your **home** directory (eg: `/home/<username>/code/<project>`).
70
+
71
+
Now, open VSCode and press `F1` and select **WSL: Connect to WSL**, once VSCode has opened in WSL you can click the **Open Folder** button in the VSCode _Explore_ panel(_Ctrl+Shift+E_) and select the correct folder from the dropdown menu.
72
+
Afterwards, just press `F1` and select **Reopen in Container** to launch the devcontainer.
73
+
74
+
See [this link](https://code.visualstudio.com/remote/advancedcontainers/improve-performance) for more information.
0 commit comments