anyboxes 0.1.0

Lightweight package for managing bounding boxes that works seamlessly with most computing frameworks.

Lightweight package for managing bounding boxes that works seamlessly with most computing frameworks.

CI/CD
Package
Meta

---

This package provides a simple API for managing bounding boxes. It allows you to perform transformation to your Numpy's ndarray, JAX's Array, PyTorch Tensor or Tensorflow Tensor from one orientation to another.

️️⚙️ Installation

Install the package from the PyPI registry. You may need to specify the framework that you want to managed. Numpy is enabled by default.

pip install anyboxes
# or
pip install "anyboxes[torch]" # or jax, tensorflow

Install the package from the latest commit of the repository.

pip install git+https://github.com/VDuchauffour/anyboxes

⚡ Usage

In a nutshell, the common workflow involve 3 stages:

• Instantiate a Boxes object with one of the following classmethod: from_top_left_corner, from_bottom_left_corner, from_two_corners, from_center
• Apply a transformation with a to inplace method: to_top_left_corner, to_bottom_left_corner, to_two_corners, to_center
• Retrieve the modified data with one of the property: as_dict, as_tuple, as_array, as_numpy, as_tensor

To be more specific, when a Boxes is instantiated, the following attribute are created:

• corners_coordinates attribute (a tuple from top to bottom and from left to right).
• center_coordinates attribute
• shape attribute (width and height)
• origin attribute (which can be equal to top-left or bottom-left, modify this attribute will rearrange the coordinates)

⛏️ Development

Clone the project

git clone https://github.com/VDuchauffour/anyboxes

In order to install all development dependencies, run the following command:

pip install -e ".[dev]"

To ensure that you follow the development workflow, please setup the pre-commit hooks:

pre-commit install