SAMI156 commited on
Commit
edc6b27
β€’
1 Parent(s): dfea9cf

Updated the Readme.md file

Browse files
Files changed (4) hide show
  1. README.md +51 -31
  2. output/check.png +0 -0
  3. output/check3.png +0 -0
  4. output/check5.png +0 -0
README.md CHANGED
@@ -1,53 +1,73 @@
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
+ # πŸ–ΌοΈ 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.
 
 
output/check.png ADDED
output/check3.png ADDED
output/check5.png ADDED