76 lines
3.3 KiB
Markdown
76 lines
3.3 KiB
Markdown
<p align="center">
|
|
<img alt="logo" height=256 src="./assets/logo.png" />
|
|
</p>
|
|
<h1 align="center">Lama Cleaner</h1>
|
|
<p align="center">A free and open-source inpainting tool powered by SOTA AI model.</p>
|
|
|
|
<p align="center">
|
|
<a href="https://github.com/Sanster/lama-cleaner">
|
|
<img alt="total download" src="https://pepy.tech/badge/lama-cleaner" />
|
|
</a>
|
|
<a href="https://pypi.org/project/lama-cleaner/">
|
|
<img alt="version" src="https://img.shields.io/pypi/v/lama-cleaner" />
|
|
</a>
|
|
<a href="https://colab.research.google.com/drive/1e3ZkAJxvkK3uzaTGu91N9TvI_Mahs0Wb?usp=sharing">
|
|
<img alt="Open in Colab" src="https://colab.research.google.com/assets/colab-badge.svg" />
|
|
</a>
|
|
|
|
<a href="https://huggingface.co/spaces/Sanster/Lama-Cleaner-lama">
|
|
<img alt="Hugging Face Spaces" src="https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Spaces-blue" />
|
|
</a>
|
|
|
|
<a href="">
|
|
<img alt="python version" src="https://img.shields.io/pypi/pyversions/lama-cleaner" />
|
|
</a>
|
|
<a href="https://hub.docker.com/r/cwq1913/lama-cleaner">
|
|
<img alt="version" src="https://img.shields.io/docker/pulls/cwq1913/lama-cleaner" />
|
|
</a>
|
|
</p>
|
|
|
|
https://user-images.githubusercontent.com/3998421/196976498-ba1ad3ab-fa18-4c55-965f-5c6683141375.mp4
|
|
|
|
## Features
|
|
|
|
- Completely free and open-source, fully self-hosted, support CPU & GPU & M1/2
|
|
- [Windows 1-Click Installer](https://lama-cleaner-docs.vercel.app/install/windows_1click_installer)
|
|
- [Native macOS app](https://opticlean.io/)
|
|
- Multiple SOTA AI [models](https://lama-cleaner-docs.vercel.app/models)
|
|
- Erase model: LaMa/LDM/ZITS/MAT/FcF/Manga
|
|
- Erase and Replace model: Stable Diffusion/Paint by Example
|
|
- [Plugins](https://lama-cleaner-docs.vercel.app/plugins) for post-processing:
|
|
- [RemoveBG](https://github.com/danielgatis/rembg): Remove images background
|
|
- [RealESRGAN](https://github.com/xinntao/Real-ESRGAN): Super Resolution
|
|
- [GFPGAN](https://github.com/TencentARC/GFPGAN): Face Restoration
|
|
- [RestoreFormer](https://github.com/wzhouxiff/RestoreFormer): Face Restoration
|
|
- [Segment Anything](https://lama-cleaner-docs.vercel.app/plugins#interactive-segmentation): Accurate and fast interactive object segmentation
|
|
- [FileManager](https://lama-cleaner-docs.vercel.app/features/file_manager): Browse your pictures conveniently and save them directly to the output directory.
|
|
- More features at [lama-cleaner-docs](https://lama-cleaner-docs.vercel.app/)
|
|
|
|
## Quick Start
|
|
|
|
Lama Cleaner make it easy to use SOTA AI model in just two commands:
|
|
|
|
```bash
|
|
# In order to use the GPU, install cuda version of pytorch first.
|
|
# pip install torch==1.13.1+cu117 torchvision==0.14.1 --extra-index-url https://download.pytorch.org/whl/cu117
|
|
pip install lama-cleaner
|
|
lama-cleaner --model=lama --device=cpu --port=8080
|
|
```
|
|
|
|
That's it, Lama Cleaner is now running at http://localhost:8080
|
|
|
|
See all command line arguments at [lama-cleaner-docs](https://lama-cleaner-docs.vercel.app/install/pip)
|
|
|
|
## Development
|
|
|
|
Only needed if you plan to modify the frontend and recompile yourself.
|
|
|
|
### Frontend
|
|
|
|
Frontend code are modified from [cleanup.pictures](https://github.com/initml/cleanup.pictures), You can experience their
|
|
great online services [here](https://cleanup.pictures/).
|
|
|
|
- Install dependencies:`cd lama_cleaner/app/ && pnpm install`
|
|
- Start development server: `pnpm start`
|
|
- Build: `pnpm build`
|