imagebaker 0.0.46__tar.gz → 0.0.49__tar.gz

imagebaker-0.0.49/.github/workflows/black-formatter.yml

@@ -0,0 +1,31 @@
+name: Black Code Formatting
+
+on:
+  push:
+    tags:
+      - "*"  # Trigger the workflow only on tag pushes
+
+jobs:
+  black:
+    runs-on: ubuntu-latest
+
+    steps:
+      # Step 1: Checkout the repository code
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      # Step 2: Set up Python
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+
+      # Step 3: Install Black
+      - name: Install Black
+        run: |
+          python -m pip install --upgrade pip
+          pip install black
+
+      # Step 4: Check formatting with Black
+      - name: Run Black
+        run: black --check .

imagebaker-0.0.49/.github/workflows/pypi.yml

@@ -0,0 +1,75 @@
+name: Build Docs and Publish to PyPI
+
+on:
+  push:
+    tags:  # Trigger the workflow only on tag pushes
+      - "*"  # Match all tags
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      # Step 1: Check out the code
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      # Step 2: Set up Python
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.10'
+
+      # Step 3: Install dependencies
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install mkdocs mkdocs-material mkdocstrings
+          pip install -e .[docs]
+
+      # Step 4: Build documentation
+      - name: Build documentation
+        run: mkdocs build
+
+      # Step 5: Deploy to GitHub Pages
+      - name: Deploy to GitHub Pages
+        run: |
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+          git config --global user.name "github-actions[bot]"
+          git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}
+          mkdocs gh-deploy --force
+
+  build-and-publish:
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/')  # Only run on tag pushes
+
+    steps:
+      # Step 1: Check out the code
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      # Step 2: Set up Python
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"  
+
+      # Step 3: Install build dependencies
+      - name: Install build tools
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine setuptools wheel setuptools-scm # Added wheel package
+
+      # Step 4: Build the distribution
+      - name: Build the package
+        run: python setup.py sdist bdist_wheel  # Use setup.py
+
+      # Step 5: Publish to PyPI
+      - name: Publish to PyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        run: |
+          python -m twine upload dist/*

imagebaker-0.0.49/.gitignore

@@ -0,0 +1,170 @@
+# local files and folders
+*.json
+new_gui
+gui
+weights
+RT-DETR
+*.pt
+exports/
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

imagebaker-0.0.49/CHANGELOG.md

@@ -0,0 +1,26 @@
+## April 2 2025
+Worked on [#3](https://github.com/q-viper/image-baker/issues/3), [#4](https://github.com/q-viper/image-baker/issues/4), [#5](https://github.com/q-viper/image-baker/issues/5) and [#6](https://github.com/q-viper/image-baker/issues/6).
+
+## Fixed
+* Handling of point movement in polygon.
+* Can control the recursive image laoding or partial from config.
+
+## Added
+* Double click on edge of polygon will add a point.
+* Double click on a polygon point will remove that point.
+* Can move point polygon around.
+
+## Removed
+* Double click to select unselect annotation.
+
+## March 24 2025
+### Added
+* Tested with Segmentation, Detection and Prompt models.
+* Transformation of annotation and export.
+
+### Updated
+* Handling of model predictions.
+* Handling of draging layer.
+
+
+### Removed

{imagebaker-0.0.46 → imagebaker-0.0.49}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: imagebaker
-Version: 0.0.46
+Version: 0.0.49
 Summary: A package for baking images.
 Home-page: https://github.com/q-viper/Image-Baker
 Author: Ramkrishna Acharya

imagebaker-0.0.49/TODO.md

@@ -0,0 +1,26 @@
+Highest Priority First
+----------------------
+- [ ] Define a plugin method. Try to implement smokesim here.
+- [x] Instead of defining everything on app.py, use different file for each tab. Try to abstract more generic things in Base classes and inherit them.
+- [ ] Merging two layers
+- [ ] A small dropdown on the layers list that toggles what annotation to export for this layer. Should be options: Default, Rectangle, Polygon.
+- [ ] Occlusion handling.
+- [ ] Instead of separate prompt model class, use a flag in the config. If a prompt is allowed, the prompt will be sent to the model else the propmt will be applied on the image i.e. if passed rectangle for non prompt segmentation model, model will receive cropped image.
+- [ ] Add test scripts (to reproduce results if that is even possible).
+- [ ] How to work with OCR? i.e. generating the image data with text on it.
+- [ ] Add color picker from the active QWidget.
+- [ ] Drawing with color.
+- [ ] Layerifying the drawing.
+- [ ] Option to show gridlines. Only if it does not affect the performance much.
+- [ ] Add Circle mode. Now, we only have point, rectangle and polygon.
+- [ ] Loading of video?
+- [ ] Add pose annotation.
+
+
+- [x] Copy pasting selected layer/annotation with ctrl+c ctrl+v.
+- [x] Updating of annotation i.e. scaling for rectangle, moving point for polygon with cursors.
+- [x] Mouse events should be same for both layers i.e. hot keys to pan, zoom select layer/annotation.
+- [x] Use LayerSettings properly i.e. should be able to see layer's transformation in slider. Upon moving those sliders, layer should show the changes too. Emit the settings and update the Layer. But could be slower based on the step size.
+- [x] A checkbox to toggle the layer's annotation exportation. i.e. some annotations can be skipped like for the background.
+- [x] Actual baking of images has yet to be done. i.e. User should be able to click on the button called **Buffer State**. It should store the layer's settings and it's order in Canvas. Show the number of states available in buffer. 
+- [x] Also show the dropdown for it and upon selecting, should change the canvas. Then add another button **Bake States**. This should apply the settings from buffer state and store the baked image and annotation. Additionally, this should be able to write the baked image and annotation to defined folder.

imagebaker-0.0.49/assets/favicon_io/README.md

@@ -0,0 +1 @@
+These favicons were generated from shopify logo maker.

imagebaker-0.0.49/assets/favicon_io/site.webmanifest

@@ -0,0 +1 @@
+{"name":"","short_name":"","icons":[{"src":"/android-chrome-192x192.png","sizes":"192x192","type":"image/png"},{"src":"/android-chrome-512x512.png","sizes":"512x512","type":"image/png"}],"theme_color":"#ffffff","background_color":"#ffffff","display":"standalone"}

imagebaker-0.0.49/docs/api-reference.md

@@ -0,0 +1,81 @@
+# API Reference
+
+## Application
+
+### App Module
+
+::: imagebaker.window.app
+
+## Tabs
+
+### Layerify Tab
+
+::: imagebaker.tabs.layerify_tab.LayerifyTab 
+
+### Baker Tab
+
+::: imagebaker.tabs.baker_tab.BakerTab
+
+## List Views
+
+### Image List Panel
+
+::: imagebaker.list_views.image_list.ImageListPanel
+
+### Annotation List
+
+::: imagebaker.list_views.annotation_list.AnnotationList
+
+### Canvas List
+
+::: imagebaker.list_views.canvas_list.CanvasList
+
+### Layer List
+
+::: imagebaker.list_views.layer_list.LayerList
+
+### Layer Settings
+
+::: imagebaker.list_views.layer_settings.LayerSettings
+
+## Layers
+
+### Base Layer
+
+::: imagebaker.layers.base_layer.BaseLayer
+
+### Canvas Layer
+
+::: imagebaker.layers.canvas_layer.CanvasLayer
+
+### Annotable Layer
+
+::: imagebaker.layers.annotable_layer.AnnotableLayer
+
+## Workers
+
+### Baker Worker
+
+::: imagebaker.workers.baker_worker.BakerWorker
+
+### Layerify Worker
+
+::: imagebaker.workers.layerify_worker.LayerifyWorker
+
+### Model Prediction Worker
+
+::: imagebaker.workers.model_worker.ModelPredictionWorker
+
+## Utilities
+
+### Image Utilities
+
+::: imagebaker.utils.image
+
+### State Utilities
+
+::: imagebaker.utils.state_utils
+
+### Transform Mask Utilities
+
+::: imagebaker.utils.transform_mask

imagebaker-0.0.49/docs/index.md

@@ -0,0 +1,87 @@
+# Image-Baker
+
+Let's bake an image.
+
+## Why is it relevant?
+
+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.
+
+## Getting Started
+
+### Installation
+
+#### Using PIP
+This project is also available in PyPI server.
+
+```bash
+pip install imagebaker
+```
+
+#### Developing
+Please, clone this repository and install it locally:
+
+```bash
+git clone https://github.com/q-viper/image-baker.git 
+cd image-baker
+pip install -e .
+```
+
+### First Run
+
+Run the following command to launch the GUI:
+
+```bash
+imagebaker
+```
+
+If the command does not work, try running the example script after cloning the project.:
+
+```bash
+python examples/app.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**.
+- **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.
+
+### Shortcuts
+* **Ctrl + C**: Copy selected annotation/layer.
+* **Ctrl + V**: Paste copied annotation/layer in its parent image/layer if it is currently open.
+* **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.
+* **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.
+
+
+## Demo
+
+## Demo
+
+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.

imagebaker-0.0.49/examples/app.py

@@ -0,0 +1,10 @@
+from imagebaker.window.app import main
+from imagebaker.core.configs import LayerConfig, CanvasConfig
+from loaded_models import LOADED_MODELS
+
+if __name__ == "__main__":
+    main(
+        layer_config=LayerConfig(),
+        canvas_config=CanvasConfig(),
+        LOADED_MODELS=LOADED_MODELS,
+    )

imagebaker-0.0.49/examples/example_config.py

@@ -0,0 +1,9 @@
+from imagebaker.core.configs import LayerConfig, CanvasConfig
+
+
+class CustomLayerConfig(LayerConfig):
+    project_name: str = "Custom Project"
+
+
+class CustomCanvasConfig(CanvasConfig):
+    project_name: str = "Custom Project"

imagebaker-0.0.49/examples/loaded_models.py

@@ -0,0 +1,59 @@
+import sys
+from pathlib import Path
+
+# Add the project root to sys.path
+sys.path.append(str(Path(__file__).resolve().parent.parent))
+
+from imagebaker.models.base_model import (
+    DefaultModelConfig,
+    BaseClassificationModel,
+    get_dummy_prediction_result,
+    ModelType,
+)
+from imagebaker.models.base_model import BaseDetectionModel
+from imagebaker import logger
+
+# Import models from the examples folder
+# from examples.rtdetr_v2 import RTDetrModelConfig, RTDetrDetectionModel
+# from examples.segmentation import (
+#     YoloSegmentationModel,
+#     YoloSegmentationModelConfig,
+# )
+# from examples.sam_model import SegmentAnythingModel, SAMModelConfig
+
+
+class ClassificationModel(BaseClassificationModel):
+    def __init__(self, config: DefaultModelConfig):
+        super().__init__(config)
+
+    def predict_class(self, image):
+        return [get_dummy_prediction_result(self.config.model_type)]
+
+
+class DetectionModel(BaseDetectionModel):
+    def __init__(self, config: DefaultModelConfig):
+        super().__init__(config)
+
+    def predict_boxes(self, image):
+        return [get_dummy_prediction_result(self.config.model_type)]
+
+
+# detector = RTDetrDetectionModel(RTDetrModelConfig())
+
+# classification = ClassificationModel(
+#     DefaultModelConfig(model_type=ModelType.CLASSIFICATION)
+# )
+# segmentation = YoloSegmentationModel(YoloSegmentationModelConfig())
+# prompt = SegmentAnythingModel(SAMModelConfig())
+dummy_detector = DetectionModel(DefaultModelConfig(model_type=ModelType.DETECTION))
+
+
+LOADED_MODELS = {
+    "DummyDetectionModel": dummy_detector,
+    # "PromptModel": prompt,
+    # "SegmentationModel": segmentation,
+    # "RTDetrV2": detector,
+    # "ClassificationModel": classification,
+}
+
+logger.info(f"Loaded models: {LOADED_MODELS}")