README

IOPaint
A free and open-source inpainting & outpainting tool powered by SOTA AI model.


  
    
  
  
    
  
  
    
  
  
    
  
  
    
  


|Erase(LaMa)|Replace Object(PowerPaint)|
|-----|----|
|  | |

|Draw Text(AnyText)|Out-painting(PowerPaint)|
|---------|-----------|
|||


 Features

- Completely free and open-source, fully self-hosted, support CPU & GPU & Apple Silicon
- Windows 1-Click Installer
- OptiClean: macOS & iOS App for object erase
- Supports various AI models to perform erase, inpainting or outpainting task.
  - Erase models: These models can be used to remove unwanted object, defect, watermarks, people from image.
  - Diffusion models: These models can be used to replace objects or perform outpainting. Some popular used models include:
    - runwayml/stable-diffusion-inpainting
    - diffusers/stable-diffusion-xl-1.0-inpainting-0.1
    - andregn/Realistic_Vision_V3.0-inpainting
    - Lykon/dreamshaper-8-inpainting
    - Sanster/anything-4.0-inpainting
    - BrushNet
    - PowerPaintV2
    - Sanster/AnyText
    - Fantasy-Studio/Paint-by-Example

- Plugins:
  - Segment Anything: Accurate and fast Interactive Object Segmentation
  - RemoveBG: Remove image background or generate masks for foreground objects
  - Anime Segmentation: Similar to RemoveBG, the model is specifically trained for anime images.
  - RealESRGAN: Super Resolution
  - GFPGAN: Face Restoration
  - RestoreFormer: Face Restoration
- FileManager: Browse your pictures conveniently and save them directly to the output directory.


 Quick Start

 Start webui

IOPaint provides a convenient webui for using the latest AI models to edit your images.
You can install and start IOPaint easily by running following command:

bash
 In order to use GPU, install cuda version of pytorch first.
 pip3 install torch==2.1.2 torchvision==0.16.2 --index-url https://download.pytorch.org/whl/cu118
 AMD GPU users, please utilize the following command, only works on linux, as pytorch is not yet supported on Windows with ROCm.
 pip3 install torch==2.1.2 torchvision==0.16.2 --index-url https://download.pytorch.org/whl/rocm5.6

pip3 install iopaint
iopaint start --model=lama --device=cpu --port=8080


That's it, you can start using IOPaint by visiting http://localhost:8080 in your web browser.

All models will be downloaded automatically at startup. If you want to change the download directory, you can add --model-dir. More documentation can be found here

You can see other supported models at here and how to use local sd ckpt/safetensors file at here.

 Plugins

You can specify which plugins to use when starting the service, and you can view the commands to enable plugins by using iopaint start --help. 

More demonstrations of the Plugin can be seen here

bash
iopaint start --enable-interactive-seg --interactive-seg-device=cuda


 Batch processing

You can also use IOPaint in the command line to batch process images:

bash
iopaint run --model=lama --device=cpu \
--image=/path/to/image_fol