background_remover / README.md
Repcak00's picture
Update README.md
5a2b642 verified
---
title: Background Remover
emoji: πŸ’»
colorFrom: indigo
colorTo: blue
sdk: streamlit
sdk_version: 1.54.0
python_version: '3.10'
app_file: src/app.py
pinned: false
license: agpl-3.0
---
# 🎨 Background Remover
A powerful, user-friendly desktop application for removing image backgrounds and replacing them with custom colors. Built with Streamlit and powered by state-of-the-art AI models.
---
## ✨ Features
- πŸ–ΌοΈ **Batch Processing** - Upload and process multiple images at once
- πŸ€– **Multiple AI Models** - Choose from 7 different background removal models
- 🎨 **Custom Background Colors** - Replace backgrounds with any color you choose
- πŸ” **Transparency Options** - Keep transparent backgrounds or fill with solid colors
- πŸ“¦ **Bulk Download** - Download all processed images as a convenient ZIP file
- ⚑ **Real-time Preview** - See original and processed images side by side
- πŸ–₯️ **Desktop-First Design** - Clean, intuitive interface built for productivity
---
## πŸš€ Quick Start
### Prerequisites
- Python 3.11 or higher
- pip package manager
### Installation
1. **Clone the repository**
```bash
git clone <repository-url>
cd background-remover
```
2. **Install dependencies**
Using the project file:
```bash
pip install -e .
```
3. **Run the application**
```bash
streamlit run src/app.py
```
The app will open in your default web browser at `http://localhost:8501`
---
## πŸ“– Usage
1. **Select Your Preferences**
- Choose a background color using the color picker
- Select an AI model (recommended: `birefnet-dis` for objects with holes)
- Choose transparency mode: keep transparent or fill with color
2. **Upload Images**
- Click "Browse files" or drag and drop
- Supports PNG, JPG, and JPEG formats
- Upload single or multiple images
3. **Process Images**
- Click "πŸš€ Process All Images"
- Watch the progress bar as images are processed
- Review results in the side-by-side comparison view
4. **Download Results**
- Click "πŸ“₯ Download All" to get a ZIP file
- All images are saved as PNG to preserve quality
---
## πŸ€– Available AI Models
| Model | Best For | Performance |
|-------|----------|-------------|
| **birefnet-dis** | Objects with holes/details | ⭐⭐⭐⭐⭐ |
| **birefnet-general-lite** | Fast general-purpose | ⭐⭐⭐⭐ |
| **birefnet-general** | High-quality general use | ⭐⭐⭐⭐⭐ |
| **isnet-general-use** | General purpose | ⭐⭐⭐⭐ |
| **u2net** | Legacy general use | ⭐⭐⭐ |
| **birefnet-massive** | Maximum accuracy | ⭐⭐⭐⭐⭐ |
| **bria-rmbg** | Commercial-grade | ⭐⭐⭐⭐ |
---
## πŸ› οΈ Tech Stack
- **[Streamlit](https://streamlit.io)** - Web application framework
- **[rembg](https://github.com/danielgatis/rembg)** - AI-powered background removal
- **[Pillow](https://python-pillow.org/)** - Image processing
- **[NumPy](https://numpy.org/)** - Numerical operations
- **[ONNX Runtime](https://onnxruntime.ai/)** - AI model inference
---
## πŸ“‹ Requirements
```
streamlit>=1.30
rembg>=2.0.50
pillow>=10.0
numpy>=1.24
onnxruntime>=1.17
```
---
## 🀝 Contributing
Contributions are welcome! This project is licensed under AGPL-3.0, which means:
- βœ… You can use, modify, and distribute this software
- βœ… You must share your modifications under the same license
- βœ… You must make source code available for network use (SaaS)
Please feel free to:
- Report bugs
- Suggest features
- Submit pull requests
---
## πŸ“„ License
Copyright (c) 2026-present [Kacper Kozaczko](https://github.com/Repcak00)
This project is licensed under the **GNU Affero General Public License v3.0 or later (AGPL-3.0-or-later)**.
See [LICENSE](./LICENSES) for full terms.
### Third-Party Components
This software includes the following third-party components:
- **[rembg](https://github.com/danielgatis/rembg)** - Copyright (c) 2020-present Daniel Gatis
License: MIT - See [LICENSES/MIT-rembg.txt](./LICENSES/MIT-rembg.txt)
---
## ⚠️ Disclaimer
This software is provided "as is" without warranty of any kind. The AI models used for background removal may not be perfect for all images. Results may vary depending on image quality and complexity.
---
## πŸ™ Acknowledgments
- Thanks to [Daniel Gatis](https://github.com/danielgatis) for the excellent [rembg](https://github.com/danielgatis/rembg) library
- Built with ❀️ using [Streamlit](https://streamlit.io)
---
**Made with 🎨 and Python**