Merge branch 'release' into 'github-master'

January Release

See merge request products/ipyannotator/ipyannotator!31

Author: ibayer

Dockerfile

@@ -45,7 +45,7 @@ RUN git clone git://github.com/yyuu/pyenv.git .pyenv
 
 RUN pyenv install 3.7.3 -f && pyenv global 3.7.3
 
-ENV POETRY_VERSION=1.0.5             \
+ENV POETRY_VERSION=1.1.0             \
     PIP_DISABLE_PIP_VERSION_CHECK=on \
     POETRY_NO_INTERACTION=1          \
     POETRY_VIRTUALENVS_CREATE=false  \

README.md

@@ -38,11 +38,39 @@ ipywidgets = "^7.5.1"
 ```
 
 
-## Run ipyannotator as stand alone web app using voila
+## Run ipyannotator as stand-alone web app using voila
 
+Dependency resolution fails if `nbdev` and `voila` libraries are both listed in the same `pyproject.toml`. This should be fixed in the next major release of `nbdev` lib. 
 
-`voila nbs/09_viola_example.ipynb --enable_nbextensions=True`
+The easiest workaround atm:
+ - install `ipyannotator` without dev dependencies 
+ - manually install `voila` into the same dev environment
 
+Using `poetry`:
+
+install:
+```shell
+cd {project_root}
+poetry install --no-dev
+poetry run pip install voila
+```
+and run simple ipyannotator standalone example:
+```shell 
+poetry run voila nbs/09_viola_example.ipynb --enable_nbextensions=True
+```
+
+  
+Same with `pip`:
+
+```shell
+   cd {project_root}
+   
+   pip install . 
+   pip install voila
+   
+   voila nbs/09_viola_example.ipynb --enable_nbextensions=True
+```
+   
 
 # Documentation
 

dev_notes.md

@@ -158,3 +158,12 @@ For clean (re)install:
 
  `nbdime extensions --enable [--sys-prefix/--user/--system]`
 
+ <HR>
+
+To automatically install `voila` together with `nbdev` an old revision can be used, however this is not included in current `pyproject.toml` file to avoid a very time consuming `git clone`, which slows down the poetry dependency resolution dramatically.
+
+```toml
+voila = { git = "https://github.com/voila-dashboards/voila.git", rev = "e23fcca926584a5aa837c3354804aa2d761edda3" }
+```
+
+Manual workaround with viola app described in `README.md`.

ipyannotator/__init__.py

@@ -1 +1 @@
-__version__ = "0.0.1"
+__version__ = "0.3.0"

ipyannotator/bbox_annotator.py

@@ -1,8 +1,8 @@
 # AUTOGENERATED! DO NOT EDIT! File to edit: nbs/04_bbox_annotator.ipynb (unless otherwise specified).
 
-__all__ = ['BBoxAnnotatorGUI', 'BBoxAnnotatorLogic', 'BBoxAnnotator']
+__all__ = ['BBoxAnnotator']
 
-# Cell
+# Internal Cell
 
 import os
 import json
@@ -18,7 +18,7 @@
 from .navi_widget import Navi
 from .storage import setup_project_paths, get_image_list_from_folder, AnnotationStorage
 
-# Cell
+# Internal Cell
 
 class BBoxAnnotatorGUI(AppLayout):
 
@@ -45,7 +45,7 @@ def __init__(self, canvas_size=(505, 50)):
     def on_client_ready(self, callback):
         self._image_box.observe_client_ready(callback)
 
-# Cell
+# Internal Cell
 
 class BBoxAnnotatorLogic(HasTraits):
     index = Int(0)
@@ -96,6 +96,14 @@ def __get_name_by_index(self, idx):
 # Cell
 
 class BBoxAnnotator(BBoxAnnotatorGUI):
+    """
+    Represents bounding box annotator.
+
+    Gives an ability to itarate through image dataset,
+    draw 2D bounding box annotations for object detection and localization,
+    export final annotations in json format
+
+    """
     debug_output = Output()
 
     def __init__(self, project_path, canvas_size=(200, 400), image_dir='pics'):

ipyannotator/bbox_canvas.py

@@ -1,8 +1,8 @@
 # AUTOGENERATED! DO NOT EDIT! File to edit: nbs/01_bbox_canvas.ipynb (unless otherwise specified).
 
-__all__ = ['draw_bg', 'draw_bounding_box', 'get_image_size', 'draw_img', 'points2bbox_coords', 'BBoxCanvas']
+__all__ = ['BBoxCanvas']
 
-# Cell
+# Internal Cell
 import numpy as np
 import traitlets
 import ipywidgets as widgets
@@ -11,14 +11,14 @@
 from ipycanvas import MultiCanvas, hold_canvas
 from ipywidgets import Image, Label, Layout, HBox, VBox, Output
 
-# Cell
+# Internal Cell
 
 def draw_bg(canvas, color='rgb(236,240,241)'):
     with hold_canvas(canvas):
         canvas.fill_style = color
         canvas.fill_rect(0, 0, canvas.size[0], canvas.size[1])
 
-# Cell
+# Internal Cell
 
 def draw_bounding_box(canvas, coords, color='white', line_width=None,
                       border_ratio=2, clear=False):
@@ -41,15 +41,15 @@ def draw_bounding_box(canvas, coords, color='white', line_width=None,
         canvas.stroke_rect(pos_x + gap, pos_y + gap, rect_x - 2 * gap,
                            rect_y - 2 * gap)
 
-# Cell
+# Internal Cell
 from PIL import Image as pilImage
 
 # can we do this without reading image?
 def get_image_size(path):
     pil_im = pilImage.open(path)
     return pil_im.width, pil_im.height
 
-# Cell
+# Internal Cell
 
 def draw_img(canvas, file, clear=False):
     # draws resized image on canvas and returns scale used
@@ -77,7 +77,7 @@ def draw_img(canvas, file, clear=False):
                           height=height_img * min(1, scale))
         return scale
 
-# Cell
+# Internal Cell
 
 def points2bbox_coords(start_x, start_y, end_x, end_y):
     min_x, max_x = sorted((start_x, end_x))
@@ -88,6 +88,11 @@ def points2bbox_coords(start_x, start_y, end_x, end_y):
 # Cell
 
 class BBoxCanvas(HBox, traitlets.HasTraits):
+    """
+    Represents canvas holding image and bbox ontop.
+    Gives user an ability to draw a bbox with mouse.
+
+    """
     debug_output = widgets.Output(layout={'border': '1px solid black'})
     image_path = traitlets.Unicode()
     bbox_coords = traitlets.Dict()
@@ -104,6 +109,8 @@ def __init__(self, width, height):
         self._bg_layer = 0
         self._image_layer = 1
         self._box_layer = 2
+        # do not stick bbox to borders
+        self.padding = 2
 
         # Define each of the children...
         self._image = Image(layout=Layout(display='flex',
@@ -122,40 +129,79 @@ def __init__(self, width, height):
         self._multi_canvas[self._box_layer].on_mouse_down(self._start_drawing)
         self._multi_canvas[self._box_layer].on_mouse_up(self._stop_drawing)
 
+
     @debug_output.capture(clear_output=False)
     def _update_pos(self, x, y):
         if self.is_drawing:
             self._canvas_bbox_coords = points2bbox_coords(*self._start_point, x, y)
+            # bbox should not cross the canvas border:
+            if self._invalid_coords(x, y):
+                print(' !! Out of canvas border !!')
+                self._stop_drawing(x, y)
+
+    def _invalid_coords(self, x, y):
+        return (self._canvas_bbox_coords["x"] + self._canvas_bbox_coords["width"] > self._multi_canvas.width - self.padding or
+                self._canvas_bbox_coords["y"] + self._canvas_bbox_coords["height"] > self._multi_canvas.height - self.padding or
+                self._canvas_bbox_coords["x"] < self.padding or
+                self._canvas_bbox_coords["y"] < self.padding)
+
 
     @debug_output.capture(clear_output=True)
     def _start_drawing(self, x, y):
+#         print("-> START DRAWING")
         self._start_point = (x, y)
         self.is_drawing = True
+#         print("<- START DRAWING")
 
     @debug_output.capture(clear_output=False)
     def _stop_drawing(self, x, y):
+#         print("-> STOP DRAWING")
         self.is_drawing = False
-        self.bbox_coords = {k: v / self._image_scale for k, v in self._canvas_bbox_coords.items()}
+
+        # if something is drawn
+        if self._canvas_bbox_coords:
+            # if bbox is not human visible, clean:
+            if (self._canvas_bbox_coords['width'] < 10 or
+                self._canvas_bbox_coords['height'] < 10):
+                self._canvas_bbox_coords = {}
+                print(" !! too small bbox drawn !!")
+            else: # otherwise, save bbox values to backend
+                self.bbox_coords = dict({ k: v / self._image_scale for k, v in self._canvas_bbox_coords.items() })
+#         print("<- STOP DRAWING")
+
 
     @traitlets.observe('bbox_coords')
     def _update_canvas_bbox_coords(self, change):
-        self._canvas_bbox_coords = {k: v * self._image_scale for k, v in self.bbox_coords.items()}
+#         print('-> Observe bbox_coords: ', change)
+
+        if change['new'] == self._canvas_bbox_coords: # change event from gui, do nothing
+            print('-> GUI')
+        else: # recalculate canvas coordinates as bbox was set by backend:
+            self._canvas_bbox_coords = {k: v * self._image_scale for k, v in self.bbox_coords.items()}
+            print('-> Backend')
+#         print('<- Observe bbox_coords')
+
 
     @traitlets.observe('_canvas_bbox_coords')
     def _draw_bbox(self, change):
+#         print('-> Observe canvas_coords: ', change)
         if not self._canvas_bbox_coords:
             self._clear_bbox()
+            self.bbox_coords = {}
             return
         coords = [self._canvas_bbox_coords['x'],
                   self._canvas_bbox_coords['y'],
                   self._canvas_bbox_coords['width'],
                   self._canvas_bbox_coords['height']]
         draw_bounding_box(self._multi_canvas[self._box_layer], coords,
                           color='white', border_ratio=2, clear=True)
+#         print('<- Observe canvas_coords')
+
 
     def _clear_bbox(self):
         self._multi_canvas[self._box_layer].clear()
 
+
     @traitlets.observe('image_path')
     def _draw_image(self, image):
         self._image_scale = draw_img(self._multi_canvas[self._image_layer], self.image_path, clear=True)

ipyannotator/capture_annotator.py

@@ -1,8 +1,8 @@
 # AUTOGENERATED! DO NOT EDIT! File to edit: nbs/06_capture_annotator.ipynb (unless otherwise specified).
 
-__all__ = ['CaptureGrid', 'CaptureAnnotatorGUI', 'CaptureAnnotatorLogic', 'CaptureAnnotator']
+__all__ = ['CaptureGrid', 'CaptureAnnotator']
 
-# Cell
+# Internal Cell
 
 from functools import partial
 import math
@@ -22,6 +22,10 @@
 # Cell
 
 class CaptureGrid(GridBox, HasTraits):
+    """
+    Represents grid of `ImageButtons` with state.
+
+    """
     debug_output = Output(layout={'border': '1px solid black'})
     current_state = Dict()
 
@@ -92,7 +96,7 @@ def register_on_click(self):
             l.reset_callbacks()
             l.on_click(partial(self.callback, name=l.name))
 
-# Cell
+# Internal Cell
 
 class CaptureAnnotatorGUI(AppLayout):
     def __init__(self, image_width=150, image_height=150,
@@ -137,7 +141,7 @@ def __init__(self, image_width=150, image_height=150,
                  pane_heights=(1, 4, 1))
 
 
-# Cell
+# Internal Cell
 
 class CaptureAnnotatorLogic(HasTraits):
     debug_output = Output(layout={'border': '1px solid black'})
@@ -223,6 +227,14 @@ def _select_none(self, change=None):
 
 
 class CaptureAnnotator(CaptureAnnotatorGUI):
+    """
+    Represents capture annotator.
+
+    Gives an ability to itarate through image dataset,
+    select images of same class,
+    export final annotations in json format
+
+    """
 
     def __init__(self, project_path, image_dir='pics', image_width=150, image_height=150,
                  n_rows=3, n_cols=3, question=None, filter_files=None):