UmeAiRT commited on
Commit
f55443f
Β·
verified Β·
1 Parent(s): 921cbfb

Update README and AGENTS.md

Browse files
Files changed (2) hide show
  1. AGENTS.md +29 -5
  2. README.md +99 -96
AGENTS.md CHANGED
@@ -2,25 +2,42 @@
2
 
3
  ## Purpose
4
 
5
- Pure assets repository (HuggingFace LFS) for model files and installation binaries used by [ComfyUI-Auto_installer](https://github.com/UmeAiRT/ComfyUI-Auto_installer). No code β€” only large binary files.
6
 
7
  ## Ecosystem
8
 
9
- This repo is consumed by the **Auto_installer** project's PowerShell download scripts. Any file rename or move here **must** be reflected in the corresponding download scripts.
 
 
 
 
 
 
 
 
10
 
11
  ## Folder Structure
12
 
13
  | Folder | Contents | Notes |
14
  |---|---|---|
15
- | `models/diffusion_models/` | Backbone models (GGUF + safetensors) | Official ComfyUI folder. Organized by family (`FLUX/`, `WAN/`, etc.) |
16
  | `models/text_encoders/` | Text encoders (T5, QWEN, GEMMA, LLAMA) | Official ComfyUI folder. **NOT** `clip/` |
17
- | `models/clip/` | CLIP models only (clip_l, clip_g, ViT, longclip) | Legacy alias of `text_encoders/`. Do NOT put text encoders here |
 
18
  | `models/checkpoints/` | Full merged checkpoints | |
19
- | `models/loras/` | LoRA adapters | |
20
  | `models/vae/` | VAE models (transverse, shared across families) | |
 
21
  | `models/controlnet/` | ControlNet models | |
 
 
 
 
 
22
  | `models/xlabs/` | XLabs custom node models | ⚠️ Hardcoded path β€” do NOT move |
23
  | `models/onnx/` | ONNX upscalers for TensorRT | ⚠️ Hardcoded path β€” do NOT move |
 
 
24
  | `bin/` | Installation executables (Git, Python, CUDA, etc.) | |
25
  | `whl/` | Pre-compiled Python wheels | |
26
  | `packages/` | Zip archives (extensions, build tools, configs) | |
@@ -43,3 +60,10 @@ Examples: `Flux1-Dev-Q4_K_S.gguf`, `Wan2.2-T2V-HighNoise-14B-Q8_0.gguf`
43
  - Precision suffixes: `fp16`, `bf16`, `fp8_e4m3fn`, `fp8_scaled`
44
 
45
  Examples: `wan2.1-t2v-14b-fp16.safetensors`, `qwen-image-edit-fp8_e4m3fn.safetensors`
 
 
 
 
 
 
 
 
2
 
3
  ## Purpose
4
 
5
+ Pure assets repository (HuggingFace LFS + ModelScope mirror) for model files and installation binaries used by [ComfyUI-Auto_installer](https://github.com/UmeAiRT/ComfyUI-Auto_installer). No code β€” only large binary files.
6
 
7
  ## Ecosystem
8
 
9
+ This repo is consumed by:
10
+ - **[ComfyUI-Auto_installer](https://github.com/UmeAiRT/ComfyUI-Auto_installer)** β€” PowerShell download scripts reference these files by exact path
11
+ - **[ComfyUI-UmeAiRT-Toolkit](https://github.com/UmeAiRT/ComfyUI-UmeAiRT-Toolkit)** β€” Automatic model downloader nodes pull from this repo
12
+
13
+ Any file rename or move here **must** be reflected in both projects' download logic.
14
+
15
+ **Mirrors:**
16
+ - **HuggingFace:** [UmeAiRT/ComfyUI-Auto_installer](https://huggingface.co/UmeAiRT/ComfyUI-Auto_installer)
17
+ - **ModelScope:** [UmeAiRT/ComfyUI-Auto-Installer-Assets](https://www.modelscope.ai/datasets/UmeAiRT/ComfyUI-Auto-Installer-Assets)
18
 
19
  ## Folder Structure
20
 
21
  | Folder | Contents | Notes |
22
  |---|---|---|
23
+ | `models/diffusion_models/` | Backbone models (GGUF + safetensors) | Official ComfyUI folder. Organized by family (`FLUX/`, `WAN/`, `QWEN/`, `HiDream/`, `LTX-2/`, `LTXV/`, `Z-IMG/`, `MelBandRoFormer/`) |
24
  | `models/text_encoders/` | Text encoders (T5, QWEN, GEMMA, LLAMA) | Official ComfyUI folder. **NOT** `clip/` |
25
+ | `models/clip/` | CLIP models only (clip_l, clip_g, ViT, longclip) | Different from `text_encoders/`. Do NOT put text encoders here |
26
+ | `models/clip_vision/` | CLIP Vision encoders (clip_vision_h, sigclip) | Used by IP-Adapter / Redux |
27
  | `models/checkpoints/` | Full merged checkpoints | |
28
+ | `models/loras/` | LoRA adapters | Organized by family (`FLUX/`, `WAN2.1/`, `WAN2.2/`, `QWEN/`, `LTX-2/`) |
29
  | `models/vae/` | VAE models (transverse, shared across families) | |
30
+ | `models/vae_approx/` | Approximate VAE decoders (TAESD) | For fast preview |
31
  | `models/controlnet/` | ControlNet models | |
32
+ | `models/upscale_models/` | Upscaler models (RealESRGAN, etc.) | |
33
+ | `models/style_models/` | Style/Redux models | |
34
+ | `models/pulid/` | PuLID face models | |
35
+ | `models/sams/` | SAM segmentation models | |
36
+ | `models/ultralytics/` | YOLO detection models (face, hand) | |
37
  | `models/xlabs/` | XLabs custom node models | ⚠️ Hardcoded path β€” do NOT move |
38
  | `models/onnx/` | ONNX upscalers for TensorRT | ⚠️ Hardcoded path β€” do NOT move |
39
+ | `models/tensorrt/` | Pre-built TensorRT engines | ⚠️ Hardcoded path β€” do NOT move |
40
+ | `models/LLM/` | Language models (Florence PromptGen) | Multi-file model directories |
41
  | `bin/` | Installation executables (Git, Python, CUDA, etc.) | |
42
  | `whl/` | Pre-compiled Python wheels | |
43
  | `packages/` | Zip archives (extensions, build tools, configs) | |
 
60
  - Precision suffixes: `fp16`, `bf16`, `fp8_e4m3fn`, `fp8_scaled`
61
 
62
  Examples: `wan2.1-t2v-14b-fp16.safetensors`, `qwen-image-edit-fp8_e4m3fn.safetensors`
63
+
64
+ ## Quantization Coverage Target
65
+
66
+ Each diffusion model family should provide these versions when available upstream:
67
+ - **Full precision:** `bf16` or `fp16` (safetensors)
68
+ - **Reduced precision:** `fp8_e4m3fn` or `fp8_scaled` (safetensors)
69
+ - **GGUF quantizations:** `Q8_0`, `Q6_K`, `Q5_K_S`, `Q4_K_S`, `Q3_K_S`
README.md CHANGED
@@ -1,102 +1,105 @@
1
  ---
2
  license: mit
3
  tags:
4
- - code
5
  - comfyui
6
- - installer
7
- - auto
 
 
 
 
 
 
8
  ---
9
- # UmeAiRT's ComfyUI Auto-Installer
10
 
11
- ![PowerShell](https://img.shields.io/badge/PowerShell-5.1%2B-blue.svg)
12
- ![Platform](https://img.shields.io/badge/Platform-Windows%2010%2F11-lightgrey.svg)
13
- ![License](https://img.shields.io/badge/License-MIT-green.svg)
14
-
15
- This project provides a suite of PowerShell scripts to fully automate the installation and configuration of ComfyUI on Windows. The approach uses a clean installation based on `git` and a Python virtual environment (`venv`), ensuring an isolated, easy-to-update, and maintainable setup.
16
-
17
- ## Features
18
-
19
- - **Clean Installation:** Clones the latest version of ComfyUI from the official repository and installs it in a dedicated Anaconda Python virtual environment.
20
- - **Dependency Management:** Automatically checks for and installs necessary tools:
21
- - Anaconda Python 3.13 (if not present on the system)
22
- - Git
23
- - 7-Zip
24
- - Aria2 (for accelerated downloads)
25
- - **CSV-Managed Custom Nodes:** Installs a comprehensive list of custom nodes defined in an external `custom_nodes.csv` file, making it simple to add new nodes.
26
- - **Interactive Model Downloaders:** Dedicated scripts guide you with menus to download the model packs you want (FLUX, WAN, HIDREAM, LTXV), with recommendations based on your graphics card's VRAM.
27
- - **Dedicated Update Script:** A specific `UmeAiRT-Updater.ps1` script allows you to update ComfyUI, all custom nodes, and workflows with a single command.
28
- - **Automated Launchers:** The project generates `.bat` files to run the installation, updates, and the final application, automatically handling administrator rights and PowerShell execution policies.
29
- - **Supplementary modules:** The script also installs some complex modules such as: Sageattention, Triton, Visual Studio Build Tools, ...
30
- - **Workflow included:** A large amount of workflows are pre-installed for each model.
31
-
32
- ## Prerequisites
33
-
34
- - Windows 10 or Windows 11 (64-bit).
35
- - An active internet connection.
36
- - CUDA 13.0.
37
- - Python 3.13.
38
- - GIT for Windows.
39
-
40
- ## Installation and Usage
41
-
42
- The entire process is designed to be as simple as possible.
43
-
44
- 1. **Download the Project:** Download `UmeAiRT-Install-ComfyUI.bat` and put it to a folder of your choice (e.g., `C:\UmeAiRT-Installer`).
45
-
46
- 2. **Run the Installer:**
47
- - Run the file `UmeAiRT-Install-ComfyUI.bat`.
48
- - It will ask for administrator privileges. Please accept.
49
- - The script will first download the latest versions of all installation scripts from the repository to ensure you are using the most recent version.
50
-
51
- 3. **Follow the Instructions:**
52
- - The main installation script will then launch. It will install Python (if necessary), Git, 7-Zip, Aria2, and then ComfyUI.
53
- - Next, it will install all custom nodes and their Python dependencies into the virtual environment.
54
- - Finally, it will ask you a series of questions about which model packs you wish to download. Simply answer `Y` (yes) or `N` (no) to each question.
55
-
56
- At the end of the process, your ComfyUI installation will be complete and ready to use.
57
-
58
- ## Post-Installation Usage
59
-
60
- Three main `.bat` files will be available in your folder to manage the application:
61
-
62
- - **`UmeAiRT-Start-ComfyUI.bat`**
63
- - This is the file you will use to **launch ComfyUI**. It activates the virtual environment and starts the server.
64
-
65
- - **`UmeAiRT-Download_models.bat`**
66
- - Run this script if you want to **add more model packs** later without reinstalling everything. It will present you with the same selection menu as the initial installation.
67
-
68
- - **`UmeAiRT-Update-ComfyUI.bat`**
69
- - Execute this script to **update your entire installation**. It will update the code for ComfyUI, all custom nodes, and your workflows, and it will install any new Python dependencies if required.
70
-
71
- ## File Structure
72
-
73
- - **`/` (your root folder)**
74
- - `UmeAiRT-Installer-Updater.bat` (Main launcher that updates and installs)
75
- - `UmeAiRT-Start-ComfyUI.bat` (Created after installation to launch ComfyUI)
76
- - `UmeAiRT-Update-ComfyUI.bat` (Launcher for the update script)
77
- - `UmeAiRT-Download_models.bat` (Menu to download more models later)
78
- - **`scripts/`** (Contains all PowerShell scripts)
79
- - `Install-ComfyUI.ps1`
80
- - `UmeAiRT-Updater.ps1`
81
- - `Download-FLUX-Models.ps1` (and other model downloaders)
82
- - `custom_nodes.csv` (The list of all custom nodes to install)
83
- - **`ComfyUI/`** (Created after installation, contains the application)
84
- - **`logs/`** (Created, contains installation/update logs)
85
-
86
- ## Contributing
87
-
88
- Suggestions and contributions are welcome. If you find a bug or have an idea for an improvement to the scripts, feel free to open an "Issue" on this GitHub repository.
89
-
90
- ## License
91
-
92
- This project is under the MIT License. See the `LICENSE` file for more details.
93
-
94
- ## Acknowledgements
95
-
96
- - To **Comfyanonymous** for creating the incredible ComfyUI.
97
- - To the authors of all the **custom nodes** that enrich the ecosystem.
98
-
99
-
100
- ![alt text][logo]
101
-
102
- [logo]: images/UmeAiRT.png "UmeAiRT logo"
 
1
  ---
2
  license: mit
3
  tags:
 
4
  - comfyui
5
+ - models
6
+ - gguf
7
+ - safetensors
8
+ - flux
9
+ - wan
10
+ - qwen
11
+ - hidream
12
+ - ltxv
13
  ---
 
14
 
15
+ # ComfyUI Auto-Installer β€” Assets
16
+
17
+ [![HuggingFace](https://img.shields.io/badge/πŸ€—_HuggingFace-UmeAiRT-yellow.svg)](https://huggingface.co/UmeAiRT/ComfyUI-Auto_installer)
18
+ [![ModelScope](https://img.shields.io/badge/πŸ”¬_ModelScope-UmeAiRT-blue.svg)](https://www.modelscope.ai/datasets/UmeAiRT/ComfyUI-Auto-Installer-Assets)
19
+ [![License](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
20
+
21
+ Pre-packaged model files and binaries for the UmeAiRT ecosystem. This repository is a **pure asset store** β€” no code, only large binary files served via Git LFS.
22
+
23
+ **Consumed by:**
24
+ - [ComfyUI-Auto_installer](https://github.com/UmeAiRT/ComfyUI-Auto_installer) β€” automated Windows setup, downloads models from this repo
25
+ - [ComfyUI-UmeAiRT-Toolkit](https://github.com/UmeAiRT/ComfyUI-UmeAiRT-Toolkit) β€” custom ComfyUI nodes with automatic model downloading
26
+
27
+ ## πŸ“¦ What's Included
28
+
29
+ ### Diffusion Models (`models/diffusion_models/`)
30
+
31
+ Each model family provides multiple precision levels: full precision (bf16/fp16), reduced (fp8), and GGUF quantizations (Q8β†’Q3) for different VRAM budgets.
32
+
33
+ | Family | Models | Size | Precisions |
34
+ |---|---|---|---|
35
+ | **FLUX** (12B) | Dev, Fill, Kontext, Canny, Depth, Schnell | 384 GB | fp16, fp8, SVDQ-int4, Q8β†’Q3 |
36
+ | **WAN 2.1** (14B) | T2V, I2V-480p/720p, VACE, Fun-InP/Control | 1575 GB | bf16, fp16, fp8, Q8β†’Q3 |
37
+ | **WAN 2.2** (A14B) | T2V, I2V, InP, Control, Camera (High/Low) | *(incl. above)* | fp16, fp8_scaled, Q8β†’Q3 |
38
+ | **QWEN** (~20B) | Image, Image-Edit, Image-Distill | 412 GB | bf16, fp8, SVDQ, Q8β†’Q3 |
39
+ | **HiDream** (17B) | I1-Dev | 76 GB | fp8, Q8β†’Q3 |
40
+ | **LTX-2** (19B+22B) | 19B-Dev, 2.3-22B-Dev | 140 GB | Q8β†’Q3 |
41
+ | **LTXV** (13B) | 0.9.8-Dev | 46 GB | Q8β†’Q3 |
42
+ | **Z-Image** (12B) | Standard, Turbo | 85 GB | bf16, fp8, Q8β†’Q3 |
43
+
44
+ ### Text Encoders (`models/text_encoders/`)
45
+
46
+ | Encoder | Precisions |
47
+ |---|---|
48
+ | **T5 XXL** | fp16, fp8, fp8_scaled, Q8β†’Q3 |
49
+ | **umt5 XXL** | bf16, fp8_scaled, Q8β†’Q3 |
50
+ | **GEMMA-3 12B** | bf16, fp8, IQ4_XS, Q8β†’Q3 |
51
+ | **Qwen2.5-VL-7B** | bf16, fp8_scaled, UD-Q4, Q8β†’Q3 |
52
+ | **Qwen3-4B** | bf16, fp8_mixed, UD-Q8β†’Q3 |
53
+ | **LLAMA 3.1 8B** | fp8_scaled |
54
+
55
+ ### Other Models
56
+
57
+ | Folder | Contents |
58
+ |---|---|
59
+ | `models/clip/` | CLIP-L, CLIP-G, LongCLIP, ViT-L-14 |
60
+ | `models/clip_vision/` | clip_vision_h, SigCLIP |
61
+ | `models/checkpoints/` | Full merged checkpoints |
62
+ | `models/loras/` | LoRA adapters (FLUX, WAN, QWEN, LTX-2) |
63
+ | `models/vae/` | Shared VAE models |
64
+ | `models/controlnet/` | ControlNet models |
65
+ | `models/upscale_models/` | RealESRGAN and others |
66
+ | `models/style_models/` | Style/Redux models |
67
+ | `models/sams/` | SAM segmentation |
68
+ | `models/ultralytics/` | YOLO face/hand detection |
69
+ | `models/LLM/` | Florence-2 PromptGen |
70
+
71
+ ### Binaries & Packages
72
+
73
+ | Folder | Contents |
74
+ |---|---|
75
+ | `bin/` | Git, Python, CUDA installers |
76
+ | `whl/` | Pre-compiled Python wheels |
77
+ | `packages/` | Extension zips, build tools, configs |
78
+
79
+ ## πŸ“ Naming Conventions
80
+
81
+ **GGUF** β€” CamelCase per [GGUF spec](https://github.com/ggml-org/ggml/blob/master/docs/gguf.md):
82
+ ```
83
+ Flux1-Dev-Q4_K_S.gguf
84
+ Wan2.2-T2V-HighNoise-14B-Q8_0.gguf
85
+ ```
86
+
87
+ **Safetensors** β€” lowercase with hyphens:
88
+ ```
89
+ wan2.1-t2v-14b-fp16.safetensors
90
+ qwen-image-edit-fp8_e4m3fn.safetensors
91
+ ```
92
+
93
+ ## πŸ”— Related Projects
94
+
95
+ | Project | Description |
96
+ |---|---|
97
+ | [ComfyUI-Auto_installer](https://github.com/UmeAiRT/ComfyUI-Auto_installer) | PowerShell installer that downloads from this repo |
98
+ | [UmeAiRT-ComfyUI-Toolkit](https://github.com/UmeAiRT/UmeAiRT-ComfyUI-Toolkit) | Custom ComfyUI nodes |
99
+ | [UmeAiRT-NAS-Utils](https://github.com/UmeAiRT/UmeAiRT-NAS-Utils) | NAS management and sync scripts |
100
+
101
+ ## πŸ“œ License
102
+
103
+ MIT β€” see [LICENSE](LICENSE) for details.
104
+
105
+ ![UmeAiRT](images/UmeAiRT.png)