danielgatis/rembg danielgatis/rembg

  • Stars
    star
    16,578
  • Rank 1,690 (Top 0.04 %)
  • Language
    Python
  • License
    MIT License
  • Created over 4 years ago
  • Updated about 2 months ago
Twitter logo Share LinkedIn logo Share Facebook logo Share
danielgatis/rembg
github

danielgatis

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Rembg is a tool to remove images background

Rembg

Downloads License Hugging Face Spaces Streamlit App

Rembg is a tool to remove images background.

If this project has helped you, please consider making a donation.

Sponsor

Unsplash PhotoRoom Remove Background API
https://photoroom.com/api

Fast and accurate background remover API

Requirements

python: >3.7, <3.12

Installation

CPU support:

pip install rembg # for library
pip install rembg[cli] # for library + cli

GPU support:

First of all, you need to check if your system supports the onnxruntime-gpu.

Go to https://onnxruntime.ai and check the installation matrix.

If yes, just run:

pip install rembg[gpu] # for library
pip install rembg[gpu,cli] # for library + cli

Usage as a cli

After the installation step you can use rembg just typing rembg in your terminal window.

The rembg command has 4 subcommands, one for each input type:

  • i for files
  • p for folders
  • s for http server
  • b for RGB24 pixel binary stream

You can get help about the main command using:

rembg --help

As well, about all the subcommands using:

rembg <COMMAND> --help

rembg i

Used when input and output are files.

Remove the background from a remote image

curl -s http://input.png | rembg i > output.png

Remove the background from a local file

rembg i path/to/input.png path/to/output.png

Remove the background specifying a model

rembg i -m u2netp path/to/input.png path/to/output.png

Remove the background returning only the mask

rembg i -om path/to/input.png path/to/output.png

Remove the background applying an alpha matting

rembg i -a path/to/input.png path/to/output.png

Passing extras parameters

rembg i -m sam -x '{"input_labels": [1], "input_points": [[100,100]]}' path/to/input.png path/to/output.png

rembg i -m u2net_custom -x '{"model_path": "~/.u2net/u2net.onnx"}' path/to/input.png path/to/output.png

rembg p

Used when input and output are folders.

Remove the background from all images in a folder

rembg p path/to/input path/to/output

Same as before, but watching for new/changed files to process

rembg p -w path/to/input path/to/output

rembg s

Used to start http server.

To see the complete endpoints documentation, go to: http://localhost:5000/api.

Remove the background from an image url

curl -s "http://localhost:5000/api/remove?url=http://input.png" -o output.png

Remove the background from an uploaded image

curl -s -F file=@/path/to/input.jpg "http://localhost:5000/api/remove"  -o output.png

rembg b

Process a sequence of RGB24 images from stdin. This is intended to be used with another program, such as FFMPEG, that outputs RGB24 pixel data to stdout, which is piped into the stdin of this program, although nothing prevents you from manually typing in images at stdin.

rembg b image_width image_height -o output_specifier

Arguments:

  • image_width : width of input image(s)
  • image_height : height of input image(s)
  • output_specifier: printf-style specifier for output filenames, for example if output-%03u.png, then output files will be named output-000.png, output-001.png, output-002.png, etc. Output files will be saved in PNG format regardless of the extension specified. You can omit it to write results to stdout.

Example usage with FFMPEG:

ffmpeg -i input.mp4 -ss 10 -an -f rawvideo -pix_fmt rgb24 pipe:1 | rembg b 1280 720 -o folder/output-%03u.png

The width and height values must match the dimension of output images from FFMPEG. Note for FFMPEG, the "-an -f rawvideo -pix_fmt rgb24 pipe:1" part is required for the whole thing to work.

Usage as a library

Input and output as bytes

from rembg import remove

input_path = 'input.png'
output_path = 'output.png'

with open(input_path, 'rb') as i:
    with open(output_path, 'wb') as o:
        input = i.read()
        output = remove(input)
        o.write(output)

Input and output as a PIL image

from rembg import remove
from PIL import Image

input_path = 'input.png'
output_path = 'output.png'

input = Image.open(input_path)
output = remove(input)
output.save(output_path)

Input and output as a numpy array

from rembg import remove
import cv2

input_path = 'input.png'
output_path = 'output.png'

input = cv2.imread(input_path)
output = remove(input)
cv2.imwrite(output_path, output)

How to iterate over files in a performatic way

from pathlib import Path
from rembg import remove, new_session

session = new_session()

for file in Path('path/to/folder').glob('*.png'):
    input_path = str(file)
    output_path = str(file.parent / (file.stem + ".out.png"))

    with open(input_path, 'rb') as i:
        with open(output_path, 'wb') as o:
            input = i.read()
            output = remove(input, session=session)
            o.write(output)

To see a full list of examples on how to use rembg, go to the examples page.

Usage as a docker

Just replace the rembg command for docker run danielgatis/rembg.

Try this:

docker run danielgatis/rembg i path/to/input.png path/to/output.png

Models

All models are downloaded and saved in the user home folder in the .u2net directory.

The available models are:

  • u2net (download, source): A pre-trained model for general use cases.
  • u2netp (download, source): A lightweight version of u2net model.
  • u2net_human_seg (download, source): A pre-trained model for human segmentation.
  • u2net_cloth_seg (download, source): A pre-trained model for Cloths Parsing from human portrait. Here clothes are parsed into 3 category: Upper body, Lower body and Full body.
  • silueta (download, source): Same as u2net but the size is reduced to 43Mb.
  • isnet-general-use (download, source): A new pre-trained model for general use cases.
  • isnet-anime (download, source): A high-accuracy segmentation for anime character.
  • sam (download encoder, download decoder, source): A pre-trained model for any use cases.

How to train your own model

If You need more fine tuned models try this: #193 (comment)

Some video tutorials

References

Buy me a coffee

Liked some of my work? Buy me a coffee (or more likely a beer)

Buy Me A Coffee

License

Copyright (c) 2020-present Daniel Gatis

Licensed under MIT License

More Repositories

1

puppeteer-recaptcha-solver

Recaptcha solver for puppeteer.
JavaScript
565
star
2

imgcat

Display images and gifs in your terminal.
Go
216
star
3

docscan

Docscan is a document scanner. Take a photo of your documents and frame it.
Python
91
star
4

facematch

Facematch is a tool to verifies if two photos contain the same person.
Python
76
star
5

darknetpy

darknetpy is a simple binding for darknet's yolo detector.
Jupyter Notebook
66
star
6

go-vte

A library to parse terminal escape sequences (almost) exactly how the real hardware does.
Go
25
star
7

go-orderbook

The pkg go-orderbook implements a limit order book for high-frequency trading (HFT), as described by WK Selph.
Go
21
star
8

django-smart-save

Adds the method save_if_valid to Model, which calls both full_clean and save.
Python
15
star
9

chip8

A CHIP-8 emulator for Rust in ~350 LOC.
Rust
10
star
10

go-rafting

A framework to build fault tolerant apps.
Go
10
star
11

search_in_files

This is a tool for search text in files.
Jupyter Notebook
5
star
12

go-discovery

A collection of service discovery implementations.
Go
4
star
13

go-findfont

Find system fonts through the fontconfig library (a.k.a `fc-match`).
Go
4
star
14

go-ctrlc

Gracefully quit when you press ctrl-c.
Go
3
star
15

go-freetype

Go bindings for the FreeType library. Only the high-level API is bound.
Go
2
star
16

go-ansicode

go-ansicode is a package that interprets ANSI codes and allows you to register a handler to deal with the operations
Go
2
star
17

go-ruby-prism

The Ruby Prism parser bindings to GO (without cgo)
Go
2
star
18

go-ptrloop

A helper to iterate over unsafe pointers.
Go
2
star
19

scoop-imgcat

scoop bucket imgcat.
1
star
20

homebrew-imgcat

brew tap imgcat.
Ruby
1
star
21

go-simplerouter

A simple request router for Go in ~100 lines of code.
Go
1
star
22

cobra.rs

The smallest snake in rust ~ 130LOC.
Rust
1
star
23

go-keyval

A Variadic helper to mimic named arguments.
Go
1
star
24

go-logrus-adapters

A collection of adapters for logrus pkg.
Go
1
star
25

myfaces-captcha-generator

Java
1
star
26

gatix

Gatix
C
1
star
27

go-utf8

A state machine based UTF8 parser
Go
1
star