Merge pull request #244 from Labelbox/ms/minor-updates

rename to raster to draw

Author: msokoloff1

CHANGELOG.md

@@ -1,5 +1,57 @@
 # Changelog
 
+# Version 3.0.0 (2021-08-12)
+## Added
+* Annotation types
+    - A set of python objects for working with labelbox data
+    - Creates a standard interface for both exports and imports
+    - See example notebooks on how to use under examples/annotation_types
+    - Note that these types are not yet supported for tiled imagery
+* MEA Support
+    - Beta MEA users can now just use the latest SDK release
+* Metadata support
+    - New metadata features are now fully supported by the SDK
+* Easier export
+    - `project.export_labels()` accepts a boolean indicating whether or not to download the result
+    - Create annotation objects directly from exports with `project.label_generator()` or `project.video_label_generator()`
+    - `project.video_label_generator()` asynchronously fetches video annotations
+* Retry logic on data uploads
+    - Bulk creation of data rows will be more reliable
+* Datasets
+    - Determine the number of data rows just by calling `dataset.row_count`.
+    - Updated threading logic in create_data_rows() to make it compatible with aws lambdas
+* Ontology
+    - `OntologyBuilder`, `Classification`, `Option`, and `Tool` can now be imported from `labelbox` instead of `labelbox.schema.ontology`
+
+## Removed
+* Deprecated:
+    - `project.reviews()`
+    - `project.create_prediction()`
+    - `project.create_prediction_model()`
+    - `project.create_label()`
+    - `Project.predictions()`
+    - `Project.active_prediction_model`
+    - `data_row.predictions`
+    - `PredictionModel`
+    - `Prediction`
+* Replaced:
+    - `data_row.metadata()` use `data_row.attachments()` instead
+    - `data_row.create_metadata()` use `data_row.create_attachments()` instead
+    - `AssetMetadata` use `AssetAttachment` instead
+
+## Fixes
+* Support derived classes of ontology objects when using `from_dict`
+* Notebooks:
+    - Video export bug where the code would fail if the exported projects had tools other than bounding boxes
+    - MAL demos were broken due to an image download failing.
+
+## Misc
+* Data processing dependencies are not installed by default to for users that only want client functionality.
+* To install all dependencies required for the data modules (annotation types and mea metric calculation) use `pip install labelbox[data]`
+* Decrease wait time between updates for `BulkImportRequest.wait_until_done()`.
+* Organization is no longer used to create the LFO in `Project.setup()`
+
+
 # Version 3.0.0-rc3 (2021-08-11)
 ## Updates
 * Geometry.raster now has a consistent interface and improved functionality

examples/annotation_types/basics.ipynb

@@ -652,7 +652,7 @@
     "##### Geometry Utilities\n",
     "* All of the previous objects except TextEntity inherit from the Geometry base class\n",
     "* They have the following properties and functions\n",
-    "    1. raster(height width, kwargs)\n",
+    "    1. draw(height width, kwargs)\n",
     "    2. shape - property\n",
     "    3. geometry - property"
    ]
@@ -714,7 +714,7 @@
    "outputs": [],
    "source": [
     "color = (255,255,255)\n",
-    "np_mask = polygon_annotation.value.raster(height = im.size[1], width = im.size[0], color = color)\n",
+    "np_mask = polygon_annotation.value.draw(height = im.size[1], width = im.size[0], color = color)\n",
     "Image.fromarray(np.hstack([np_mask, np_data]))"
    ]
   },
@@ -767,9 +767,9 @@
     "    Polygon(points = [Point(x=x,y=y) for x,y in [[82, 180], [83, 184], [88, 184], [86, 180]]]),\n",
     "    Polygon(points = [Point(x=x,y=y) for x,y in [[97, 182], [99, 184], [102, 183], [101, 180], [98, 180]]]),    \n",
     "]\n",
-    "eye_masks = np.max([eye.raster(height = h, width = w) for eye in eyes], axis = 0)\n",
+    "eye_masks = np.max([eye.draw(height = h, width = w) for eye in eyes], axis = 0)\n",
     "nose = Polygon(points =[ Point(x=x,y=y) for x,y in [[95, 192], [93, 197], [96, 198], [100, 197], [100, 194], [100, 192], [96, 192]]])\n",
-    "nose_mask = nose.raster(height = h, width = w, color = nose_color)\n",
+    "nose_mask = nose.draw(height = h, width = w, color = nose_color)\n",
     "# Picks the brighter color if there is overlap. \n",
     "# If you don't want overlap then just simply create separate masks\n",
     "np_seg_mask = np.max([nose_mask, eye_masks], axis = 0)\n",
@@ -801,7 +801,7 @@
    "id": "swiss-storm",
    "metadata": {},
    "source": [
-    "* Calling `mask.raster()` will return a mask with pixels equal to the specified color"
+    "* Calling `mask.draw()` will return a mask with pixels equal to the specified color"
    ]
   },
   {
@@ -811,8 +811,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "eye_raster = eye_mask.raster()\n",
-    "nose_raster = nose_mask.raster()\n",
+    "eye_raster = eye_mask.draw()\n",
+    "nose_raster = nose_mask.draw()\n",
     "Image.fromarray(np.hstack([eye_raster,nose_raster, np_data]))"
    ]
   },

examples/annotation_types/converters.ipynb

@@ -367,7 +367,7 @@
     "            \n",
     "        for annotation in annotation_lookup[idx]:\n",
     "            if isinstance(annotation.value, Rectangle):\n",
-    "                frame = annotation.value.raster(canvas = frame.astype(np.uint8), thickness = 10, color= (255,0,0))\n",
+    "                frame = annotation.value.draw(canvas = frame.astype(np.uint8), thickness = 10, color= (255,0,0))\n",
     "                \n",
     "        im = Image.fromarray(frame)\n",
     "        w,h = im.size\n",
@@ -439,7 +439,7 @@
     "canvas = np.zeros((h, w, 3), dtype = np.uint8)\n",
     "for annotation in label_list[0].annotations:\n",
     "    if isinstance(annotation.value, Geometry):\n",
-    "        canvas = annotation.value.raster(canvas = canvas)\n",
+    "        canvas = annotation.value.draw(canvas = canvas)\n",
     "Image.fromarray(canvas)"
    ]
   },

examples/annotation_types/label_containers.ipynb

@@ -132,10 +132,10 @@
     "    im_h, im_w = 300, 200\n",
     "    image_url = \"https://picsum.photos/id/1003/200/300\"\n",
     "    nose_color, eye_color = (0,255,0), (255,0,0)\n",
-    "    nose_mask = Point(x = 96, y = 194).raster(im_h, im_w, thickness = 3)\n",
+    "    nose_mask = Point(x = 96, y = 194).draw(im_h, im_w, thickness = 3)\n",
     "    eye_masks = [\n",
-    "         Point(x = 84, y = 182).raster(im_h, im_w, thickness = 3),\n",
-    "        Point(x = 99, y = 181).raster(im_h, im_w, thickness = 3),\n",
+    "         Point(x = 84, y = 182).draw(im_h, im_w, thickness = 3),\n",
+    "        Point(x = 99, y = 181).draw(im_h, im_w, thickness = 3),\n",
     "    ]\n",
     "    mask_arr = np.max([*eye_masks,nose_mask] , axis = 0)\n",
     "    mask = MaskData(arr = mask_arr)\n",

examples/label_export/images.ipynb

@@ -165,7 +165,7 @@
     "# Draw the annotations onto the source image\n",
     "for annotation in label.annotations:\n",
     "    if isinstance(annotation.value, Geometry):\n",
-    "        image_np = annotation.value.raster(canvas = image_np, color = colors[annotation.name], thickness = 5)\n",
+    "        image_np = annotation.value.draw(canvas = image_np, color = colors[annotation.name], thickness = 5)\n",
     "Image.fromarray(image_np.astype(np.uint8))"
    ]
   },

labelbox/__init__.py

@@ -1,5 +1,5 @@
 name = "labelbox"
-__version__ = "3.0.0-rc3"
+__version__ = "3.0.0"
 
 from labelbox.schema.project import Project
 from labelbox.client import Client

labelbox/data/annotation_types/geometry/geometry.py

@@ -35,10 +35,10 @@ def geometry(self) -> geojson:
         pass
 
     @abstractmethod
-    def raster(self,
-               height: Optional[int] = None,
-               width: Optional[int] = None,
-               canvas: Optional[np.ndarray] = None,
-               color: Optional[Union[int, Tuple[int, int, int]]] = None,
-               thickness: Optional[int] = 1) -> np.ndarray:
+    def draw(self,
+             height: Optional[int] = None,
+             width: Optional[int] = None,
+             canvas: Optional[np.ndarray] = None,
+             color: Optional[Union[int, Tuple[int, int, int]]] = None,
+             thickness: Optional[int] = 1) -> np.ndarray:
         pass

labelbox/data/annotation_types/geometry/line.py

@@ -16,12 +16,12 @@ def geometry(self) -> geojson.MultiLineString:
         return geojson.MultiLineString(
             [[[point.x, point.y] for point in self.points]])
 
-    def raster(self,
-               height: Optional[int] = None,
-               width: Optional[int] = None,
-               canvas: Optional[np.ndarray] = None,
-               color: Union[int, Tuple[int, int, int]] = (255, 255, 255),
-               thickness: int = 1) -> np.ndarray:
+    def draw(self,
+             height: Optional[int] = None,
+             width: Optional[int] = None,
+             canvas: Optional[np.ndarray] = None,
+             color: Union[int, Tuple[int, int, int]] = (255, 255, 255),
+             thickness: int = 1) -> np.ndarray:
         """
         Draw the line onto a 3d mask
         Args:

labelbox/data/annotation_types/geometry/mask.py

@@ -11,32 +11,28 @@
 
 
 class Mask(Geometry):
-    # Raster data can be shared across multiple masks... or not
+    # Mask data can be shared across multiple masks
     mask: MaskData
-    # RGB or Grayscale
     color: Tuple[int, int, int]
 
     @property
     def geometry(self):
-        mask = self.raster(color=1)
+        mask = self.draw(color=1)
         polygons = (
             shape(shp)
             for shp, val in shapes(mask, mask=None)
             # ignore if shape is area of smaller than 1 pixel
             if val >= 1)
         return MultiPolygon(polygons).__geo_interface__
 
-    def raster(self,
-               height: Optional[int] = None,
-               width: Optional[int] = None,
-               canvas: Optional[np.ndarray] = None,
-               color: Optional[Union[int, Tuple[int, int, int]]] = None,
-               thickness=None) -> np.ndarray:
+    def draw(self,
+             height: Optional[int] = None,
+             width: Optional[int] = None,
+             canvas: Optional[np.ndarray] = None,
+             color: Optional[Union[int, Tuple[int, int, int]]] = None,
+             thickness=None) -> np.ndarray:
         """
-        # TODO: Optionally use the color. a color of 1 will result in a binary canvas
-
-
-        Removes all pixels from the segmentation mask that do not equal self.color
+        Converts the Mask object into a numpy array
 
         Args:
             height (int): Optionally resize mask height before drawing.

labelbox/data/annotation_types/geometry/point.py

@@ -15,12 +15,12 @@ class Point(Geometry):
     def geometry(self) -> geojson.Point:
         return geojson.Point([self.x, self.y])
 
-    def raster(self,
-               height: Optional[int] = None,
-               width: Optional[int] = None,
-               canvas: Optional[np.ndarray] = None,
-               color: Union[int, Tuple[int, int, int]] = (255, 255, 255),
-               thickness: int = 10) -> np.ndarray:
+    def draw(self,
+             height: Optional[int] = None,
+             width: Optional[int] = None,
+             canvas: Optional[np.ndarray] = None,
+             color: Union[int, Tuple[int, int, int]] = (255, 255, 255),
+             thickness: int = 10) -> np.ndarray:
         """
         Draw the point onto a 3d mask
         Args: