SAMI156 commited on
Commit
0aef0a5
Β·
verified Β·
1 Parent(s): fd5f641

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +87 -73
README.md CHANGED
@@ -1,73 +1,87 @@
1
- # πŸ–ΌοΈ AI Sticker Generator API
2
-
3
- Welcome to the **AI Sticker Generator API**! This API is designed to transform images into high-quality "stickers" by isolating the primary object using advanced **semantic segmentation** techniques. The stickers produced have smooth, feathered edges to ensure a polished and professional look.
4
-
5
- ## Examples
6
-
7
- ### Before and After Transformation
8
-
9
- - **Before:** ![Before](output/check3.png)
10
- **After:** ![After](output/sticker_check3.png)
11
-
12
- - **Before:** ![Before](output/check.png)
13
- **After:** ![After](output/sticker_check.png)
14
-
15
- - **Before:** ![Before](output/check5.png)
16
- **After:** ![After](output/sticker_check5.png)
17
-
18
- ## πŸ“‹ Key Features
19
-
20
- ### πŸ” Semantic Segmentation
21
- Automatically identifies and isolates the main subject in an image, providing precise cutouts for clear and visually appealing stickers.
22
-
23
- ### 🌟 Feathered Edges
24
- Applies a Gaussian blur to the mask edges, creating a soft and natural transition to transparency for a more polished finish.
25
-
26
- ### ⚑ Built with FastAPI
27
- Utilizes FastAPI for high performance, scalability, and fast response times suitable for production environments.
28
-
29
- ### πŸ“‚ Versatile Image Support
30
- Supports **PNG** and **JPEG** formats, ensuring compatibility with widely used image types.
31
-
32
- ## πŸš€ Quick Start Guide
33
-
34
- 1. **Clone the repository** and navigate to the project directory.
35
- 2. **Install dependencies** (requires Python 3.8+).
36
- 3. **Start the API server** using the provided configuration file.
37
- 4. Once the server is running, the API is accessible locally, ready to accept image uploads for sticker generation.
38
-
39
- ## πŸ› οΈ API Endpoints
40
-
41
- ### `POST /create_sticker/`
42
- - **Description**: Upload an image to generate a sticker with a transparent background.
43
- - **Supported File Types**: PNG and JPEG formats.
44
- - **Response**: Returns a PNG image of the sticker with a transparent background. In case of an unsupported file format, an error message will be returned.
45
-
46
- ## 🧩 How It Works
47
-
48
- 1. **Model & Preprocessing**: Uploaded images are preprocessed and passed through a pre-trained model for semantic segmentation.
49
- 2. **Mask Generation**: A binary mask isolates the main object in the image.
50
- 3. **Edge Feathering**: A Gaussian blur is applied to mask edges, creating a smooth transition.
51
- 4. **Sticker Creation**: The mask adds transparency, producing an image that can be directly used as a sticker.
52
-
53
- ## πŸ“‚ Directory Structure
54
-
55
- Generated stickers are saved in a designated output directory, ensuring easy access and organization of created stickers.
56
-
57
- ## βš™οΈ Configuration
58
-
59
- Before running the application, confirm that the output directory exists. This directory is essential for storing generated stickers for easy retrieval and management.
60
-
61
- ## πŸ“œ License
62
-
63
- Licensed under the MIT License, allowing easy adaptation and building upon this work.
64
-
65
- ## πŸ™‹β€β™‚οΈ Contributing
66
-
67
- Contributions are welcome! To contribute, create a new issue or pull request for bug fixes, enhancements, or new features. All contributions should adhere to the project's coding standards and guidelines.
68
-
69
- ## Built with ❀️ by [SAMIULLAH]
70
-
71
- ## πŸ“ž Support
72
-
73
- For support or inquiries, please contact nicesami156@gmail.com.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: mit
3
+ language:
4
+ - en
5
+ base_model:
6
+ - google/deeplabv3_mobilenet_v2_1.0_513
7
+ pipeline_tag: image-to-image
8
+ tags:
9
+ - segmentation
10
+ - sticker
11
+ - deeplab
12
+ - image
13
+ - ai-sticker
14
+ ---
15
+ # πŸ–ΌοΈ AI Sticker Generator API
16
+
17
+ Welcome to the **AI Sticker Generator API**! This API is designed to transform images into high-quality "stickers" by isolating the primary object using advanced **semantic segmentation** techniques. The stickers produced have smooth, feathered edges to ensure a polished and professional look.
18
+
19
+ ## Examples
20
+
21
+ ### Before and After Transformation
22
+
23
+ - **Before:** ![Before](output/check3.png)
24
+ **After:** ![After](output/sticker_check3.png)
25
+
26
+ - **Before:** ![Before](output/check.png)
27
+ **After:** ![After](output/sticker_check.png)
28
+
29
+ - **Before:** ![Before](output/check5.png)
30
+ **After:** ![After](output/sticker_check5.png)
31
+
32
+ ## πŸ“‹ Key Features
33
+
34
+ ### πŸ” Semantic Segmentation
35
+ Automatically identifies and isolates the main subject in an image, providing precise cutouts for clear and visually appealing stickers.
36
+
37
+ ### 🌟 Feathered Edges
38
+ Applies a Gaussian blur to the mask edges, creating a soft and natural transition to transparency for a more polished finish.
39
+
40
+ ### ⚑ Built with FastAPI
41
+ Utilizes FastAPI for high performance, scalability, and fast response times suitable for production environments.
42
+
43
+ ### πŸ“‚ Versatile Image Support
44
+ Supports **PNG** and **JPEG** formats, ensuring compatibility with widely used image types.
45
+
46
+ ## πŸš€ Quick Start Guide
47
+
48
+ 1. **Clone the repository** and navigate to the project directory.
49
+ 2. **Install dependencies** (requires Python 3.8+).
50
+ 3. **Start the API server** using the provided configuration file.
51
+ 4. Once the server is running, the API is accessible locally, ready to accept image uploads for sticker generation.
52
+
53
+ ## πŸ› οΈ API Endpoints
54
+
55
+ ### `POST /create_sticker/`
56
+ - **Description**: Upload an image to generate a sticker with a transparent background.
57
+ - **Supported File Types**: PNG and JPEG formats.
58
+ - **Response**: Returns a PNG image of the sticker with a transparent background. In case of an unsupported file format, an error message will be returned.
59
+
60
+ ## 🧩 How It Works
61
+
62
+ 1. **Model & Preprocessing**: Uploaded images are preprocessed and passed through a pre-trained model for semantic segmentation.
63
+ 2. **Mask Generation**: A binary mask isolates the main object in the image.
64
+ 3. **Edge Feathering**: A Gaussian blur is applied to mask edges, creating a smooth transition.
65
+ 4. **Sticker Creation**: The mask adds transparency, producing an image that can be directly used as a sticker.
66
+
67
+ ## πŸ“‚ Directory Structure
68
+
69
+ Generated stickers are saved in a designated output directory, ensuring easy access and organization of created stickers.
70
+
71
+ ## βš™οΈ Configuration
72
+
73
+ Before running the application, confirm that the output directory exists. This directory is essential for storing generated stickers for easy retrieval and management.
74
+
75
+ ## πŸ“œ License
76
+
77
+ Licensed under the MIT License, allowing easy adaptation and building upon this work.
78
+
79
+ ## πŸ™‹β€β™‚οΈ Contributing
80
+
81
+ Contributions are welcome! To contribute, create a new issue or pull request for bug fixes, enhancements, or new features. All contributions should adhere to the project's coding standards and guidelines.
82
+
83
+ ## Built with ❀️ by [SAMIULLAH]
84
+
85
+ ## πŸ“ž Support
86
+
87
+ For support or inquiries, please contact nicesami156@gmail.com.