Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Sanster committed Jan 24, 2024
1 parent cf5e25d commit 934b0fc
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 4 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,31 @@
</a>
</p>

<p align="center">
<img alt="python version" src="https://github.com/Sanster/models/assets/3998421/561b8395-76a2-4c70-ab24-9f6986924c6a" height=600 />
</p>

## Quick Start

### Start webui

IOPaint provides a convenient webui for using the latest AI models to edit your images.
The installation process for IOPaint is also simple, requiring just two commands:
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.

### Batch processing

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

```bash
Expand All @@ -45,7 +56,7 @@ You can see more information about the available models and plugins supported by

- Completely free and open-source, fully self-hosted, support CPU & GPU & Apple Silicon
- Supports various AI models:
- Erase models: These models are usually used to remove people or objects from images.
- Erase models: These models can be used to remove unwanted object, defect, watermarks, people from image.
- Stable Diffusion models: You can use any Stable Diffusion Inpainting(or normal) models from [Huggingface](https://huggingface.co/models?other=stable-diffusion) in IOPaint.
Some popular used models include:
- [runwayml/stable-diffusion-inpainting](https://huggingface.co/runwayml/stable-diffusion-inpainting)
Expand All @@ -59,7 +70,7 @@ Some popular used models include:
- [timbrooks/instruct-pix2pix](https://huggingface.co/timbrooks/instruct-pix2pix)
- [Fantasy-Studio/Paint-by-Example](https://huggingface.co/Fantasy-Studio/Paint-by-Example)
- [kandinsky-community/kandinsky-2-2-decoder-inpaint](https://huggingface.co/kandinsky-community/kandinsky-2-2-decoder-inpaint)
- [Plugins](https://iopaint.com/plugins):
- Plugins
- [Segment Anything](https://iopaint.com/plugins/interactive_seg): Accurate and fast interactive object segmentation
- [RemoveBG](https://iopaint.com/plugins/rembg): Remove image background or generate masks for foreground objects
- [Anime Segmentation](https://iopaint.com/plugins/anime_seg): Similar to RemoveBG, the model is specifically trained for anime images.
Expand Down
1 change: 0 additions & 1 deletion assets/GitHub_Copilot_logo.svg

This file was deleted.

Binary file removed assets/dark.jpg
Binary file not shown.
Binary file removed assets/logo.png
Binary file not shown.

0 comments on commit 934b0fc

Please sign in to comment.