rmbg 0.1.0

Rust interface for BRIA Background Removal v1.4 Model Library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

# RMBG Crate

This crate provides an easy-to-use interface for removing backgrounds from images, leveraging a machine learning model.
It's designed to integrate seamlessly into Rust projects requiring background removal capabilities.

Rust docs: https://docs.rs/rmbg/latest/rmbg/struct.Rmbg.html
Crates.io: https://crates.io/crates/rmbg

## Features

- Load and apply a machine learning model to remove backgrounds from images.
- Maintains original image dimensions, replacing the background with transparency.
- Preprocess and postprocess images to conform to model requirements.

## Getting Started

### Prerequisites

Before using the `rmbg` crate, you need to download the required `model.onnx` file. This model is a crucial component as
it powers the background removal process. You can download it from the following URL:

[https://huggingface.co/briaai/RMBG-1.4/blob/main/onnx/model.onnx](https://huggingface.co/briaai/RMBG-1.4/blob/main/onnx/model.onnx)

Place the downloaded `model.onnx` file in a known directory within your project.

### Installation

Add `rmbg` to your `Cargo.toml` file:

```toml
[dependencies]
rmbg = { version = "0.1.0", default-features = false }
```

#### Note for Library Developers

If you are developing a library that includes `rmbg`, it is heavily recommended to disable default features to avoid
unnecessary bloat. Cargo features are additive, and enabling default features in a library can prevent downstream users
from opting out of those features, leading to increased compile times and binary sizes.

Instead, enable the necessary features in your development dependencies as follows:

```toml
[dev-dependencies]
rmbg = { version = "0.1.0", features = ["download-binaries"] }
```

Instruct downstream users to include `ort` in their dependencies if needed, with the `download-binaries` feature
enabled:

```toml
[dependencies]
ort = { version = "...", features = ["download-binaries"] }
```

### Usage

To use the `rmbg` crate in your project, first, initialize an instance of the `Rmbg` struct with the path to
the `model.onnx` file. Then, call the `remove_background` method with an image to process.

Here's a simple example:

```rust
use rmbg::Rmbg;
use image::DynamicImage;

fn main() -> anyhow::Result<()> {
    // Load the model
    let rmbg = Rmbg::new("path/to/model.onnx")?;

    // Load an image
    let original_img = image::open("path/to/image.png")?;

    // Remove the background
    let img_without_bg = rmbg.remove_background(&original_img)?;

    // Save or further process `img_without_bg` as needed
    Ok(())
}
```

## License

This project is licensed under the MIT License - see the LICENSE file for details.

### Model License

The model.onnx file used by this crate is subject to its own license terms. The model is released under the
bria-rmbg-1.4 license, which is a Creative Commons license for non-commercial use only. Commercial use of the model
requires a commercial agreement with BRIA.

Please ensure you comply with the model's license terms when using it in your projects.