imagebaker 0.0.4__py3-none-any.whl → 0.0.41__py3-none-any.whl

{imagebaker-0.0.4.dist-info → imagebaker-0.0.41.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: imagebaker
-Version: 0.0.4
+Version: 0.0.41
 Summary: A package for baking images.
 Author-email: Ramkrishna Acharya <qramkrishna@gmail.com>
 License: MIT
@@ -29,6 +29,20 @@ Requires-Dist: mkdocs-awesome-pages-plugin; extra == "docs"
 Dynamic: license-file
 
 # Image-Baker
+![Dependabot Status](https://img.shields.io/badge/dependabot-active-brightgreen)
+![GitHub License](https://img.shields.io/github/license/q-viper/image-baker)
+![commit activity](https://img.shields.io/github/commit-activity/w/q-viper/SmokeSim/master)
+![code size in bytes](https://img.shields.io/github/languages/code-size/q-viper/image-baker)
+<!-- ![Tests](https://github.com/q-viper/SmokeSim/actions/workflows/test-on-push.yml/badge.svg) -->
+![Code Formatting](https://github.com/q-viper/image-baker/actions/workflows/black-formatter.yml/badge.svg)
+
+
+<p align="center">
+    <img src="assets/demo.gif" alt="Centered Demo" />
+</p>
+
+
+*An example of baked images. (Each object is a layer and an annotation will also be extracted for all layers.)*
 
 Let's bake an image.
 
@@ -37,15 +51,12 @@ Let's bake an image.
 When training computer vision models (especially for detection and segmentation), labeling large amounts of data is crucial for better model performance. Often, the process involves multiple cycles of labeling, training, and evaluation. By generating multiple realistic labeled datasets from a single image, the time spent on labeling can be significantly reduced.
 
 ## What's up with the name?
-
-The concept involves extracting portions of an image (e.g., objects of interest) using tools like polygons or models such as Segment Anything. These extractions are treated as layers, which can then be copied, pasted, and manipulated to create multiple instances of the desired object. By combining these layers step by step, a new labeled image with annotations in JSON format is created. The term "Baking" refers to the process of merging these layers into a single cohesive image.
+The concept involves extracting portions of an image (e.g., objects of interest) using tools like polygons or models such as Segment Anything. These extractions are treated as layers, which can then be copied, pasted, and manipulated to create multiple instances of the desired object. By combining these layers step by step, a new labeled image with annotations in JSON format is created. The term "baking" refers to the process of merging these layers into a single cohesive image.
 
 ## Getting Started
-
 ### Installation
-
 #### Using PIP
-This project is also available in PyPI server.
+This project is also available on the PyPI server.
 
 ```bash
 pip install imagebaker
@@ -61,25 +72,29 @@ pip install -e .
 ```
 
 ### First Run
-
 Run the following command to launch the GUI:
 
-```bash
-imagebaker
-```
+`imagebaker`
 
-If the command does not work, try running the example script after cloning the project.:
+By default, the above command will not run any models on the backend. So please take a look into the example of model definition at [examples/loaded_models.py](examples/loaded_models.py). Then we need to pass it as:
 
-```bash
-python examples/app.py
-```
+`imagebaker --models-file examples/loaded_models.py`
 
-## Features
+For more options, please do: `imagebaker --help` It should give the following options.
+
+![](assets/demo/options.png)
+
+
+* **`--configs-file`** allows us to define custom configs. The custom configs have to inherit LayerConfig and CanvasConfig defined at [imagebaker/core/configs/configs.py](imagebaker/core/configs/configs.py). An example is available at [examples](examples/). 
 
+After cloning and going to the project directory, the following code should work.
+`imagebaker --models-file examples/loaded_models.py --configs-file examples/example_config.py`
+
+## Features
 - **Annotating Images**: Load a folder of images and annotate them using bounding boxes or polygons.
 - **Model Testing**: Define models for detection, segmentation, and prompts (e.g., points or rectangles) by following the base model structure in [imagebaker/models/base_model.py](imagebaker/models/base_model.py). See [examples/loaded_models.py](examples/loaded_models.py) for a working example.
 - **Layerifying**: Crop images based on annotations to create reusable layers. Each cropped image represents a single layer.
-- **Baking States**: Arrange layers to create image variations by dragging, rotating, adjusting opacity, and more. Save the state using the **Save State** button or **Ctrl + S**.
+- **Baking States**: Arrange layers to create image variations by dragging, rotating, adjusting opacity, and more. Save the state using the Save State button or Ctrl + S.
 - **Playing States**: Replay saved states, export them locally, or use them for further predictions.
 - **Exporting States**: Export the final annotated JSON and the baked multilayer image.
 
@@ -89,29 +104,50 @@ python examples/app.py
 * **Delete**: Delete selected annotation/layer.
 * **Left Click**: Select an annotation/layer on mouse position.
 * **Left Click + Drag**: Drag a selected annotation/layer.
-* **Double Left Click**: When using Polygon annotation, completes the polygon.
-* **Right Click**: Deselect an annotation/layer. While on annotating polygon, undo last point.
-* **Ctrl + Mouse Wheel**: Zoom In/Out on the mouse position i.e. resizes the viewport.
+* **Double Left Click**: When using polygon annotation, completes the polygon.
+* **Right Click**: Deselect an annotation/layer. While annotating the polygon, undo the last point.
+* **Ctrl + Mouse Wheel**: Zoom In/Out on the mouse position, i.e., resize the viewport.
 * **Ctrl + Drag**: If done on the background, the viewport is panned.
 * **Ctrl + S**: Save State on Baker Tab.
 * **Ctrl + D**: Draw Mode on Baker Tab. Drawing can happen on a selected or main layer.
 * **Ctrl + E**: Erase Mode on Baker Tab.
-* **Wheel**: Change size of the drawing pointer.
-
+* **Wheel**: Change the size of the drawing pointer.
 
 ## Demo
+### Annotation Page
+This is where the loading of the image folder and annotation, connection with the model running in the backend, and layerifying happen.
 
-## Demo
+![](assets/demo/annotation_page.png)
+
+### Baker Page
+This is where the layer baking happens. And the extraction of the layers as well.
+
+![](assets/demo/baker_page.png)
+
+An example of drawing:
+
+![](assets/demo/drawing.png)
+
+### Annotated
+
+The JSON and the baked image will be exported to the local folder, and in debug mode, the annotations and the mask for each layer will be exported too.
+
+![](assets/demo/annotated_veg_smiley.png)
+
+### Demo Video
 
 To see the tool in action, check out the demo video below:
 
+
 [![Demo Video](https://img.youtube.com/vi/WckMT0r-2Lc/0.jpg)](https://youtu.be/WckMT0r-2Lc)
 
+
 Click on the image above to play the video on YouTube.
 
 
 ## Contributions
 
+
 Contributions are welcome! 
 
-Do you find this project to be useful and looking for some features that is not implemented yet? Feel free to open issues or submit pull requests to improve the project.
+Do you find this project to be useful and are you looking for some features that are not implemented yet? Feel free to open issues or submit pull requests to improve the project.

imagebaker-0.0.41.dist-info/RECORD

@@ -0,0 +1,7 @@
+imagebaker/__init__.py,sha256=UeXmuH87AJb0MVzWgT4HXNtl99XxS7HGenLyI9K93go,127
+imagebaker-0.0.41.dist-info/licenses/LICENSE,sha256=1vkysFPOnT7y4LsoFTv9YsopIrQvBc2l6vUOfv4KKLc,1082
+imagebaker-0.0.41.dist-info/METADATA,sha256=lJ-4W657mS5XgQ0mKDISr3tdVzTVYSTcTnda-sAPLbs,6761
+imagebaker-0.0.41.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+imagebaker-0.0.41.dist-info/entry_points.txt,sha256=IDjZHJCiiHpH5IUTByT2en0nMbnnnlrJZ5FPFehUvQM,61
+imagebaker-0.0.41.dist-info/top_level.txt,sha256=Gg-eILTlqJXwVQr0saSwsx3-H4SPdZ2agBZaufe194s,11
+imagebaker-0.0.41.dist-info/RECORD,,

imagebaker-0.0.4.dist-info/RECORD

@@ -1,7 +0,0 @@
-imagebaker/__init__.py,sha256=UeXmuH87AJb0MVzWgT4HXNtl99XxS7HGenLyI9K93go,127
-imagebaker-0.0.4.dist-info/licenses/LICENSE,sha256=1vkysFPOnT7y4LsoFTv9YsopIrQvBc2l6vUOfv4KKLc,1082
-imagebaker-0.0.4.dist-info/METADATA,sha256=PHVvDdO8aGlw333C7SLYIh6i3oMAT6epQ8uWfqDnnJo,4715
-imagebaker-0.0.4.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-imagebaker-0.0.4.dist-info/entry_points.txt,sha256=IDjZHJCiiHpH5IUTByT2en0nMbnnnlrJZ5FPFehUvQM,61
-imagebaker-0.0.4.dist-info/top_level.txt,sha256=Gg-eILTlqJXwVQr0saSwsx3-H4SPdZ2agBZaufe194s,11
-imagebaker-0.0.4.dist-info/RECORD,,