readme

README.md

@@ -9,122 +9,123 @@ app_file: gradio_imager.py
 pinned: false
 license: apache-2.0
 ---
-# Product IMAGER ___ Image Processing Script
+# IMAGER - Advanced Image Processing Tool 🖼️
 
-This Python script offers a versatile image processing toolkit, allowing for operations such as background removal, autocropping, resizing, and adding padding to images. It's designed to process images in bulk, making it an ideal solution for preparing images for web use or personal projects.
+IMAGER is a versatile image processing toolkit that offers both a CLI interface for bulk processing and a user-friendly Gradio web interface. It supports various image manipulation features including background removal, resizing, cropping, and background color adjustment.
 
-## Features
+## Features 🚀
 
-- **Background Removal**: Automatically removes the background from images.
-- **Autocropping**: Crops images to remove unnecessary transparent space.
-- **Resizing**: Resizes images to specified dimensions, maintaining aspect ratio.ssh -
-- **Padding**: Adds padding around images, ensuring the final image size matches specified dimensions.
+- **Background Removal**: Automatically remove image backgrounds using the `rembg` library
+- **Smart Cropping**: Autocrop images based on content
+- **Flexible Resizing**: Resize images while maintaining aspect ratio
+- **Padding Control**: Add customizable padding around images
+- **Background Customization**: Set custom background colors or use color names
+- **Preset Settings**: Choose from predefined configurations (S/M/L, light/dark themes)
+- **Dual Interface**: Use either CLI for batch processing or Gradio web interface for single images
 
-## Installation
+## Installation 🔧
 
-To run this script, you'll need Python installed on your system along with the following packages:
-- Pillow
-- rembg
-
-You can install the required packages using pip:
-
-```sh
-pip install Pillow rembg
+```bash
+# Install required packages
+pip install Pillow rembg onnxruntime gradio
 ```
 
-# CLI Usage imager.py
+## CLI Usage (imager.py) 💻
 
-Place the images you want to process in the ./input directory. The CLI command is intended for bulk processing. Run the script with desired options:
+Perfect for bulk processing images. Place images in the `./input` directory and run:
 
-```sh
+```bash
 python imager.py -b -c -r 800x600 -p 10
 ```
 
-## Command-Line Arguments
-
-- `-b, --background_removal`: Enable background removal.
-- `-c, --crop`: Enable autocropping.
-- `-r, --resize AxB`: Resize the image to fit within AxB pixels, maintaining aspect ratio.
-- `-p, --padding PIXELS`: Add PIXELS number of padding around the image. The final image size stays as specified in `-r AxB`.
-- `-bg, --background BACKGROUND`: Add a background to the image. Accepts color names, hex codes, or paths to image files.
+### Command-Line Arguments
+- `-b, --background_removal`: Enable background removal
+- `-c, --crop`: Enable autocropping
+- `-r, --resize AxB`: Resize to AxB pixels (maintains aspect ratio)
+- `-p, --padding PIXELS`: Add padding around the image
+- `-bg, --background BACKGROUND`: Add background (color name, hex code, or image path)
 
-## Example
-To process images by removing the background, autocropping, resizing to 800x600 pixels, and adding 10 pixels of padding:
-
-```sh
+### CLI Example
+```bash
+# Process images with background removal, crop, and resize to 320x280
 python imager.py -b -c -r 320x280 -p 10
-```
-
-This command processes all images in the ./input directory and saves the processed images to the ./output directory.
 
-Super Mario and Fujicamera automatically converted by imager.py: bg_removed, cropped and skaled to 320x280.  
-
-<img src="data/examples/supermario.png" alt="alt text" width="200" style="border: 1px solid white;">  
-<img src="data/examples/supermario_b_c320x280.png" alt="alt text" width="200" style="border: 1px solid white;">  
-
-<img src="data/examples/depositphotos_520707962-stock-photo-fujifilm-s10-body-black-fujifilm.jpg" alt="alt text" width="200" style="border: 1px solid white;">  
-<img src="data/examples/depositphotos_520707962-stock-photo-fujifilm-s10-body-black-fujifilm_b_c320x280.png" alt="alt text" width="200" style="border: 1px solid white;">  
+# Add a green background
+python imager.py -b -c -r 320x280 -p 10 -bg green
+```
 
-  
-### Adding a background
+## Gradio Web Interface (gradio_imager.py) 🌐
 
-Let's add a blue and a green and blue background.
+For processing single images with real-time preview:
 
-```sh
-python imager.py -b -c -r 320x280 -p 10 -bg green
+```bash
+python gradio_imager.py
 ```
-<img src="data/examples/batman_b_c_320x280_bg.png" alt="alt text" width="200" style="border: 1px solid white;">  
-<img src="data/examples/supermario2_b_c_320x280_bg.png" alt="alt text" width="200" style="border: 1px solid white;">  
 
+### Web Interface Features
+1. Upload an image or use example images
+2. Choose from preset settings or customize:
+   - Enable/disable cropping
+   - Toggle background removal
+   - Set custom dimensions (e.g., "480x480")
+   - Adjust padding (0-200 pixels)
+   - Choose background color
 
-## Background Colors
+### Standard Settings ⚙️
+- **Light Theme**: S (240x240), M (480x480), L (960x960)
+- **Dark Theme**: Same sizes with dark background (#2A373D)
 
-Grayscale Monochrome Color Palette: This palette consists of different shades of gray, from light to dark, creating a simple yet effective look. The hex codes are:
+## Background Color Palettes 🎨
 
+### Grayscale Monochrome
 | Color Name     | Hex Code |
 |----------------|----------|
-| Light Gray     | #D1D1D3  |
-| Lavender Gray  | #C6C6C7  |
-| Silver Foil    | #AFAFB0  |
-| Quick Silver   | #A4A4A5  |
-| Spanish Gray   | #999999  |
-
-Feminine Soft Neutrals: This palette features warm and cozy tones, such as sand, orange, and pink, creating an inviting atmosphere. The hex codes are:
+| Light Gray     | #D1D1D3 |
+| Lavender Gray  | #C6C6C7 |
+| Silver Foil    | #AFAFB0 |
+| Quick Silver   | #A4A4A5 |
+| Spanish Gray   | #999999 |
 
+### Feminine Soft Neutrals
 | Color Name    | Hex Code |
 |---------------|----------|
-| Alabaster     | #F4EEE1  |
-| Dark Vanilla  | #C4BDAC  |
-| Dust Storm    | #EBCFC4  |
-| Pale Silver   | #D3C4BE  |
-| Desert Sand   | #E9CCB1  |
-
-
-Neutral Brown Color Palette: This palette offers a rich range of brown tones, from deep and dark to light and delicate, creating a sense of stability and warmth. The hex codes are:
+| Alabaster     | #F4EEE1 |
+| Dark Vanilla  | #C4BDAC |
+| Dust Storm    | #EBCFC4 |
+| Pale Silver   | #D3C4BE |
+| Desert Sand   | #E9CCB1 |
 
+### Neutral Brown
 | Color Name      | Hex Code |
 |-----------------|----------|
-| Café Noir       | #4E3829  |
-| Coffee          | #6B513E  |
-| Beaver          | #8E7766  |
-| Khaki           | #B09C8D  |
-| Champagne Pink  | #E6D7CE  |
+| Café Noir       | #4E3829 |
+| Coffee          | #6B513E |
+| Beaver          | #8E7766 |
+| Khaki           | #B09C8D |
+| Champagne Pink  | #E6D7CE |
 
-# Gradio App gradio_imager.py
+## Code Structure 📁
 
-start the gradio app with the below command. the app can handle only one image at a time.
-```sh
-python gradio_imager.py
-```  
+- `imager.py`: CLI interface for batch processing
+- `gradio_imager.py`: Gradio web interface
+- `image_processor.py`: Core image processing functions
+- `/data/examples/`: Example images for testing
 
-![gradio app](data/gradioimager2.png)
+## Technical Stack 🛠️
 
-# License
-This project is open-source and available under the MIT License.
+- `Gradio` for web interface
+- `PIL` for image processing
+- `rembg` for background removal
+- `onnxruntime` for ML operations
+
+## Contributing 🤝
 
-## Contributing
+Contributions are welcome! Feel free to fork the repository and submit pull requests.
 
-Contributions to improve the script or add new features are welcome. Please feel free to fork the repository and submit pull requests.
+## License 📜
 
+This project is open-source and available under the MIT License.
+
+---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference