SAMI156 commited on
Commit
91116da
Β·
verified Β·
1 Parent(s): dfea9cf

Updated Readme.md again

Browse files
Files changed (1) hide show
  1. README.md +64 -53
README.md CHANGED
@@ -1,53 +1,64 @@
1
- # πŸ–ΌοΈ Image Sticker Generator API
2
- Welcome to the Image Sticker Generator API! This service is designed to transform images into "stickers" by isolating the main object with advanced semantic segmentation. The stickers are crafted with smooth, feathered edges to ensure a clean and professional appearance.
3
-
4
-
5
- ## Examples
6
-
7
- ![Example1](output/sticker_check3.png)
8
- ![Example2](output/sticker_check.png)
9
- ![Example3](output/sticker_check5.png)
10
-
11
-
12
- ## πŸ“‹ Features
13
- ### πŸ” Semantic Segmentation: Automatically detects and highlights the main object in an image, ensuring accurate cutouts and clear subject isolation.
14
- ### 🌟 Feathered Edges: Applies a soft Gaussian blur to mask edges, creating a natural transition to transparency.
15
- ### ⚑ Built with FastAPI: Ensures high performance, scalability, and rapid response times for production use.
16
- ### πŸ“‚ Versatile Image Support: Accepts both PNG and JPEG image formats.
17
-
18
- ### πŸš€ Quick Start Guide
19
- Clone the repository and navigate to the project directory.
20
- Install Dependencies with Python 3.8+.
21
- Start the API Server using the provided configuration.
22
- Once running, the API will be accessible locally, ready for image uploads and sticker creation.
23
-
24
- ## πŸ› οΈ API Endpoints
25
- POST /create_sticker/
26
- Description: Upload an image to generate a sticker with a transparent background.
27
- Supported File Types: Accepts PNG and JPEG formats.
28
- 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.
29
- ## 🧩 How It Works
30
- Model & Preprocessing: Uploaded images are preprocessed and passed through a pre-trained model for semantic segmentation.
31
- Mask Generation: A binary mask isolates the main object in the image.
32
- Edge Feathering: A Gaussian blur is applied to the mask edges to create a soft transition.
33
- Sticker Creation: The mask is used to add transparency, producing an image that can be directly used as a sticker.
34
- ## πŸ“‚ Directory Structure
35
- The main application file manages the API and endpoints, while generated stickers are saved in a designated output directory. This ensures easy access and organization for generated images.
36
-
37
- ## βš™οΈ Configuration
38
- Before running the application, confirm that the output directory exists. This is essential for storing all generated stickers for easy retrieval and management.
39
-
40
- ## πŸ“œ License
41
- Licensed under the MIT License, making it easy for anyone to adapt and build upon the work.
42
-
43
- ## πŸ™‹β€β™‚οΈ Contributing
44
- 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.
45
-
46
- ## Built with ❀️ by [SAMIULLAH]
47
-
48
- ## πŸ“ž Support
49
- For support or inquiries, please contact nicesami156@gmail.com.
50
-
51
- ---
52
- license: mit
53
- ---
 
 
 
 
 
 
 
 
 
 
 
 
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
+ - art
10
+ - sticker
11
+ ---
12
+ # πŸ–ΌοΈ Image Sticker Generator API
13
+ Welcome to the Image Sticker Generator API! This service is designed to transform images into "stickers" by isolating the main object with advanced semantic segmentation. The stickers are crafted with smooth, feathered edges to ensure a clean and professional appearance.
14
+
15
+
16
+ ## Examples
17
+
18
+ ![Example1](output/sticker_check3.png)
19
+ ![Example2](output/sticker_check.png)
20
+ ![Example3](output/sticker_check5.png)
21
+
22
+
23
+ ## πŸ“‹ Features
24
+ ### πŸ” Semantic Segmentation: Automatically detects and highlights the main object in an image, ensuring accurate cutouts and clear subject isolation.
25
+ ### 🌟 Feathered Edges: Applies a soft Gaussian blur to mask edges, creating a natural transition to transparency.
26
+ ### ⚑ Built with FastAPI: Ensures high performance, scalability, and rapid response times for production use.
27
+ ### πŸ“‚ Versatile Image Support: Accepts both PNG and JPEG image formats.
28
+
29
+ ### πŸš€ Quick Start Guide
30
+ Clone the repository and navigate to the project directory.
31
+ Install Dependencies with Python 3.8+.
32
+ Start the API Server using the provided configuration.
33
+ Once running, the API will be accessible locally, ready for image uploads and sticker creation.
34
+
35
+ ## πŸ› οΈ API Endpoints
36
+ POST /create_sticker/
37
+ Description: Upload an image to generate a sticker with a transparent background.
38
+ Supported File Types: Accepts PNG and JPEG formats.
39
+ 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.
40
+ ## 🧩 How It Works
41
+ Model & Preprocessing: Uploaded images are preprocessed and passed through a pre-trained model for semantic segmentation.
42
+ Mask Generation: A binary mask isolates the main object in the image.
43
+ Edge Feathering: A Gaussian blur is applied to the mask edges to create a soft transition.
44
+ Sticker Creation: The mask is used to add transparency, producing an image that can be directly used as a sticker.
45
+ ## πŸ“‚ Directory Structure
46
+ The main application file manages the API and endpoints, while generated stickers are saved in a designated output directory. This ensures easy access and organization for generated images.
47
+
48
+ ## βš™οΈ Configuration
49
+ Before running the application, confirm that the output directory exists. This is essential for storing all generated stickers for easy retrieval and management.
50
+
51
+ ## πŸ“œ License
52
+ Licensed under the MIT License, making it easy for anyone to adapt and build upon the work.
53
+
54
+ ## πŸ™‹β€β™‚οΈ Contributing
55
+ 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.
56
+
57
+ ## Built with ❀️ by [SAMIULLAH]
58
+
59
+ ## πŸ“ž Support
60
+ For support or inquiries, please contact nicesami156@gmail.com.
61
+
62
+ ---
63
+ license: mit
64
+ ---