Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
YanWenKun committed Sep 7, 2024
1 parent a7800b5 commit 53ac087
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 23 deletions.
31 changes: 17 additions & 14 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ that download model files on the first run (often causing freezing for users wit

== How to Use

1. Only NVIDIA graphics cards are supported, preferably with the latest drivers installed.
** AMD graphics cards may __possibly__ work with ZLUDA after installing the HIP SDK, and this requires modifying startup parameters, among other things.
1. Only NVIDIA GPUs are supported, preferably with the latest drivers installed.
** AMD GPUs may __possibly__ work with ZLUDA after installing the HIP SDK, and this requires modifying startup parameters, among other things.

2. Download the package files from the release page:
** https://github.com/YanWenKun/ComfyUI-Windows-Portable/releases
Expand All @@ -48,11 +48,24 @@ that download model files on the first run (often causing freezing for users wit
3. Place SD models in `ComfyUI\models\checkpoints`.
** Subdirectories can be created for better organization.

4. **Run `run_nvidia_gpu.bat` to start ComfyUI.**
4. Run `run_nvidia_gpu.bat` to start ComfyUI.

5. After starting, the program will automatically open a browser, or you can visit: http://localhost:8188/
** If you don't want the browser to open automatically, edit `run_nvidia_gpu.bat` and add the startup parameter `--disable-auto-launch`.

== Important Prerequisites For 3D-Pack Users

Few steps before running Comfy3D:

1. Install
https://visualstudio.microsoft.com/downloads/?q=build+tools[Visual Studio Build Tools 2022]
with "Desktop development with C++" workload.
Its compiler will be needed (for some JIT code).

2. Install
https://developer.nvidia.com/cuda-downloads?target_os=Windows&target_arch=x86_64&target_version=11&target_type=exe_local[CUDA Toolkit],
latest version is fine as long as it's 12.x.

== Tips for Usage

1. Model Path: If model files are already saved in another location and you don't want to move them, you can configure the program to load them:
Expand All @@ -70,17 +83,7 @@ set HTTPS_PROXY=http://localhost:1081

4. Language: Click the gear (⚙) icon at the top right corner of the ComfyUI page to modify settings. Find *AGLTranslation* to change the language (default is English, options are {Chinese, Japanese, Korean}).

5. 3D-Pack: Besides SD models, some custom nodes may require downloading more models, such as the
link:https://huggingface.co/stabilityai/TripoSR/blob/main/model.ckpt[TripoSR]
used in 3D workflows.
However, including all of them would make the package too large, so they were not included.
Moreover, you still need to install
https://visualstudio.microsoft.com/downloads/?q=build+tools[Visual Studio Build Tools 2022]
with "Desktop development with C++" workload
to fully utilize ComfyUI-3D-Pack (some JIT codes need to be compiled in runtime).
If you need to use the corresponding nodes, please pay attention to the respective project pages.

6. How to upgrade: ComfyUI-Manager can do most updates, but if you want a "fresh" upgrade, you can first delete the `python_embeded` directory, and then extract the same-named directory from the new version's package to the original location. Additional "try fix" in ComfyUI-Manager may be needed.
5. How to upgrade: ComfyUI-Manager can do most updates, but if you want a "fresh" upgrade, you can first delete the `python_embeded` directory, and then extract the same-named directory from the new version's package to the original location. Additional "try fix" in ComfyUI-Manager may be needed.

== Details

Expand Down
23 changes: 14 additions & 9 deletions README.zh.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,19 @@ https://github.com/ltdrdata/ComfyUI-Impact-Pack[Impact Pack]
6. 点击 ComfyUI 页面右上角的 齿轮(⚙)图标可修改设置,找到 *AGLTranslation* 可以修改语言(默认 English)。
== 运行 3D-Pack 前置条件

1. 安装
https://visualstudio.microsoft.com/downloads/?q=build+tools[Visual Studio 2022 生成工具]
(选择安装“桌面C++开发”),其他版本 VS + CPP 亦可。
一些 PyTorch 的 CPP 扩展需要 JIT 编译。

2. 安装
https://developer.nvidia.com/cuda-downloads?target_os=Windows&target_arch=x86_64&target_version=11&target_type=exe_local[CUDA Toolkit],
最新版即可,只要大版本还在 12.x 就兼容。

此外请注意,Comfy3D 还会在执行各节点时下载所需模型,而访问 HuggingFace 可能需要挂代理。

## 使用技巧

1. 如果在其他位置已经保存了模型文件,且不想移动,可以配置程序加载:
Expand All @@ -64,15 +77,7 @@ set HTTPS_PROXY=http://localhost:1081
3. 善加利用 ComfyUI-Manager (ComfyUI 页面右下角 *Manager* 按钮),可用它来安装更多自定义节点,或更新 ComfyUI 及节点,也可以禁用不需要的节点。
** 如果觉得一些用不到的节点影响了启动时间,可以将其禁用。

4. 除了绘图模型外,一些自定义节点还需要下载更多模型,比如 3D 模型会用到的
https://huggingface.co/stabilityai/TripoSR/blob/main/model.ckpt[TripoSR]
,但如果都打包进来就太大了,这里权衡之下没有放。
此外 3D 相关的部分组件依然需要安装
https://visualstudio.microsoft.com/downloads/?q=build+tools[Visual Studio 2022](选择安装“桌面C++开发”)
,因为有些 GPU 相关代码需要运行时编译(一些 Torch 的 JIT CPP 扩展)。
如果需要用到对应节点,还请留意相应的项目页面。
5. 如何大更新:ComfyUI-Manager 可以完成大部分的更新,但如果想要“翻新式”更新,可以先删除 `python_embeded` 目录,再将新版压缩包中的同名目录解压到原来位置即可。可能需要额外在 ComfyUI-Manager 中“try fix”。
4. 如何大更新:ComfyUI-Manager 可以完成大部分的更新,但如果想要“翻新式”更新,可以先删除 `python_embeded` 目录,再将新版压缩包中的同名目录解压到原来位置即可。可能需要额外在 ComfyUI-Manager 中“try fix”。

## 细节

Expand Down

0 comments on commit 53ac087

Please sign in to comment.