Skip to content

Commit

Permalink
docs: refine runtime-deps documentation
Browse files Browse the repository at this point in the history
- Move explanation about `SKIP_REQUIREMENTS_INSTALL=true` to a more prominent location
- Specify that `runtime-deps` images are available in recent versions
- Reorder the explanation of `runtime-deps` features for clarity
- Add advice to keep and reuse the `/home/1001/.local` directory via a volume
- Mention the community's contribution to this utilization idea
- Perform similar updates on the Chinese (zh) version of the README file.

Signed-off-by: 陳鈞 <[email protected]>
  • Loading branch information
jim60105 committed May 3, 2024
1 parent 21fdded commit b5376f7
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 14 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,19 +112,24 @@ docker compose -f docker-compose.forge.yml up -d
### `runtime-deps` images
Some versions also have `runtime-deps` images that you can use, like `v1.8.0-runtime-deps`, `v1.9.3-runtime-deps`, and `forge-runtime-deps`.
> [!NOTE]
> You can build it locally with Docker build arguments: `SKIP_REQUIREMENTS_INSTALL=true`
The `runtime-deps` image does not include pre-installed pip requirements.
Instead, the requirements will be installed when the image is first launched.
Some recent versions have `runtime-deps` images that you can use, like `v1.8.0-runtime-deps`, `v1.9.3-runtime-deps`, and `forge-runtime-deps`.
This leads to a smaller image size of **1.3GB**!
These images does not include pre-installed pip requirements.
Instead, the requirements will be installed during the image first launch.
On the downside, the initial startup process may take some time and could fail if the necessary packages are not accessible.
The initial startup process may take some time, but this leads to a smaller image size of **1.3GB**!
Consider using them if they fit your needs.
> [!NOTE]
> You can build it locally with Docker build arguments: `SKIP_REQUIREMENTS_INSTALL=true`
> [!TIP]
> This image can be used in a tricky way: to preserve and reuse the `/home/1001/.local` directory through a volume.
> It's like sharing the same environment across different Python applications.
> I wouldn't recommend this approach for regular users... you must be fully aware of what you're doing.
> As for power users, please refer to [this commit](https://github.com/jim60105/docker-stable-diffusion-webui/commit/0434e831fc4a4c15d17c4f86c822def096160e33) for more information.
> Thanks to the community for coming up with this amazing idea!😆

## 🛠️ Build instructions

Expand Down
19 changes: 12 additions & 7 deletions README.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,18 +112,23 @@ docker compose -f docker-compose.forge.yml up -d
### `runtime-deps` 版本

其中有些版本有 `runtime-deps` 映像,例如 `v1.8.0-runtime-deps``v1.9.3-runtime-deps``forge-runtime-deps`
> [!NOTE]
> 你可以使用以下建置參數來建置它: `SKIP_REQUIREMENTS_INSTALL=true`
`runtime-deps` 映像中不包含 pip 套件依賴,相反地,它們將在首次啟動時進行下載和安裝
在一些近期的版本會有 `runtime-deps` 映像可供選擇,例如 `v1.8.0-runtime-deps``v1.9.3-runtime-deps``forge-runtime-deps`

這讓我能把映像尺寸縮得更小, **1.3GB**
這些映像中不包含 pip 套件依賴,相反地,它們將在首次啟動時進行下載和安裝。

其缺點是第一次啟動時需要等待一段時間,且套件無法取得的話也會導致失敗。
第一次啟動時需要等待一段時間,但這能讓我把映像縮小至 **1.3GB**

若這正好符合你的需求,請考慮使用它們
如果這符合您的需求,可以考慮使用它們

> [!NOTE]
> 你可以使用以下建置參數來建置它: `SKIP_REQUIREMENTS_INSTALL=true`
> [!TIP]
> 它有一個特殊的使用方式: 透過 volume 保存並重複利用 `/home/1001/.local` 資料夾。
> 這就像是在不同的 Python 應用程式之間共用同一個環境。
> 我不推薦一般使用者採用這種方法...你必須完全清楚自己在做什麼。
> 對於進階使用者,請參考[這個 commit](https://github.com/jim60105/docker-stable-diffusion-webui/commit/0434e831fc4a4c15d17c4f86c822def096160e33) 以查看更多資訊。
> 感謝社群提出這個驚人的想法!😆
## 🛠️ 建置指南

Expand Down

0 comments on commit b5376f7

Please sign in to comment.