[PLT-448] Added coco deprecation message (#1574)

Author: Gabefire

libs/labelbox/src/labelbox/data/serialization/coco/annotation.py

@@ -1,8 +1,16 @@
-from typing import Tuple, List, Union
+from typing import Any, Tuple, List, Union
 from pathlib import Path
 from collections import defaultdict
+import warnings
 
-from labelbox import pydantic_compat
+from ...annotation_types.relationship import RelationshipAnnotation
+from ...annotation_types.metrics.confusion_matrix import ConfusionMatrixMetric
+from ...annotation_types.metrics.scalar import ScalarMetric
+from ...annotation_types.video import VideoMaskAnnotation
+from ...annotation_types.annotation import ObjectAnnotation
+from ...annotation_types.classification.classification import ClassificationAnnotation
+
+from .... import pydantic_compat
 import numpy as np
 
 from .path import PathSerializerMixin
@@ -18,11 +26,20 @@ def rle_decoding(rle_arr: List[int], w: int, h: int) -> np.ndarray:
     return mask.reshape((w, h)).T
 
 
-def get_annotation_lookup(annotations):
+def get_annotation_lookup(
+    annotations: List[Union[ClassificationAnnotation, ObjectAnnotation,
+                            VideoMaskAnnotation, ScalarMetric,
+                            ConfusionMatrixMetric, RelationshipAnnotation]]
+) -> defaultdict[Any, list]:
+    """Get annotations from Label.annotations objects
+
+    Args:
+        annotations (Label.annotations): Annotations attached to labelbox Label object used as private method
+    """
     annotation_lookup = defaultdict(list)
     for annotation in annotations:
         annotation_lookup[getattr(annotation, 'image_id', None) or
-                          getattr(annotation, 'name')].append(annotation)
+                          getattr(annotation, 'name', None)].append(annotation)
     return annotation_lookup
 
 

libs/labelbox/src/labelbox/data/serialization/coco/categories.py

@@ -1,7 +1,7 @@
 import sys
 from hashlib import md5
 
-from labelbox import pydantic_compat
+from .... import pydantic_compat
 
 
 class Categories(pydantic_compat.BaseModel):

libs/labelbox/src/labelbox/data/serialization/coco/converter.py

@@ -1,10 +1,11 @@
 from typing import Dict, Any, Union
 from pathlib import Path
 import os
+import warnings
 
-from labelbox.data.annotation_types.collection import LabelCollection, LabelGenerator
-from labelbox.data.serialization.coco.instance_dataset import CocoInstanceDataset
-from labelbox.data.serialization.coco.panoptic_dataset import CocoPanopticDataset
+from ...annotation_types.collection import LabelCollection, LabelGenerator
+from ...serialization.coco.instance_dataset import CocoInstanceDataset
+from ...serialization.coco.panoptic_dataset import CocoPanopticDataset
 
 
 def create_path_if_not_exists(path: Union[Path, str],
@@ -28,7 +29,7 @@ def validate_path(path: Union[Path, str], name: str):
 
 class COCOConverter:
     """
-    Class for convertering between coco and labelbox formats
+    Class for converting between coco and labelbox formats
     Note that this class is only compatible with image data.
 
     Subclasses are currently ignored.
@@ -55,6 +56,12 @@ def serialize_instances(labels: LabelCollection,
         Returns:
             A dictionary containing labels in the coco object format.
         """
+
+        warnings.warn(
+            "You are currently utilizing COCOconverter for this action, which will be deprecated in a later release.",
+            DeprecationWarning,
+            stacklevel=2)
+
         image_root = create_path_if_not_exists(image_root, ignore_existing_data)
         return CocoInstanceDataset.from_common(labels=labels,
                                                image_root=image_root,
@@ -85,6 +92,12 @@ def serialize_panoptic(labels: LabelCollection,
         Returns:
             A dictionary containing labels in the coco panoptic format.
         """
+
+        warnings.warn(
+            "You are currently utilizing COCOconverter for this action, which will be deprecated in a later release.",
+            DeprecationWarning,
+            stacklevel=2)
+
         image_root = create_path_if_not_exists(image_root, ignore_existing_data)
         mask_root = create_path_if_not_exists(mask_root, ignore_existing_data)
         return CocoPanopticDataset.from_common(labels=labels,
@@ -107,6 +120,12 @@ def deserialize_panoptic(json_data: Dict[str, Any], image_root: Union[Path,
         Returns:
             LabelGenerator
         """
+
+        warnings.warn(
+            "You are currently utilizing COCOconverter for this action, which will be deprecated in a later release.",
+            DeprecationWarning,
+            stacklevel=2)
+
         image_root = validate_path(image_root, 'image_root')
         mask_root = validate_path(mask_root, 'mask_root')
         objs = CocoPanopticDataset(**json_data)
@@ -125,6 +144,12 @@ def deserialize_instances(json_data: Dict[str, Any],
         Returns:
             LabelGenerator
         """
+
+        warnings.warn(
+            "You are currently utilizing COCOconverter for this action, which will be deprecated in a later release.",
+            DeprecationWarning,
+            stacklevel=2)
+
         image_root = validate_path(image_root, 'image_root')
         objs = CocoInstanceDataset(**json_data)
         gen = objs.to_common(image_root)

libs/labelbox/src/labelbox/data/serialization/coco/image.py

@@ -5,7 +5,7 @@
 import imagesize
 
 from .path import PathSerializerMixin
-from labelbox.data.annotation_types import Label
+from ...annotation_types import Label
 
 
 class CocoImage(PathSerializerMixin):

libs/labelbox/src/labelbox/data/serialization/coco/instance_dataset.py

@@ -6,7 +6,7 @@
 
 import numpy as np
 from tqdm import tqdm
-from labelbox import pydantic_compat
+from .... import pydantic_compat
 
 from ...annotation_types import ImageData, MaskData, Mask, ObjectAnnotation, Label, Polygon, Point, Rectangle
 from ...annotation_types.collection import LabelCollection