From aebf205ffb0eca4dad5cd4f618ccae06c0686608 Mon Sep 17 00:00:00 2001 From: gorillaframeai <149839341+gorillaframeai@users.noreply.github.com> Date: Thu, 14 Nov 2024 20:53:57 +0300 Subject: [PATCH] Update readme.md --- readme.md | 54 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 28 insertions(+), 26 deletions(-) diff --git a/readme.md b/readme.md index be921f7..5ce83ae 100644 --- a/readme.md +++ b/readme.md @@ -1,17 +1,20 @@ -RMBG-2.0 Background Removal Node for ComfyUI +# RMBG-2.0 Background Removal Node for ComfyUI + This custom node for ComfyUI provides advanced background removal capabilities using the briaai/RMBG-2.0 model. It is designed to seamlessly integrate into the ComfyUI environment, offering users a powerful tool for image processing tasks. -Node name: GFrbmg2 -Author: GorillaFrame +**Node name:** GFrbmg2 +**Author:** GorillaFrame -Features -High-quality background removal -Support for batch processing -Options for inverted masks -Three output formats: RGBA, mask, and black background -Installation -Required Directory Structure +## Features +- High-quality background removal +- Support for batch processing +- Options for inverted masks +- Three output formats: RGBA, mask, and black background +## Installation + +### Required Directory Structure +``` ComfyUI/ ├── models/ │ └── RMBG-2.0/ # Model files @@ -22,12 +25,12 @@ ComfyUI/ └── GF_nodes/ ├── gfrbmg2.py # Node implementation └── __init__.py # Node initialization +``` -Installation Steps +### Installation Steps 1. **Create the GF_nodes Folder and Download the Model:** Navigate to your ComfyUI directory and set up the necessary folders: - ```bash cd ComfyUI/custom_nodes mkdir GF_nodes @@ -36,7 +39,6 @@ Installation Steps 2. **Download the RMBG-2.0 Model:** Navigate to the models directory and clone the model repository: - ```bash cd ComfyUI/models mkdir RMBG-2.0 @@ -45,22 +47,22 @@ Installation Steps ``` If Git LFS is not installed, run: - ```bash git lfs install git lfs pull ``` -Requirements -Git LFS (for model download) -Sufficient disk space (≈2GB) -CUDA-compatible GPU (recommended) -Usage -Restart ComfyUI after installation -Find the node in "🐵 GorillaFrame/Image" category -Connect an image input -Get outputs: image_rgba (transparent background), mask, and image_black (black background) -Credits -Original model: briaai/RMBG-2.0 +## Requirements +- Git LFS (for model download) +- Sufficient disk space (≈2GB) +- CUDA-compatible GPU (recommended) -Node implementation: @GorillaFrame 🐵 \ No newline at end of file +## Usage +1. Restart ComfyUI after installation +2. Find the node in "🐵 GorillaFrame/Image" category +3. Connect an image input +4. Get outputs: image_rgba (transparent background), mask, and image_black (black background) + +## Credits +- Original model: [briaai/RMBG-2.0](https://huggingface.co/briaai/RMBG-2.0) +- Node implementation: @GorillaFrame 🐵 \ No newline at end of file