Update README.md
Browse files
README.md
CHANGED
|
@@ -1,73 +1,87 @@
|
|
| 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 |
-
1. **
|
| 49 |
-
2. **
|
| 50 |
-
3. **
|
| 51 |
-
4.
|
| 52 |
-
|
| 53 |
-
##
|
| 54 |
-
|
| 55 |
-
|
| 56 |
-
|
| 57 |
-
|
| 58 |
-
|
| 59 |
-
|
| 60 |
-
|
| 61 |
-
|
| 62 |
-
|
| 63 |
-
|
| 64 |
-
|
| 65 |
-
|
| 66 |
-
|
| 67 |
-
|
| 68 |
-
|
| 69 |
-
|
| 70 |
-
|
| 71 |
-
##
|
| 72 |
-
|
| 73 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 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:** 
|
| 24 |
+
**After:** 
|
| 25 |
+
|
| 26 |
+
- **Before:** 
|
| 27 |
+
**After:** 
|
| 28 |
+
|
| 29 |
+
- **Before:** 
|
| 30 |
+
**After:** 
|
| 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.
|