Update README.md
Browse files
README.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1 |
---
|
2 |
title: Remove Background WebGPU
|
3 |
-
emoji:
|
4 |
colorFrom: purple
|
5 |
colorTo: indigo
|
6 |
sdk: static
|
@@ -8,6 +8,48 @@ pinned: false
|
|
8 |
license: apache-2.0
|
9 |
models:
|
10 |
- Xenova/modnet
|
|
|
|
|
11 |
---
|
12 |
|
13 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
---
|
2 |
title: Remove Background WebGPU
|
3 |
+
emoji: 🖼️
|
4 |
colorFrom: purple
|
5 |
colorTo: indigo
|
6 |
sdk: static
|
|
|
8 |
license: apache-2.0
|
9 |
models:
|
10 |
- Xenova/modnet
|
11 |
+
short_description: In-browser image background removal
|
12 |
+
thumbnail: https://huggingface.co/spaces/webml-community/remove-background-webgpu/resolve/main/banner.jpg
|
13 |
---
|
14 |
|
15 |
+
# Remove Background WebGPU
|
16 |
+
|
17 |
+
A simple React + Vite application for running [MODNet](https://huggingface.co/Xenova/modnet), a tiny portrait background removal model, locally in the browser using Transformers.js and WebGPU-acceleration.
|
18 |
+
|
19 |
+
## Getting Started
|
20 |
+
|
21 |
+
Follow the steps below to set up and run the application.
|
22 |
+
|
23 |
+
### 1. Clone the Repository
|
24 |
+
|
25 |
+
Clone the examples repository from GitHub:
|
26 |
+
|
27 |
+
```sh
|
28 |
+
git clone https://github.com/huggingface/transformers.js-examples.git
|
29 |
+
```
|
30 |
+
|
31 |
+
### 2. Navigate to the Project Directory
|
32 |
+
|
33 |
+
Change your working directory to the `remove-background-webgpu` folder:
|
34 |
+
|
35 |
+
```sh
|
36 |
+
cd transformers.js-examples/remove-background-webgpu
|
37 |
+
```
|
38 |
+
|
39 |
+
### 3. Install Dependencies
|
40 |
+
|
41 |
+
Install the necessary dependencies using npm:
|
42 |
+
|
43 |
+
```sh
|
44 |
+
npm i
|
45 |
+
```
|
46 |
+
|
47 |
+
### 4. Run the Development Server
|
48 |
+
|
49 |
+
Start the development server:
|
50 |
+
|
51 |
+
```sh
|
52 |
+
npm run dev
|
53 |
+
```
|
54 |
+
|
55 |
+
The application should now be running locally. Open your browser and go to `http://localhost:5173` to see it in action.
|