diff --git a/.gitattributes b/.gitattributes
index a6344aac8c09253b3b630fb776ae94478aa0275b..f6b1f326ca4ab7cf0c8798856f8fe0020ff82d58 100644
--- a/.gitattributes
+++ b/.gitattributes
@@ -33,3 +33,4 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
*.zip filter=lfs diff=lfs merge=lfs -text
*.zst filter=lfs diff=lfs merge=lfs -text
*tfevents* filter=lfs diff=lfs merge=lfs -text
+*.png filter=lfs diff=lfs merge=lfs -text
diff --git a/.gradio/certificate.pem b/.gradio/certificate.pem
new file mode 100644
index 0000000000000000000000000000000000000000..b85c8037f6b60976b2546fdbae88312c5246d9a3
--- /dev/null
+++ b/.gradio/certificate.pem
@@ -0,0 +1,31 @@
+-----BEGIN CERTIFICATE-----
+MIIFazCCA1OgAwIBAgIRAIIQz7DSQONZRGPgu2OCiwAwDQYJKoZIhvcNAQELBQAw
+TzELMAkGA1UEBhMCVVMxKTAnBgNVBAoTIEludGVybmV0IFNlY3VyaXR5IFJlc2Vh
+cmNoIEdyb3VwMRUwEwYDVQQDEwxJU1JHIFJvb3QgWDEwHhcNMTUwNjA0MTEwNDM4
+WhcNMzUwNjA0MTEwNDM4WjBPMQswCQYDVQQGEwJVUzEpMCcGA1UEChMgSW50ZXJu
+ZXQgU2VjdXJpdHkgUmVzZWFyY2ggR3JvdXAxFTATBgNVBAMTDElTUkcgUm9vdCBY
+MTCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAK3oJHP0FDfzm54rVygc
+h77ct984kIxuPOZXoHj3dcKi/vVqbvYATyjb3miGbESTtrFj/RQSa78f0uoxmyF+
+0TM8ukj13Xnfs7j/EvEhmkvBioZxaUpmZmyPfjxwv60pIgbz5MDmgK7iS4+3mX6U
+A5/TR5d8mUgjU+g4rk8Kb4Mu0UlXjIB0ttov0DiNewNwIRt18jA8+o+u3dpjq+sW
+T8KOEUt+zwvo/7V3LvSye0rgTBIlDHCNAymg4VMk7BPZ7hm/ELNKjD+Jo2FR3qyH
+B5T0Y3HsLuJvW5iB4YlcNHlsdu87kGJ55tukmi8mxdAQ4Q7e2RCOFvu396j3x+UC
+B5iPNgiV5+I3lg02dZ77DnKxHZu8A/lJBdiB3QW0KtZB6awBdpUKD9jf1b0SHzUv
+KBds0pjBqAlkd25HN7rOrFleaJ1/ctaJxQZBKT5ZPt0m9STJEadao0xAH0ahmbWn
+OlFuhjuefXKnEgV4We0+UXgVCwOPjdAvBbI+e0ocS3MFEvzG6uBQE3xDk3SzynTn
+jh8BCNAw1FtxNrQHusEwMFxIt4I7mKZ9YIqioymCzLq9gwQbooMDQaHWBfEbwrbw
+qHyGO0aoSCqI3Haadr8faqU9GY/rOPNk3sgrDQoo//fb4hVC1CLQJ13hef4Y53CI
+rU7m2Ys6xt0nUW7/vGT1M0NPAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNV
+HRMBAf8EBTADAQH/MB0GA1UdDgQWBBR5tFnme7bl5AFzgAiIyBpY9umbbjANBgkq
+hkiG9w0BAQsFAAOCAgEAVR9YqbyyqFDQDLHYGmkgJykIrGF1XIpu+ILlaS/V9lZL
+ubhzEFnTIZd+50xx+7LSYK05qAvqFyFWhfFQDlnrzuBZ6brJFe+GnY+EgPbk6ZGQ
+3BebYhtF8GaV0nxvwuo77x/Py9auJ/GpsMiu/X1+mvoiBOv/2X/qkSsisRcOj/KK
+NFtY2PwByVS5uCbMiogziUwthDyC3+6WVwW6LLv3xLfHTjuCvjHIInNzktHCgKQ5
+ORAzI4JMPJ+GslWYHb4phowim57iaztXOoJwTdwJx4nLCgdNbOhdjsnvzqvHu7Ur
+TkXWStAmzOVyyghqpZXjFaH3pO3JLF+l+/+sKAIuvtd7u+Nxe5AW0wdeRlN8NwdC
+jNPElpzVmbUq4JUagEiuTDkHzsxHpFKVK7q4+63SM1N95R1NbdWhscdCb+ZAJzVc
+oyi3B43njTOQ5yOf+1CceWxG1bQVs5ZufpsMljq4Ui0/1lvh+wjChP4kqKOJ2qxq
+4RgqsahDYVvTH9w7jXbyLeiNdd8XM2w9U/t7y0Ff/9yi0GE44Za4rF2LN9d11TPA
+mRGunUHBcnWEvgJBQl9nJEiU0Zsnvgc/ubhPgXRR4Xq37Z0j4r7g1SgEEzwxA57d
+emyPxgcYxn/eR44/KJ4EBs+lVDR3veyJm+kXQ99b21/+jh5Xos1AnX5iItreGCc=
+-----END CERTIFICATE-----
diff --git a/background.png b/background.png
index d9832daa3e57ecd9dda672e4e358d3b567dcdcff..4d0953f767772492b832572182871df68d75360d 100644
Binary files a/background.png and b/background.png differ
diff --git a/src/.github/workflows/python-publish.yml b/src/.github/workflows/python-publish.yml
new file mode 100644
index 0000000000000000000000000000000000000000..bdaab28a48d6b2941815b3490922e36514ff4cd0
--- /dev/null
+++ b/src/.github/workflows/python-publish.yml
@@ -0,0 +1,39 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+ release:
+ types: [published]
+
+permissions:
+ contents: read
+
+jobs:
+ deploy:
+
+ runs-on: ubuntu-latest
+
+ steps:
+ - uses: actions/checkout@v3
+ - name: Set up Python
+ uses: actions/setup-python@v3
+ with:
+ python-version: '3.x'
+ - name: Install dependencies
+ run: |
+ python -m pip install --upgrade pip
+ pip install build
+ - name: Build package
+ run: python -m build
+ - name: Publish package
+ uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+ with:
+ user: __token__
+ password: ${{ secrets.PYPI_API_TOKEN }}
diff --git a/src/.gitignore b/src/.gitignore
new file mode 100644
index 0000000000000000000000000000000000000000..70417323828bbf01b38aac89ace20bee0209f382
--- /dev/null
+++ b/src/.gitignore
@@ -0,0 +1,9 @@
+.eggs/
+dist/
+*.pyc
+__pycache__/
+*.py[cod]
+*$py.class
+__tmp/*
+*.pyi
+node_modules
\ No newline at end of file
diff --git a/src/Dockerfile b/src/Dockerfile
new file mode 100644
index 0000000000000000000000000000000000000000..6bf7e8e898c4a3ac24894cdc4ecbfb0b6765bf1b
--- /dev/null
+++ b/src/Dockerfile
@@ -0,0 +1,12 @@
+# FROM nikolaik/python-nodejs:python3.10-nodejs20-alpine
+FROM node:20.5.0
+
+WORKDIR /app
+
+
+RUN apt-get update && \
+ apt-get install -y python3-pip
+
+RUN rm /usr/lib/python3.11/EXTERNALLY-MANAGED
+
+RUN python3 -m pip install --no-cache-dir gradio==4.27 numpy
\ No newline at end of file
diff --git a/src/LICENSE b/src/LICENSE
new file mode 100644
index 0000000000000000000000000000000000000000..4e99bb556aeadeb02eee677a0e1fd685ec273d95
--- /dev/null
+++ b/src/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Edgar Gracia
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/src/README.md b/src/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..2e9e12795c82802a341545284afd241a578d135b
--- /dev/null
+++ b/src/README.md
@@ -0,0 +1,558 @@
+
+# `gradio_image_annotation`
+
+
+A Gradio component that can be used to annotate images with bounding boxes.
+
+## Installation
+
+```bash
+pip install gradio_image_annotation
+```
+
+## Usage
+
+```python
+import gradio as gr
+from gradio_image_annotation import image_annotator
+
+
+example_annotation = {
+ "image": "https://gradio-builds.s3.amazonaws.com/demo-files/base.png",
+ "boxes": [
+ {
+ "xmin": 636,
+ "ymin": 575,
+ "xmax": 801,
+ "ymax": 697,
+ "label": "Vehicle",
+ "color": (255, 0, 0)
+ },
+ {
+ "xmin": 360,
+ "ymin": 615,
+ "xmax": 386,
+ "ymax": 702,
+ "label": "Person",
+ "color": (0, 255, 0)
+ }
+ ]
+}
+
+examples_crop = [
+ {
+ "image": "https://raw.githubusercontent.com/gradio-app/gradio/main/guides/assets/logo.png",
+ "boxes": [
+ {
+ "xmin": 30,
+ "ymin": 70,
+ "xmax": 530,
+ "ymax": 500,
+ "color": (100, 200, 255),
+ }
+ ],
+ },
+ {
+ "image": "https://gradio-builds.s3.amazonaws.com/demo-files/base.png",
+ "boxes": [
+ {
+ "xmin": 636,
+ "ymin": 575,
+ "xmax": 801,
+ "ymax": 697,
+ "color": (255, 0, 0),
+ },
+ ],
+ },
+]
+
+
+def crop(annotations):
+ if annotations["boxes"]:
+ box = annotations["boxes"][0]
+ return annotations["image"][
+ box["ymin"]:box["ymax"],
+ box["xmin"]:box["xmax"]
+ ]
+ return None
+
+
+def get_boxes_json(annotations):
+ return annotations["boxes"]
+
+
+with gr.Blocks() as demo:
+ with gr.Tab("Object annotation", id="tab_object_annotation"):
+ annotator = image_annotator(
+ example_annotation,
+ label_list=["Person", "Vehicle"],
+ label_colors=[(0, 255, 0), (255, 0, 0)],
+ )
+ button_get = gr.Button("Get bounding boxes")
+ json_boxes = gr.JSON()
+ button_get.click(get_boxes_json, annotator, json_boxes)
+
+ with gr.Tab("Crop", id="tab_crop"):
+ with gr.Row():
+ annotator_crop = image_annotator(
+ examples_crop[0],
+ image_type="numpy",
+ disable_edit_boxes=True,
+ single_box=True,
+ )
+ image_crop = gr.Image()
+ button_crop = gr.Button("Crop")
+ button_crop.click(crop, annotator_crop, image_crop)
+
+ gr.Examples(examples_crop, annotator_crop)
+
+if __name__ == "__main__":
+ demo.launch()
+
+```
+
+## `image_annotator`
+
+### Initialization
+
+
name | +type | +default | +description | +
---|---|---|---|
value |
++ +```python +dict | None +``` + + | +None |
+A dict or None. The dictionary must contain a key 'image' with either an URL to an image, a numpy image or a PIL image. Optionally it may contain a key 'boxes' with a list of boxes. Each box must be a dict wit the keys: 'xmin', 'ymin', 'xmax' and 'ymax' with the absolute image coordinates of the box. Optionally can also include the keys 'label' and 'color' describing the label and color of the box. Color must be a tuple of RGB values (e.g. `(255,255,255)`). | +
boxes_alpha |
++ +```python +float | None +``` + + | +None |
+Opacity of the bounding boxes 0 and 1. | +
label_list |
++ +```python +list[str] | None +``` + + | +None |
+List of valid labels. | +
label_colors |
++ +```python +list[str] | None +``` + + | +None |
+Optional list of colors for each label when `label_list` is used. Colors must be a tuple of RGB values (e.g. `(255,255,255)`). | +
box_min_size |
++ +```python +int | None +``` + + | +None |
+Minimum valid bounding box size. | +
handle_size |
++ +```python +int | None +``` + + | +None |
+Size of the bounding box resize handles. | +
box_thickness |
++ +```python +int | None +``` + + | +None |
+Thickness of the bounding box outline. | +
box_selected_thickness |
++ +```python +int | None +``` + + | +None |
+Thickness of the bounding box outline when it is selected. | +
disable_edit_boxes |
++ +```python +bool | None +``` + + | +None |
+Disables the ability to set and edit the label and color of the boxes. | +
single_box |
++ +```python +bool +``` + + | +False |
+If True, at most one box can be drawn. | +
height |
++ +```python +int | str | None +``` + + | +None |
+The height of the displayed image, specified in pixels if a number is passed, or in CSS units if a string is passed. | +
width |
++ +```python +int | str | None +``` + + | +None |
+The width of the displayed image, specified in pixels if a number is passed, or in CSS units if a string is passed. | +
image_mode |
++ +```python +"1" + | "L" + | "P" + | "RGB" + | "RGBA" + | "CMYK" + | "YCbCr" + | "LAB" + | "HSV" + | "I" + | "F" +``` + + | +"RGB" |
+"RGB" if color, or "L" if black and white. See https://pillow.readthedocs.io/en/stable/handbook/concepts.html for other supported image modes and their meaning. | +
sources |
++ +```python +list["upload" | "webcam" | "clipboard"] | None +``` + + | +["upload", "webcam", "clipboard"] |
+List of sources for the image. "upload" creates a box where user can drop an image file, "webcam" allows user to take snapshot from their webcam, "clipboard" allows users to paste an image from the clipboard. If None, defaults to ["upload", "webcam", "clipboard"]. | +
image_type |
++ +```python +"numpy" | "pil" | "filepath" +``` + + | +"numpy" |
+The format the image is converted before being passed into the prediction function. "numpy" converts the image to a numpy array with shape (height, width, 3) and values from 0 to 255, "pil" converts the image to a PIL image object, "filepath" passes a str path to a temporary file containing the image. If the image is SVG, the `type` is ignored and the filepath of the SVG is returned. | +
label |
++ +```python +str | None +``` + + | +None |
+The label for this component. Appears above the component and is also used as the header if there are a table of examples for this component. If None and used in a `gr.Interface`, the label will be the name of the parameter this component is assigned to. | +
container |
++ +```python +bool +``` + + | +True |
+If True, will place the component in a container - providing some extra padding around the border. | +
scale |
++ +```python +int | None +``` + + | +None |
+relative size compared to adjacent Components. For example if Components A and B are in a Row, and A has scale=2, and B has scale=1, A will be twice as wide as B. Should be an integer. scale applies in Rows, and to top-level Components in Blocks where fill_height=True. | +
min_width |
++ +```python +int +``` + + | +160 |
+minimum pixel width, will wrap if not sufficient screen space to satisfy this value. If a certain scale value results in this Component being narrower than min_width, the min_width parameter will be respected first. | +
interactive |
++ +```python +bool | None +``` + + | +True |
+if True, will allow users to upload and annotate an image; if False, can only be used to display annotated images. | +
visible |
++ +```python +bool +``` + + | +True |
+If False, component will be hidden. | +
elem_id |
++ +```python +str | None +``` + + | +None |
+An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles. | +
elem_classes |
++ +```python +list[str] | str | None +``` + + | +None |
+An optional list of strings that are assigned as the classes of this component in the HTML DOM. Can be used for targeting CSS styles. | +
render |
++ +```python +bool +``` + + | +True |
+If False, component will not render be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later. | +
show_label |
++ +```python +bool | None +``` + + | +None |
+if True, will display label. | +
show_download_button |
++ +```python +bool +``` + + | +True |
+If True, will show a button to download the image. | +
show_share_button |
++ +```python +bool | None +``` + + | +None |
+If True, will show a share icon in the corner of the component that allows user to share outputs to Hugging Face Spaces Discussions. If False, icon does not appear. If set to None (default behavior), then the icon appears if this Gradio app is launched on Spaces, but not otherwise. | +
show_clear_button |
++ +```python +bool | None +``` + + | +True |
+If True, will show a button to clear the current image. | +
show_remove_button |
++ +```python +bool | None +``` + + | +None |
+If True, will show a button to remove the selected bounding box. | +
handles_cursor |
++ +```python +bool | None +``` + + | +True |
+If True, the cursor will change when hovering over box handles in drag mode. Can be CPU-intensive. | +