Merge pull request #205 from Labelbox/ms/annotation-examples

annotation examples

Author: msokoloff1

examples/annotation_types/annotation_type_basics.ipynb

@@ -22,7 +22,7 @@ class RasterData(BaseData):
 
     @classmethod
     def from_2D_arr(cls, arr: TypedArray[Literal['uint8']], **kwargs):
-        if len(arr.shape):
+        if len(arr.shape) != 2:
             raise ValueError(
                 f"Found array with shape {arr.shape}. Expected two dimensions ([W,H])"
             )

examples/annotation_types/converters.ipynb

@@ -148,7 +148,6 @@ def to_common(self) -> Label:
         else:
             annotations = self.label.to_common()
             data = self._infer_media_type()
-            print(data)
 
         return Label(data=data,
                      annotations=annotations,

examples/annotation_types/label_containers.ipynb

@@ -10,7 +10,6 @@
 import ndjson
 import requests
 from pydantic import BaseModel, validator
-from requests.api import request
 from typing_extensions import Literal
 from typing import (Any, List, Optional, BinaryIO, Dict, Iterable, Tuple, Union,
                     Type, Set)

examples/annotation_types/mal_with_annotation_types.ipynb

@@ -4,7 +4,7 @@
 
 from typing import Any, Dict, List, Optional, Union
 
-from labelbox.schema.project import Project
+from labelbox.schema import project
 from labelbox.orm.db_object import DbObject
 from labelbox.orm.model import Field, Relationship
 from labelbox.exceptions import InconsistentOntologyException
@@ -330,7 +330,7 @@ def _update_colors(self):
                 self.tools[index].color = '#%02x%02x%02x' % rgb_color
 
     @classmethod
-    def from_project(cls, project: Project):
+    def from_project(cls, project: "project.Project"):
         ontology = project.ontology().normalized
         return cls.from_dict(ontology)
 

labelbox/data/annotation_types/data/raster.py

@@ -17,6 +17,7 @@
 from labelbox.orm.db_object import DbObject, Updateable, Deletable
 from labelbox.orm.model import Entity, Field, Relationship
 from labelbox.pagination import PaginatedCollection
+from labelbox.data.serialization import LBV1Converter
 
 try:
     datetime.fromisoformat  # type: ignore[attr-defined]
@@ -166,7 +167,33 @@ def export_queued_data_rows(self, timeout_seconds=120):
                 self.uid)
             time.sleep(sleep_time)
 
-    def export_labels(self, timeout_seconds=60):
+    def video_label_generator(self, timeout_seconds=60):
+        """
+        Download video annotations
+
+        Returns:
+            LabelGenerator for accessing labels for each video
+        """
+        json_data = self.export_labels(download=True,
+                                       timeout_seconds=timeout_seconds)
+        if 'frames' not in json_data[0]['Label']:
+            raise ValueError(
+                "frames key not found in the first label. Cannot export video data."
+            )
+        return LBV1Converter.deserialize_video(json_data, self.client)
+
+    def label_generator(self, timeout_seconds=60):
+        """
+        Download text and image annotations
+
+        Returns:
+            LabelGenerator for accessing labels for each text or image
+        """
+        json_data = self.export_labels(download=True,
+                                       timeout_seconds=timeout_seconds)
+        return LBV1Converter.deserialize(json_data)
+
+    def export_labels(self, download=False, timeout_seconds=60):
         """ Calls the server-side Label exporting that generates a JSON
         payload, and returns the URL to that payload.
 
@@ -188,7 +215,13 @@ def export_labels(self, timeout_seconds=60):
             res = self.client.execute(query_str, {id_param: self.uid})
             res = res["exportLabels"]
             if not res["shouldPoll"]:
-                return res["downloadUrl"]
+                url = res['downloadUrl']
+                if not download:
+                    return url
+                else:
+                    response = requests.get(url)
+                    response.raise_for_status()
+                    return response.json()
 
             timeout_seconds -= sleep_time
             if timeout_seconds <= 0:

labelbox/data/serialization/labelbox_v1/label.py

@@ -1,7 +1,7 @@
-from labelbox.schema.project import Project
 from labelbox.orm.db_object import DbObject
 from labelbox.orm.model import Field, Relationship
 from labelbox.schema.role import Role
+from labelbox.schema.project import Project
 
 
 class User(DbObject):
@@ -41,7 +41,7 @@ class User(DbObject):
     org_role = Relationship.ToOne("OrgRole", False)
 
     def update_org_role(self, role: Role):
-        """ Updated the `User`s organization role. 
+        """ Updated the `User`s organization role.
 
         See client.get_roles() to get all valid roles
         If you a user is converted from project level permissions to org level permissions and then convert back, their permissions will remain for each individual project
@@ -52,7 +52,7 @@ def update_org_role(self, role: Role):
         """
         user_id_param = "userId"
         role_id_param = "roleId"
-        query_str = """mutation SetOrganizationRolePyApi($%s: ID!, $%s: ID!) { 
+        query_str = """mutation SetOrganizationRolePyApi($%s: ID!, $%s: ID!) {
             setOrganizationRole(data: {userId: $userId, roleId: $roleId}) { id name }}
         """ % (user_id_param, role_id_param)
 
@@ -61,7 +61,7 @@ def update_org_role(self, role: Role):
             role_id_param: role.uid
         })
 
-    def remove_from_project(self, project: Project):
+    def remove_from_project(self, project: "Project"):
         """ Removes a User from a project. Only used for project based users.
         Project based user means their org role is "NONE"
 
@@ -71,13 +71,13 @@ def remove_from_project(self, project: Project):
         """
         self.upsert_project_role(project, self.client.get_roles()['NONE'])
 
-    def upsert_project_role(self, project: Project, role: Role):
+    def upsert_project_role(self, project: "Project", role: Role):
         """ Updates or replaces a User's role in a project.
 
         Args:
             project (Project): The project to update the users permissions for
             role (Role): The role to assign to this user in this project.
-        
+
         """
         org_role = self.org_role()
         if org_role.name.upper() != 'NONE':