xinyun/ComfyUI
1
0
Fork 0
mirror of https://git.datalinker.icu/comfyanonymous/ComfyUI synced 2026-09-06 16:27:04 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: add comprehensive installation and user guide for ComfyUI

Browse Source
This commit is contained in:
Mister K 2025-05-02 23:57:47 +08:00
parent 74e61a1bce
commit 219ee6a923
5 changed files with 402 additions and 396 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

442
README.md
View File

@ -1,424 +1,74 @@
<div align="center">
# ComfyUI
**The most powerful and modular visual AI engine and application.**
**A powerful and modular stable diffusion GUI with a graph/nodes interface.**
[![Website][website-shield]][website-url]
[![Dynamic JSON Badge][discord-shield]][discord-url]
[![Matrix][matrix-shield]][matrix-url]
<br>
[![][github-release-shield]][github-release-link]
[![][github-release-date-shield]][github-release-link]
[![][github-downloads-shield]][github-downloads-link]
[![][github-downloads-latest-shield]][github-downloads-link]
[matrix-shield]: https://img.shields.io/badge/Matrix-000000?style=flat&logo=matrix&logoColor=white
[matrix-url]: https://app.element.io/#/room/%23comfyui_space%3Amatrix.org
[website-shield]: https://img.shields.io/badge/ComfyOrg-4285F4?style=flat
[website-url]: https://www.comfy.org/
<!-- Workaround to display total user from https://github.com/badges/shields/issues/4500#issuecomment-2060079995 -->
[discord-shield]: https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fdiscord.com%2Fapi%2Finvites%2Fcomfyorg%3Fwith_counts%3Dtrue&query=%24.approximate_member_count&logo=discord&logoColor=white&label=Discord&color=green&suffix=%20total
[discord-url]: https://www.comfy.org/discord
[github-release-shield]: https://img.shields.io/github/v/release/comfyanonymous/ComfyUI?style=flat&sort=semver
[github-release-link]: https://github.com/comfyanonymous/ComfyUI/releases
[github-release-date-shield]: https://img.shields.io/github/release-date/comfyanonymous/ComfyUI?style=flat
[github-downloads-shield]: https://img.shields.io/github/downloads/comfyanonymous/ComfyUI/total?style=flat
[github-downloads-latest-shield]: https://img.shields.io/github/downloads/comfyanonymous/ComfyUI/latest/total?style=flat&label=downloads%40latest
[github-downloads-link]: https://github.com/comfyanonymous/ComfyUI/releases
![ComfyUI Screenshot](https://github.com/user-attachments/assets/7ccaf2c1-9b72-41ae-9a89-5688c94b7abe)
![ComfyUI Screenshot](https://comfyanonymous.github.io/ComfyUI_examples/comfyui_screenshot.png)
</div>
ComfyUI lets you design and execute advanced stable diffusion pipelines using a graph/nodes/flowchart based interface. Available on Windows, Linux, and macOS.
## Quick Start
## Get Started
### Option 1: Install as a Package (New!)
#### [Desktop Application](https://www.comfy.org/download)
- The easiest way to get started.
- Available on Windows & macOS.
#### [Windows Portable Package](#installing)
- Get the latest commits and completely portable.
- Available on Windows.
#### [Manual Install](#manual-install-windows-linux)
Supports all operating systems and GPU types (NVIDIA, AMD, Intel, Apple Silicon, Ascend).
## [Examples](https://comfyanonymous.github.io/ComfyUI_examples/)
See what ComfyUI can do with the [example workflows](https://comfyanonymous.github.io/ComfyUI_examples/).
## Features
- Nodes/graph/flowchart interface to experiment and create complex Stable Diffusion workflows without needing to code anything.
- Image Models
- SD1.x, SD2.x,
- [SDXL](https://comfyanonymous.github.io/ComfyUI_examples/sdxl/), [SDXL Turbo](https://comfyanonymous.github.io/ComfyUI_examples/sdturbo/)
- [Stable Cascade](https://comfyanonymous.github.io/ComfyUI_examples/stable_cascade/)
- [SD3 and SD3.5](https://comfyanonymous.github.io/ComfyUI_examples/sd3/)
- Pixart Alpha and Sigma
- [AuraFlow](https://comfyanonymous.github.io/ComfyUI_examples/aura_flow/)
- [HunyuanDiT](https://comfyanonymous.github.io/ComfyUI_examples/hunyuan_dit/)
- [Flux](https://comfyanonymous.github.io/ComfyUI_examples/flux/)
- [Lumina Image 2.0](https://comfyanonymous.github.io/ComfyUI_examples/lumina2/)
- [HiDream](https://comfyanonymous.github.io/ComfyUI_examples/hidream/)
- Video Models
- [Stable Video Diffusion](https://comfyanonymous.github.io/ComfyUI_examples/video/)
- [Mochi](https://comfyanonymous.github.io/ComfyUI_examples/mochi/)
- [LTX-Video](https://comfyanonymous.github.io/ComfyUI_examples/ltxv/)
- [Hunyuan Video](https://comfyanonymous.github.io/ComfyUI_examples/hunyuan_video/)
- [Nvidia Cosmos](https://comfyanonymous.github.io/ComfyUI_examples/cosmos/)
- [Wan 2.1](https://comfyanonymous.github.io/ComfyUI_examples/wan/)
- 3D Models
- [Hunyuan3D 2.0](https://docs.comfy.org/tutorials/3d/hunyuan3D-2)
- [Stable Audio](https://comfyanonymous.github.io/ComfyUI_examples/audio/)
- Asynchronous Queue system
- Many optimizations: Only re-executes the parts of the workflow that changes between executions.
- Smart memory management: can automatically run models on GPUs with as low as 1GB vram.
- Works even if you don't have a GPU with: ```--cpu``` (slow)
- Can load ckpt, safetensors and diffusers models/checkpoints. Standalone VAEs and CLIP models.
- Embeddings/Textual inversion
- [Loras (regular, locon and loha)](https://comfyanonymous.github.io/ComfyUI_examples/lora/)
- [Hypernetworks](https://comfyanonymous.github.io/ComfyUI_examples/hypernetworks/)
- Loading full workflows (with seeds) from generated PNG, WebP and FLAC files.
- Saving/Loading workflows as Json files.
- Nodes interface can be used to create complex workflows like one for [Hires fix](https://comfyanonymous.github.io/ComfyUI_examples/2_pass_txt2img/) or much more advanced ones.
- [Area Composition](https://comfyanonymous.github.io/ComfyUI_examples/area_composition/)
- [Inpainting](https://comfyanonymous.github.io/ComfyUI_examples/inpaint/) with both regular and inpainting models.
- [ControlNet and T2I-Adapter](https://comfyanonymous.github.io/ComfyUI_examples/controlnet/)
- [Upscale Models (ESRGAN, ESRGAN variants, SwinIR, Swin2SR, etc...)](https://comfyanonymous.github.io/ComfyUI_examples/upscale_models/)
- [unCLIP Models](https://comfyanonymous.github.io/ComfyUI_examples/unclip/)
- [GLIGEN](https://comfyanonymous.github.io/ComfyUI_examples/gligen/)
- [Model Merging](https://comfyanonymous.github.io/ComfyUI_examples/model_merging/)
- [LCM models and Loras](https://comfyanonymous.github.io/ComfyUI_examples/lcm/)
- Latent previews with [TAESD](#how-to-show-high-quality-previews)
- Starts up very fast.
- Works fully offline: will never download anything.
- [Config file](extra_model_paths.yaml.example) to set the search paths for models.
Workflow examples can be found on the [Examples page](https://comfyanonymous.github.io/ComfyUI_examples/)
## Release Process
ComfyUI follows a weekly release cycle every Friday, with three interconnected repositories:
1. **[ComfyUI Core](https://github.com/comfyanonymous/ComfyUI)**
- Releases a new stable version (e.g., v0.7.0)
- Serves as the foundation for the desktop release
2. **[ComfyUI Desktop](https://github.com/Comfy-Org/desktop)**
- Builds a new release using the latest stable core version
- Version numbers match the core release (e.g., Desktop v1.7.0 uses Core v1.7.0)
3. **[ComfyUI Frontend](https://github.com/Comfy-Org/ComfyUI_frontend)**
- Weekly frontend updates are merged into the core repository
- Features are frozen for the upcoming core release
- Development continues for the next release cycle
## Shortcuts
| Keybind | Explanation |
|------------------------------------|--------------------------------------------------------------------------------------------------------------------|
| `Ctrl` + `Enter` | Queue up current graph for generation |
| `Ctrl` + `Shift` + `Enter` | Queue up current graph as first for generation |
| `Ctrl` + `Alt` + `Enter` | Cancel current generation |
| `Ctrl` + `Z`/`Ctrl` + `Y` | Undo/Redo |
| `Ctrl` + `S` | Save workflow |
| `Ctrl` + `O` | Load workflow |
| `Ctrl` + `A` | Select all nodes |
| `Alt `+ `C` | Collapse/uncollapse selected nodes |
| `Ctrl` + `M` | Mute/unmute selected nodes |
| `Ctrl` + `B` | Bypass selected nodes (acts like the node was removed from the graph and the wires reconnected through) |
| `Delete`/`Backspace` | Delete selected nodes |
| `Ctrl` + `Backspace` | Delete the current graph |
| `Space` | Move the canvas around when held and moving the cursor |
| `Ctrl`/`Shift` + `Click` | Add clicked node to selection |
| `Ctrl` + `C`/`Ctrl` + `V` | Copy and paste selected nodes (without maintaining connections to outputs of unselected nodes) |
| `Ctrl` + `C`/`Ctrl` + `Shift` + `V` | Copy and paste selected nodes (maintaining connections from outputs of unselected nodes to inputs of pasted nodes) |
| `Shift` + `Drag` | Move multiple selected nodes at the same time |
| `Ctrl` + `D` | Load default graph |
| `Alt` + `+` | Canvas Zoom in |
| `Alt` + `-` | Canvas Zoom out |
| `Ctrl` + `Shift` + LMB + Vertical drag | Canvas Zoom in/out |
| `P` | Pin/Unpin selected nodes |
| `Ctrl` + `G` | Group selected nodes |
| `Q` | Toggle visibility of the queue |
| `H` | Toggle visibility of history |
| `R` | Refresh graph |
| `F` | Show/Hide menu |
| `.` | Fit view to selection (Whole graph when nothing is selected) |
| Double-Click LMB | Open node quick search palette |
| `Shift` + Drag | Move multiple wires at once |
| `Ctrl` + `Alt` + LMB | Disconnect all wires from clicked slot |
`Ctrl` can also be replaced with `Cmd` instead for macOS users
# Installing
## Windows Portable
There is a portable standalone build for Windows that should work for running on Nvidia GPUs or for running on your CPU only on the [releases page](https://github.com/comfyanonymous/ComfyUI/releases).
### [Direct link to download](https://github.com/comfyanonymous/ComfyUI/releases/latest/download/ComfyUI_windows_portable_nvidia.7z)
Simply download, extract with [7-Zip](https://7-zip.org) and run. Make sure you put your Stable Diffusion checkpoints/models (the huge ckpt/safetensors files) in: ComfyUI\models\checkpoints
If you have trouble extracting it, right click the file -> properties -> unblock
#### How do I share models between another UI and ComfyUI?
See the [Config file](extra_model_paths.yaml.example) to set the search paths for models. In the standalone windows build you can find this file in the ComfyUI directory. Rename this file to extra_model_paths.yaml and edit it with your favorite text editor.
## Jupyter Notebook
To run it on services like paperspace, kaggle or colab you can use my [Jupyter Notebook](notebooks/comfyui_colab.ipynb)
## [comfy-cli](https://docs.comfy.org/comfy-cli/getting-started)
You can install and start ComfyUI using comfy-cli:
```bash
pip install comfy-cli
comfy install
# Install ComfyUI with GPU support
uv pip install "comfyui[gpu]"
# Run ComfyUI
comfyui
```
## Manual Install (Windows, Linux)
### Option 2: From Source
python 3.13 is supported but using 3.12 is recommended because some custom nodes and their dependencies might not support it yet.
```bash
# Clone the repository
git clone https://github.com/comfyanonymous/ComfyUI.git
cd ComfyUI
Git clone this repo.
# Set up with UV (recommended)
./uv_setup.sh --gpu
Put your SD checkpoints (the huge ckpt/safetensors files) in: models/checkpoints
# Or on Windows:
python uv_setup.py --gpu
Put your VAE in: models/vae
## Installation Options
### Option 1: Install with UV (Recommended)
*Added 2025-05-02*
[UV](https://github.com/astral-sh/uv) is a faster, more reliable Python package installer that we now recommend for ComfyUI.
1. **Install UV**:
```bash
curl -LsSf https://astral.sh/uv/install.sh | sh
source $HOME/.local/bin/env # For bash/zsh
```
2. **Install ComfyUI dependencies**:
```bash
# Create and activate virtual environment
uv venv
source .venv/bin/activate # Linux/macOS
# or
.venv\Scripts\activate # Windows
# Install dependencies
uv pip install -r requirements.txt
```
For detailed instructions on using UV with ComfyUI, see our [UV Migration Guide](UV_MIGRATION.md).
### Option 2: Install with pip (Traditional)
### AMD GPUs (Linux only)
AMD users can install rocm and pytorch with pip if you don't have it already installed, this is the command to install the stable version:
```pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/rocm6.2.4```
This is the command to install the nightly with ROCm 6.3 which might have some performance improvements:
```pip install --pre torch torchvision torchaudio --index-url https://download.pytorch.org/whl/nightly/rocm6.3```
### Intel GPUs (Windows and Linux)
(Option 1) Intel Arc GPU users can install native PyTorch with torch.xpu support using pip (currently available in PyTorch nightly builds). More information can be found [here](https://pytorch.org/docs/main/notes/get_start_xpu.html)
1. To install PyTorch nightly, use the following command:
```pip install --pre torch torchvision torchaudio --index-url https://download.pytorch.org/whl/nightly/xpu```
2. Launch ComfyUI by running `python main.py`
(Option 2) Alternatively, Intel GPUs supported by Intel Extension for PyTorch (IPEX) can leverage IPEX for improved performance.
1. For Intel® Arc™ A-Series Graphics utilizing IPEX, create a conda environment and use the commands below:
```
conda install libuv
pip install torch==2.3.1.post0+cxx11.abi torchvision==0.18.1.post0+cxx11.abi torchaudio==2.3.1.post0+cxx11.abi intel-extension-for-pytorch==2.3.110.post0+xpu --extra-index-url https://pytorch-extension.intel.com/release-whl/stable/xpu/us/ --extra-index-url https://pytorch-extension.intel.com/release-whl/stable/xpu/cn/
# Run ComfyUI
python main.py
```
For other supported Intel GPUs with IPEX, visit [Installation](https://intel.github.io/intel-extension-for-pytorch/index.html#installation?platform=gpu) for more information.
## Main Features
Additional discussion and help can be found [here](https://github.com/comfyanonymous/ComfyUI/discussions/476).
- Nodes/graph/flowchart-based UI
- Highly optimized for better performance and VRAM usage
- Advanced prompt system with wildcards and more
- Create and share workflows as JSON files
- Supports multiple model backends
- Powerful API for external integration
- Extensible with custom nodes
### NVIDIA
## Requirements
Nvidia users should install stable pytorch using this command:
- Python 3.9+ (Python 3.11 recommended)
- GPU with at least 4GB VRAM (8GB+ recommended)
- [Optional] CUDA-compatible NVIDIA GPU for faster processing
```pip install torch torchvision torchaudio --extra-index-url https://download.pytorch.org/whl/cu128```
## Documentation
This is the command to install pytorch nightly instead which might have performance improvements.
- [Installation Guide](docs/installation.md)
- [User Guide](docs/user-guide.md)
- [API Documentation](docs/api.md)
- [Custom Nodes Guide](docs/custom-nodes.md)
- [UV Migration Guide](UV_MIGRATION.md)
```pip install --pre torch torchvision torchaudio --index-url https://download.pytorch.org/whl/nightly/cu128```
## Contributing
#### Troubleshooting
Please read our [Contributing Guidelines](CONTRIBUTING.md) before submitting pull requests.
If you get the "Torch not compiled with CUDA enabled" error, uninstall torch with:
## License
```pip uninstall torch```
ComfyUI is licensed under the GNU General Public License v3.0.
And install it again with the command above.
## Community
### Dependencies
Install the dependencies by opening your terminal inside the ComfyUI folder and:
```pip install -r requirements.txt```
After this you should have everything installed and can proceed to running ComfyUI.
### Others:
#### Apple Mac silicon
You can install ComfyUI in Apple Mac silicon (M1 or M2) with any recent macOS version.
1. Install pytorch nightly. For instructions, read the [Accelerated PyTorch training on Mac](https://developer.apple.com/metal/pytorch/) Apple Developer guide (make sure to install the latest pytorch nightly).
1. Follow the [ComfyUI manual installation](#manual-install-windows-linux) instructions for Windows and Linux.
1. Install the ComfyUI [dependencies](#dependencies). If you have another Stable Diffusion UI [you might be able to reuse the dependencies](#i-already-have-another-ui-for-stable-diffusion-installed-do-i-really-have-to-install-all-of-these-dependencies).
1. Launch ComfyUI by running `python main.py`
> **Note**: Remember to add your models, VAE, LoRAs etc. to the corresponding Comfy folders, as discussed in [ComfyUI manual installation](#manual-install-windows-linux).
#### DirectML (AMD Cards on Windows)
```pip install torch-directml``` Then you can launch ComfyUI with: ```python main.py --directml```
#### Ascend NPUs
For models compatible with Ascend Extension for PyTorch (torch_npu). To get started, ensure your environment meets the prerequisites outlined on the [installation](https://ascend.github.io/docs/sources/ascend/quick_install.html) page. Here's a step-by-step guide tailored to your platform and installation method:
1. Begin by installing the recommended or newer kernel version for Linux as specified in the Installation page of torch-npu, if necessary.
2. Proceed with the installation of Ascend Basekit, which includes the driver, firmware, and CANN, following the instructions provided for your specific platform.
3. Next, install the necessary packages for torch-npu by adhering to the platform-specific instructions on the [Installation](https://ascend.github.io/docs/sources/pytorch/install.html#pytorch) page.
4. Finally, adhere to the [ComfyUI manual installation](#manual-install-windows-linux) guide for Linux. Once all components are installed, you can run ComfyUI as described earlier.
#### Cambricon MLUs
For models compatible with Cambricon Extension for PyTorch (torch_mlu). Here's a step-by-step guide tailored to your platform and installation method:
1. Install the Cambricon CNToolkit by adhering to the platform-specific instructions on the [Installation](https://www.cambricon.com/docs/sdk_1.15.0/cntoolkit_3.7.2/cntoolkit_install_3.7.2/index.html)
2. Next, install the PyTorch(torch_mlu) following the instructions on the [Installation](https://www.cambricon.com/docs/sdk_1.15.0/cambricon_pytorch_1.17.0/user_guide_1.9/index.html)
3. Launch ComfyUI by running `python main.py`
# Running
```python main.py```
### For AMD cards not officially supported by ROCm
Try running it with this command if you have issues:
For 6700, 6600 and maybe other RDNA2 or older: ```HSA_OVERRIDE_GFX_VERSION=10.3.0 python main.py```
For AMD 7600 and maybe other RDNA3 cards: ```HSA_OVERRIDE_GFX_VERSION=11.0.0 python main.py```
### AMD ROCm Tips
You can enable experimental memory efficient attention on pytorch 2.5 in ComfyUI on RDNA3 and potentially other AMD GPUs using this command:
```TORCH_ROCM_AOTRITON_ENABLE_EXPERIMENTAL=1 python main.py --use-pytorch-cross-attention```
You can also try setting this env variable `PYTORCH_TUNABLEOP_ENABLED=1` which might speed things up at the cost of a very slow initial run.
# Notes
Only parts of the graph that have an output with all the correct inputs will be executed.
Only parts of the graph that change from each execution to the next will be executed, if you submit the same graph twice only the first will be executed. If you change the last part of the graph only the part you changed and the part that depends on it will be executed.
Dragging a generated png on the webpage or loading one will give you the full workflow including seeds that were used to create it.
You can use () to change emphasis of a word or phrase like: (good code:1.2) or (bad code:0.8). The default emphasis for () is 1.1. To use () characters in your actual prompt escape them like \\( or \\).
You can use {day|night}, for wildcard/dynamic prompts. With this syntax "{wild|card|test}" will be randomly replaced by either "wild", "card" or "test" by the frontend every time you queue the prompt. To use {} characters in your actual prompt escape them like: \\{ or \\}.
Dynamic prompts also support C-style comments, like `// comment` or `/* comment */`.
To use a textual inversion concepts/embeddings in a text prompt put them in the models/embeddings directory and use them in the CLIPTextEncode node like this (you can omit the .pt extension):
```embedding:embedding_filename.pt```
## How to show high-quality previews?
Use ```--preview-method auto``` to enable previews.
The default installation includes a fast latent preview method that's low-resolution. To enable higher-quality previews with [TAESD](https://github.com/madebyollin/taesd), download the [taesd_decoder.pth, taesdxl_decoder.pth, taesd3_decoder.pth and taef1_decoder.pth](https://github.com/madebyollin/taesd/) and place them in the `models/vae_approx` folder. Once they're installed, restart ComfyUI and launch it with `--preview-method taesd` to enable high-quality previews.
## How to use TLS/SSL?
Generate a self-signed certificate (not appropriate for shared/production use) and key by running the command: `openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -sha256 -days 3650 -nodes -subj "/C=XX/ST=StateName/L=CityName/O=CompanyName/OU=CompanySectionName/CN=CommonNameOrHostname"`
Use `--tls-keyfile key.pem --tls-certfile cert.pem` to enable TLS/SSL, the app will now be accessible with `https://...` instead of `http://...`.
> Note: Windows users can use [alexisrolland/docker-openssl](https://github.com/alexisrolland/docker-openssl) or one of the [3rd party binary distributions](https://wiki.openssl.org/index.php/Binaries) to run the command example above.
<br/><br/>If you use a container, note that the volume mount `-v` can be a relative path so `... -v ".\:/openssl-certs" ...` would create the key & cert files in the current directory of your command prompt or powershell terminal.
## Support and dev channel
[Discord](https://comfy.org/discord): Try the #help or #feedback channels.
[Matrix space: #comfyui_space:matrix.org](https://app.element.io/#/room/%23comfyui_space%3Amatrix.org) (it's like discord but open source).
See also: [https://www.comfy.org/](https://www.comfy.org/)
## Frontend Development
As of August 15, 2024, we have transitioned to a new frontend, which is now hosted in a separate repository: [ComfyUI Frontend](https://github.com/Comfy-Org/ComfyUI_frontend). This repository now hosts the compiled JS (from TS/Vue) under the `web/` directory.
### Reporting Issues and Requesting Features
For any bugs, issues, or feature requests related to the frontend, please use the [ComfyUI Frontend repository](https://github.com/Comfy-Org/ComfyUI_frontend). This will help us manage and address frontend-specific concerns more efficiently.
### Using the Latest Frontend
The new frontend is now the default for ComfyUI. However, please note:
1. The frontend in the main ComfyUI repository is updated fortnightly.
2. Daily releases are available in the separate frontend repository.
To use the most up-to-date frontend version:
1. For the latest daily release, launch ComfyUI with this command line argument:
```
--front-end-version Comfy-Org/ComfyUI_frontend@latest
```
2. For a specific version, replace `latest` with the desired version number:
```
--front-end-version Comfy-Org/ComfyUI_frontend@1.2.2
```
This approach allows you to easily switch between the stable fortnightly release and the cutting-edge daily updates, or even specific versions for testing purposes.
### Accessing the Legacy Frontend
If you need to use the legacy frontend for any reason, you can access it using the following command line argument:
```
--front-end-version Comfy-Org/ComfyUI_legacy_frontend@latest
```
This will use a snapshot of the legacy frontend preserved in the [ComfyUI Legacy Frontend repository](https://github.com/Comfy-Org/ComfyUI_legacy_frontend).
# QA
### Which GPU should I buy for this?
[See this page for some recommendations](https://github.com/comfyanonymous/ComfyUI/wiki/Which-GPU-should-I-buy-for-ComfyUI)
- [Discord Server](https://comfy.org/discord)
- [GitHub Issues](https://github.com/comfyanonymous/ComfyUI/issues)
- [Examples Repository](https://github.com/comfyanonymous/ComfyUI_examples)

0
docs/INSTALL.md Normal file
View File

0
docs/UV_PACKAGE.md Normal file
View File

162
docs/installation.md Normal file
View File

@ -0,0 +1,162 @@
# Installation Guide
This document provides detailed instructions for installing ComfyUI using different methods.
## Table of Contents
- [System Requirements](#system-requirements)
- [Installation Methods](#installation-methods)
- [Option 1: Install as a Package (Recommended)](#option-1-install-as-a-package-recommended)
- [Option 2: Install from Source](#option-2-install-from-source)
- [Option 3: Docker Installation](#option-3-docker-installation)
- [GPU Setup](#gpu-setup)
- [Troubleshooting](#troubleshooting)
## System Requirements
### Minimum Requirements
- Python 3.9 or newer (Python 3.11 recommended)
- NVIDIA GPU with at least 4GB VRAM
- 8GB RAM
- 2GB free disk space
### Recommended Specifications
- Python 3.11
- NVIDIA GPU with 8GB+ VRAM (RTX series recommended)
- 16GB RAM
- SSD with 10GB+ free space
## Installation Methods
### Option 1: Install as a Package (Recommended)
The package installation method is the simplest way to get started with ComfyUI.
#### Install with UV (Fastest)
[UV](https://github.com/astral-sh/uv) is a fast, reliable package manager for Python. We recommend using it for the best installation experience:
```bash
# Install UV if you don't have it
curl -LsSf https://astral.sh/uv/install.sh | sh
# Create and activate a virtual environment
uv venv .venv
source .venv/bin/activate # On Linux/macOS
# OR
.venv\Scripts\activate # On Windows
# Install ComfyUI with GPU support
uv pip install "comfyui[gpu]"
# Run ComfyUI
comfyui
```
#### Install with Pip
If you prefer using standard pip:
```bash
# Create and activate a virtual environment
python -m venv venv
source venv/bin/activate # On Linux/macOS
# OR
venv\Scripts\activate # On Windows
# Install ComfyUI
pip install "comfyui[gpu]"
# Run ComfyUI
comfyui
```
### Option 2: Install from Source
Installing from source gives you the latest development version and more control over the installation process.
```bash
# Clone the repository
git clone https://github.com/comfyanonymous/ComfyUI.git
cd ComfyUI
# Method A: Use the setup script (recommended)
python uv_setup.py --gpu --advanced
# Method B: Manual installation
# Create virtual environment
uv venv .venv
source .venv/bin/activate # On Linux/macOS
# OR
.venv\Scripts\activate # On Windows
# Install dependencies
uv pip install -r requirements.txt
# Run ComfyUI
python main.py
```
### Option 3: Docker Installation
For users who prefer containerized applications:
```bash
# Pull and run the ComfyUI Docker image
docker pull comfyanonymous/comfyui:latest
docker run -p 8188:8188 -v /path/to/models:/app/models comfyanonymous/comfyui:latest
```
## GPU Setup
### NVIDIA GPUs
ComfyUI works best with NVIDIA GPUs using CUDA. To leverage GPU acceleration:
1. Ensure you have the latest NVIDIA drivers installed
2. Install the CUDA-enabled version of ComfyUI:
```bash
uv pip install "comfyui[gpu]"
```
### AMD GPUs
For AMD GPUs, follow these additional steps:
1. Install ROCm (for compatible AMD GPUs)
2. Install PyTorch with ROCm support
3. Configure ComfyUI for AMD GPU usage:
```bash
python main.py --use-rocm
```
## Troubleshooting
### Common Issues
#### CUDA Out of Memory
If you encounter CUDA out of memory errors:
- Try using `--disable-cuda-malloc` flag
- Lower model precision using the `--fp16` flag
- Use smaller-sized models
#### Missing Dependencies
If you encounter missing dependencies:
```bash
uv pip install --upgrade -r requirements.txt
```
#### Package Conflicts
If you have conflicting packages:
```bash
uv pip install --force-reinstall "comfyui[gpu]"
```
### Getting Help
If you encounter issues not covered here:
- Check the [Discord server](https://comfy.org/discord) for community support
- Search for similar issues in the [GitHub repository](https://github.com/comfyanonymous/ComfyUI/issues)
- Run with `--verbose` flag for detailed logs:
```bash
comfyui --verbose
```

194
docs/user-guide.md Normal file
View File

@ -0,0 +1,194 @@
# User Guide
This document provides detailed information on how to use ComfyUI effectively.
## Table of Contents
- [Getting Started](#getting-started)
- [Interface Overview](#interface-overview)
- [Working with Nodes](#working-with-nodes)
- [Managing Models](#managing-models)
- [Creating Workflows](#creating-workflows)
- [Advanced Features](#advanced-features)
- [Best Practices](#best-practices)
## Getting Started
After installing ComfyUI, you can access it via your web browser:
1. Start ComfyUI:
```bash
comfyui
# OR if installed from source
python main.py
```
2. Open your web browser and navigate to:
```
http://localhost:8188
```
3. ComfyUI will load with an empty workspace where you can create your nodes and workflow.
## Interface Overview
### Main Areas
- **Canvas**: The main area where you create and connect nodes
- **Node Menu**: Left sidebar with available nodes categorized by function
- **Settings**: Access global settings via the gear icon in the top right
- **Queue**: View and manage processing queue in the top panel
### Navigation
- **Pan**: Middle mouse button or Alt + Left mouse button
- **Zoom**: Mouse wheel or Ctrl + Mouse wheel
- **Select multiple nodes**: Drag a selection box or Shift + Click
- **Move nodes**: Drag selected nodes
- **Delete nodes**: Select and press Delete key
## Working with Nodes
### Node Basics
Nodes are the building blocks of ComfyUI workflows. Each node performs a specific function and can be connected to other nodes.
#### Node Types
- **Input Nodes**: Provide data (text prompts, images, etc.)
- **Processing Nodes**: Transform data (models, samplers, conditioning)
- **Output Nodes**: Generate results (images, videos, latents)
- **Utility Nodes**: Helper functions (math, logic, conversion)
#### Creating Nodes
1. Right-click on the canvas
2. Navigate through the menu categories
3. Click on the node you want to add
4. Alternatively, use the Quick Node Search with Ctrl+Space
#### Connecting Nodes
1. Click and drag from an output socket (right side)
2. Connect to an input socket (left side)
3. Compatible connections will be highlighted
4. Incompatible connections will be rejected
### Node Properties
Each node has properties that can be configured:
1. Click on a node to select it
2. Adjust parameters in the property panel
3. Some parameters support dynamic values via connections
## Managing Models
ComfyUI supports various AI models for different purposes.
### Model Types
- **Checkpoints**: Main Stable Diffusion models
- **LoRA**: Style adaptations and fine-tuning
- **Textual Inversions/Embeddings**: Concept encodings
- **VAE**: Variational autoencoders for encoding/decoding
- **CLIP**: Text encoders for prompts
- **ControlNet**: Models for guided image generation
### Loading Models
Models can be loaded via dedicated nodes:
1. Add the appropriate model loader node
2. Select your model from the dropdown
3. Connect to other nodes that require the model
### Model Management
- Models are stored in the `models` directory
- Subdirectories organize different model types
- Add new models by placing them in the appropriate folder
- ComfyUI automatically detects new models on startup
## Creating Workflows
### Basic Workflow
A minimal image generation workflow consists of:
1. **Checkpoint Loader**: Load a model
2. **CLIP Text Encode**: Process positive and negative prompts
3. **KSampler**: Configure sampling parameters
4. **VAE Decode**: Convert latent representation to image
5. **Save Image**: Output the generated image
### Workflow Management
- **Save Workflow**: Click "Save" to download JSON workflow file
- **Load Workflow**: Click "Load" to import a workflow
- **Share Workflows**: Exchange JSON files with others
- **API Access**: Workflows can be executed via API
### Workflow Templates
ComfyUI includes templates for common tasks:
1. Click "Load" to access templates
2. Select a template that matches your need
3. Modify parameters to customize the results
## Advanced Features
### Batching
Process multiple images with one workflow:
1. Use batch size parameter in sampler nodes
2. Use Empty Latent Image with multiple batches
3. Process results with Latent from Batch node
### Animation
Create animations using keyframes or video input:
1. Use Animate Diff or similar animation nodes
2. Configure frames, motion, and interpolation
3. Output video or image sequence
### Upscaling
Enhance resolution of generated images:
1. Generate base image
2. Feed into upscaler node (Lanczos, ESRGAN, etc.)
3. Configure scale factor and parameters
4. Save higher resolution result
## Best Practices
### Performance Optimization
- Use half-precision (fp16) for faster processing
- Adjust VRAM usage in settings
- Process at lower resolution and upscale later
- Use VAE tiling for large images
### Workflow Organization
- Group related nodes for clarity
- Add comment nodes to document workflows
- Use consistent naming conventions
- Break complex workflows into subgraphs
### Common Pitfalls
- Ensure compatible node connections
- Watch VRAM usage for larger models
- Backup workflows regularly
- Check error messages in console log
### Getting Help
- Hover over node inputs/outputs for tooltips
- Check documentation for specific nodes
- Visit Discord community for support
- Explore shared workflows for examples