Updated Readme.md again
Browse files
README.md
CHANGED
|
@@ -1,53 +1,64 @@
|
|
| 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 |
-
##
|
| 49 |
-
|
| 50 |
-
|
| 51 |
-
|
| 52 |
-
|
| 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 |
+

|
| 19 |
+

|
| 20 |
+

|
| 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 |
+
---
|