Files
nullquant-ComfyUI-BrushNet/README.md
T
2024-04-30 12:08:56 +03:00

97 lines
3.3 KiB
Markdown

## ComfyUI-BrushNet
Custom nodes for ComfyUI allow to inpaint using Brushnet: ["BrushNet: A Plug-and-Play Image Inpainting Model with Decomposed Dual-Branch Diffusion"](https://arxiv.org/abs/2403.06976).
My contribution is limited to the ComfyUI adaptation, and all credit goes to the authors of the paper.
## Updates
Apr 28, 2014. Another rework, sorry for inconvenience. But now BrushNet is native to ComfyUI. Famous cubiq's [IPAdapter Plus](https://github.com/cubiq/ComfyUI_IPAdapter_plus) is now working with BrushNet! I hope... :) Please, report any bugs you found.
Apr 18, 2024. Complete rework, no more custom `diffusers` library. It is possible to use LoRA models.
Apr 11, 2024. Initial commit.
## Installation
Clone the repo into the custom_nodes directory and install the requirements:
```
git clone https://github.com/nullquant/ComfyUI-BrushNet.git
pip install -r requirements.txt
```
Checkpoints of BrushNet can be downloaded from [here](https://drive.google.com/drive/folders/1fqmS1CEOvXCxNWFrsSYd_jHYXxrydh1n?usp=drive_link).
The checkpoint in `segmentation_mask_brushnet_ckpt` provides checkpoints trained on BrushData, which has segmentation prior (mask are with the same shape of objects). The `random_mask_brushnet_ckpt` provides a more general ckpt for random mask shape.
Both `segmentation_mask_brushnet_ckpt` and `random_mask_brushnet_ckpt` or only one of them should be placed inside `models/inpaint/brushnet` folder.
Base model should be SD1.5 type (realisticVisionV60B1_v51VAE, for example).
## Usage
Below is an example for the intended workflow. The [json file](example/BrushNet_basic.json) for the example can be found inside the 'example' directory.
![example workflow](example/BrushNet_basic.png?raw=true)
The latent image can be from BrushNet node or not, but it should be the same size as original image (divided by 8 in latent space).
<details>
<summary>IPAdapter plus</summary>
[json file](example/BrushNet_with_IPA.json)
![example workflow](example/BrushNet_with_IPA.png?raw=true)
</details>
<details>
<summary>LoRA</summary>
[json file](example/BrushNet_with_LoRA.json)
![example workflow](example/BrushNet_with_LoRA.png?raw=true)
</details>
<details>
<summary>Blending inpaint</summary>
Sometimes inference and VAE broke image, so you need to blend inpaint image with the original: [json file](example/BrushNet_inpaint.json)
![example workflow](example/BrushNet_inpaint.png?raw=true)
You can see blurred and broken text after inpainting in the first image and how I suppose to repair it.
</details>
<details>
<summary>ControlNet</summary>
[json file](example/BrushNet_with_CN.json)
![example workflow](example/BrushNet_with_CN.png?raw=true)
</details>
## Notes
Unfortunately, due to the nature of ComfyUI code some nodes are not compatible with these, since we are trying to patch the same ComfyUI's functions.
List of known uncompartible nodes.
- [WASasquatch's FreeU_Advanced](https://github.com/WASasquatch/FreeU_Advanced/tree/main)
- [blepping's jank HiDiffusion](https://github.com/blepping/comfyui_jankhidiffusion)
I will think how to avoid it.
## Credits
The code is based on
- [BrushNet](https://github.com/TencentARC/BrushNet)
- [PowerPaint](https://github.com/zhuang2002/PowerPaint)
- [diffusers](https://github.com/huggingface/diffusers)