scale-nucleus 0.17.8__py3-none-any.whl → 0.17.9__py3-none-any.whl

nucleus/annotation.py

@@ -159,7 +159,7 @@ class BoxAnnotation(Annotation):  # pylint: disable=R0902
     metadata: Optional[Dict] = None
     embedding_vector: Optional[list] = None
     track_reference_id: Optional[str] = None
-    task_id: Optional[str] = None
+    _task_id: Optional[str] = field(default=None, repr=False)
 
     def __post_init__(self):
         self.metadata = self.metadata if self.metadata else {}
@@ -180,7 +180,7 @@ class BoxAnnotation(Annotation):  # pylint: disable=R0902
             metadata=payload.get(METADATA_KEY, {}),
             embedding_vector=payload.get(EMBEDDING_VECTOR_KEY, None),
             track_reference_id=payload.get(TRACK_REFERENCE_ID_KEY, None),
-            task_id=payload.get(TASK_ID_KEY, None),
+            _task_id=payload.get(TASK_ID_KEY, None),
         )
 
     def to_payload(self) -> dict:
@@ -198,7 +198,7 @@ class BoxAnnotation(Annotation):  # pylint: disable=R0902
             METADATA_KEY: self.metadata,
             EMBEDDING_VECTOR_KEY: self.embedding_vector,
             TRACK_REFERENCE_ID_KEY: self.track_reference_id,
-            TASK_ID_KEY: self.task_id,
+            TASK_ID_KEY: self._task_id,
         }
 
     def __eq__(self, other):
@@ -213,7 +213,7 @@ class BoxAnnotation(Annotation):  # pylint: disable=R0902
             and sorted(self.metadata.items()) == sorted(other.metadata.items())
             and self.embedding_vector == other.embedding_vector
             and self.track_reference_id == other.track_reference_id
-            and self.task_id == other.task_id
+            and self._task_id == other._task_id
         )
 
 
@@ -280,7 +280,7 @@ class LineAnnotation(Annotation):
     annotation_id: Optional[str] = None
     metadata: Optional[Dict] = None
     track_reference_id: Optional[str] = None
-    task_id: Optional[str] = None
+    _task_id: Optional[str] = field(default=None, repr=False)
 
     def __post_init__(self):
         self.metadata = self.metadata if self.metadata else {}
@@ -310,7 +310,7 @@ class LineAnnotation(Annotation):
             annotation_id=payload.get(ANNOTATION_ID_KEY, None),
             metadata=payload.get(METADATA_KEY, {}),
             track_reference_id=payload.get(TRACK_REFERENCE_ID_KEY, None),
-            task_id=payload.get(TASK_ID_KEY, None),
+            _task_id=payload.get(TASK_ID_KEY, None),
         )
 
     def to_payload(self) -> dict:
@@ -324,7 +324,7 @@ class LineAnnotation(Annotation):
             ANNOTATION_ID_KEY: self.annotation_id,
             METADATA_KEY: self.metadata,
             TRACK_REFERENCE_ID_KEY: self.track_reference_id,
-            TASK_ID_KEY: self.task_id,
+            TASK_ID_KEY: self._task_id,
         }
         return payload
 
@@ -375,7 +375,7 @@ class PolygonAnnotation(Annotation):
     metadata: Optional[Dict] = None
     embedding_vector: Optional[list] = None
     track_reference_id: Optional[str] = None
-    task_id: Optional[str] = None
+    _task_id: Optional[str] = field(default=None, repr=False)
 
     def __post_init__(self):
         self.metadata = self.metadata if self.metadata else {}
@@ -406,7 +406,7 @@ class PolygonAnnotation(Annotation):
             metadata=payload.get(METADATA_KEY, {}),
             embedding_vector=payload.get(EMBEDDING_VECTOR_KEY, None),
             track_reference_id=payload.get(TRACK_REFERENCE_ID_KEY, None),
-            task_id=payload.get(TASK_ID_KEY, None),
+            _task_id=payload.get(TASK_ID_KEY, None),
         )
 
     def to_payload(self) -> dict:
@@ -421,7 +421,7 @@ class PolygonAnnotation(Annotation):
             METADATA_KEY: self.metadata,
             EMBEDDING_VECTOR_KEY: self.embedding_vector,
             TRACK_REFERENCE_ID_KEY: self.track_reference_id,
-            TASK_ID_KEY: self.task_id,
+            TASK_ID_KEY: self._task_id,
         }
         return payload
 
@@ -518,7 +518,7 @@ class KeypointsAnnotation(Annotation):
     annotation_id: Optional[str] = None
     metadata: Optional[Dict] = None
     track_reference_id: Optional[str] = None
-    task_id: Optional[str] = None
+    _task_id: Optional[str] = field(default=None, repr=False)
 
     def __post_init__(self):
         self.metadata = self.metadata or {}
@@ -571,7 +571,7 @@ class KeypointsAnnotation(Annotation):
             annotation_id=payload.get(ANNOTATION_ID_KEY, None),
             metadata=payload.get(METADATA_KEY, {}),
             track_reference_id=payload.get(TRACK_REFERENCE_ID_KEY, None),
-            task_id=payload.get(TASK_ID_KEY, None),
+            _task_id=payload.get(TASK_ID_KEY, None),
         )
 
     def to_payload(self) -> dict:
@@ -587,7 +587,7 @@ class KeypointsAnnotation(Annotation):
             ANNOTATION_ID_KEY: self.annotation_id,
             METADATA_KEY: self.metadata,
             TRACK_REFERENCE_ID_KEY: self.track_reference_id,
-            TASK_ID_KEY: self.task_id,
+            TASK_ID_KEY: self._task_id,
         }
         return payload
 
@@ -692,7 +692,7 @@ class CuboidAnnotation(Annotation):  # pylint: disable=R0902
     annotation_id: Optional[str] = None
     metadata: Optional[Dict] = None
     track_reference_id: Optional[str] = None
-    task_id: Optional[str] = None
+    _task_id: Optional[str] = field(default=None, repr=False)
 
     def __post_init__(self):
         self.metadata = self.metadata if self.metadata else {}
@@ -709,7 +709,7 @@ class CuboidAnnotation(Annotation):  # pylint: disable=R0902
             annotation_id=payload.get(ANNOTATION_ID_KEY, None),
             metadata=payload.get(METADATA_KEY, {}),
             track_reference_id=payload.get(TRACK_REFERENCE_ID_KEY, None),
-            task_id=payload.get(TASK_ID_KEY, None),
+            _task_id=payload.get(TASK_ID_KEY, None),
         )
 
     def to_payload(self) -> dict:
@@ -729,7 +729,8 @@ class CuboidAnnotation(Annotation):  # pylint: disable=R0902
             payload[METADATA_KEY] = self.metadata
         if self.track_reference_id:
             payload[TRACK_REFERENCE_ID_KEY] = self.track_reference_id
-
+        if self._task_id:
+            payload[TASK_ID_KEY] = self._task_id
         return payload
 
 
@@ -942,7 +943,7 @@ class CategoryAnnotation(Annotation):
     taxonomy_name: Optional[str] = None
     metadata: Optional[Dict] = None
     track_reference_id: Optional[str] = None
-    task_id: Optional[str] = None
+    _task_id: Optional[str] = field(default=None, repr=False)
 
     def __post_init__(self):
         self.metadata = self.metadata if self.metadata else {}
@@ -955,7 +956,7 @@ class CategoryAnnotation(Annotation):
             taxonomy_name=payload.get(TAXONOMY_NAME_KEY, None),
             metadata=payload.get(METADATA_KEY, {}),
             track_reference_id=payload.get(TRACK_REFERENCE_ID_KEY, None),
-            task_id=payload.get(TASK_ID_KEY, None),
+            _task_id=payload.get(TASK_ID_KEY, None),
         )
 
     def to_payload(self) -> dict:
@@ -966,7 +967,7 @@ class CategoryAnnotation(Annotation):
             REFERENCE_ID_KEY: self.reference_id,
             METADATA_KEY: self.metadata,
             TRACK_REFERENCE_ID_KEY: self.track_reference_id,
-            TASK_ID_KEY: self.task_id,
+            TASK_ID_KEY: self._task_id,
         }
         if self.taxonomy_name is not None:
             payload[TAXONOMY_NAME_KEY] = self.taxonomy_name
@@ -982,7 +983,7 @@ class MultiCategoryAnnotation(Annotation):
     taxonomy_name: Optional[str] = None
     metadata: Optional[Dict] = None
     track_reference_id: Optional[str] = None
-    task_id: Optional[str] = None
+    _task_id: Optional[str] = field(default=None, repr=False)
 
     def __post_init__(self):
         self.metadata = self.metadata if self.metadata else {}
@@ -995,7 +996,7 @@ class MultiCategoryAnnotation(Annotation):
             taxonomy_name=payload.get(TAXONOMY_NAME_KEY, None),
             metadata=payload.get(METADATA_KEY, {}),
             track_reference_id=payload.get(TRACK_REFERENCE_ID_KEY, None),
-            task_id=payload.get(TASK_ID_KEY, None),
+            _task_id=payload.get(TASK_ID_KEY, None),
         )
 
     def to_payload(self) -> dict:
@@ -1006,7 +1007,7 @@ class MultiCategoryAnnotation(Annotation):
             REFERENCE_ID_KEY: self.reference_id,
             METADATA_KEY: self.metadata,
             TRACK_REFERENCE_ID_KEY: self.track_reference_id,
-            TASK_ID_KEY: self.task_id,
+            TASK_ID_KEY: self._task_id,
         }
         if self.taxonomy_name is not None:
             payload[TAXONOMY_NAME_KEY] = self.taxonomy_name
@@ -1045,6 +1046,7 @@ class SceneCategoryAnnotation(Annotation):
     reference_id: str
     taxonomy_name: Optional[str] = None
     metadata: Optional[Dict] = field(default_factory=dict)
+    _task_id: Optional[str] = field(default=None, repr=False)
 
     @classmethod
     def from_json(cls, payload: dict):
@@ -1053,6 +1055,7 @@ class SceneCategoryAnnotation(Annotation):
             reference_id=payload[REFERENCE_ID_KEY],
             taxonomy_name=payload.get(TAXONOMY_NAME_KEY, None),
             metadata=payload.get(METADATA_KEY, {}),
+            _task_id=payload.get(TASK_ID_KEY, None),
         )
 
     def to_payload(self) -> dict:
@@ -1062,6 +1065,7 @@ class SceneCategoryAnnotation(Annotation):
             GEOMETRY_KEY: {},
             REFERENCE_ID_KEY: self.reference_id,
             METADATA_KEY: self.metadata,
+            TASK_ID_KEY: self._task_id,
         }
         if self.taxonomy_name is not None:
             payload[TAXONOMY_NAME_KEY] = self.taxonomy_name
@@ -1079,9 +1083,7 @@ class AnnotationList:
         default_factory=list
     )
     cuboid_annotations: List[CuboidAnnotation] = field(default_factory=list)
-    category_annotations: List[CategoryAnnotation] = field(
-        default_factory=list
-    )
+    category_annotations: List[CategoryAnnotation] = field(default_factory=list)
     multi_category_annotations: List[MultiCategoryAnnotation] = field(
         default_factory=list
     )

nucleus/annotation_uploader.py

@@ -176,9 +176,7 @@ class AnnotationUploader:
         """
 
         def fn():
-            request_json = construct_segmentation_payload(
-                segmentations, update
-            )
+            request_json = construct_segmentation_payload(segmentations, update)
             form_data = [
                 FileFormField(
                     name=SERIALIZED_REQUEST_KEY,
@@ -212,15 +210,17 @@ class AnnotationUploader:
 
         return fn
 
-    @staticmethod
-    def check_for_duplicate_ids(annotations: Iterable[Annotation]):
+    def check_for_duplicate_ids(self, annotations: Iterable[Annotation]):
         """Do not allow annotations to have the same (annotation_id, reference_id, task_id) tuple"""
 
-        # some annotations like CategoryAnnotation do not have annotation_id attribute, and as such, we allow duplicates
         tuple_ids = [
-            (ann.reference_id, ann.annotation_id, ann.task_id)  # type: ignore
+            (
+                ann.reference_id,
+                ann.annotation_id,
+                getattr(ann, "_task_id", None),
+            )
             for ann in annotations
-            if hasattr(ann, "annotation_id") and hasattr(ann, "task_id")
+            if hasattr(ann, "annotation_id")
         ]
         tuple_count = Counter(tuple_ids)
         duplicates = {key for key, value in tuple_count.items() if value > 1}
@@ -255,3 +255,20 @@ class PredictionUploader(AnnotationUploader):
             self._route = (
                 f"dataset/{dataset_id}/model/{model_id}/uploadPredictions"
             )
+
+    def check_for_duplicate_ids(self, annotations: Iterable[Annotation]):
+        """Do not allow predictions to have the same (annotation_id, reference_id) tuple"""
+        tuple_ids = [
+            (pred.annotation_id, pred.reference_id)  # type: ignore
+            for pred in annotations
+            if hasattr(pred, "annotation_id") and hasattr(pred, "reference_id")
+        ]
+        tuple_count = Counter(tuple_ids)
+        duplicates = {key for key, value in tuple_count.items() if value > 1}
+        if len(duplicates) > 0:
+            raise DuplicateIDError(
+                f"Duplicate predictions with the same (annotation_id, reference_id) properties found.\n"
+                f"Duplicates: {duplicates}\n"
+                f"To fix this, avoid duplicate predictions, or specify a different annotation_id attribute "
+                f"for the failing items."
+            )

nucleus/dataset.py

@@ -332,8 +332,7 @@ class Dataset:
         dataset_item_jsons = response.get(DATASET_ITEMS_KEY, None)
 
         return [
-            DatasetItem.from_json(item_json)
-            for item_json in dataset_item_jsons
+            DatasetItem.from_json(item_json) for item_json in dataset_item_jsons
         ]
 
     @property
@@ -699,9 +698,7 @@ class Dataset:
                 asynchronous
             ), "In order to avoid timeouts, you must set asynchronous=True when uploading videos."
 
-            return self._append_video_scenes(
-                video_scenes, update, asynchronous
-            )
+            return self._append_video_scenes(video_scenes, update, asynchronous)
 
         if len(dataset_items) > WARN_FOR_LARGE_UPLOAD and not asynchronous:
             print(
@@ -2361,10 +2358,7 @@ class Dataset:
         )
 
         if len(items) > 0:
-            if (
-                len(items) > GLOB_SIZE_THRESHOLD_CHECK
-                and not skip_size_warning
-            ):
+            if len(items) > GLOB_SIZE_THRESHOLD_CHECK and not skip_size_warning:
                 raise Exception(
                     f"Found over {GLOB_SIZE_THRESHOLD_CHECK} items in {dirname}. If this is intended,"
                     f" set skip_size_warning=True when calling this function."
@@ -2411,3 +2405,26 @@ class Dataset:
             route=f"dataset/{self.id}/model/{model.id}/pointcloud/{pointcloud_ref_id}/uploadLSSPrediction",
             requests_command=requests.post,
         )
+
+    def export_class_labels(self, slice_id: Optional[str] = None):
+        """Fetches a list of class labels for the dataset.
+
+        Args:
+            slice_id (str | None): The ID of the slice to export class labels for. If None, export class labels for the entire dataset.
+
+        Returns:
+            A list of class labels for the dataset.
+        """
+        if slice_id:
+            api_payload = self._client.make_request(
+                payload=None,
+                route=f"slice/{slice_id}/class_labels",
+                requests_command=requests.get,
+            )
+        else:
+            api_payload = self._client.make_request(
+                payload=None,
+                route=f"dataset/{self.id}/class_labels",
+                requests_command=requests.get,
+            )
+        return api_payload.get("data", [])

nucleus/slice.py

@@ -168,9 +168,7 @@ class Slice:
     @property
     def pending_job_count(self) -> Optional[int]:
         if self._pending_job_count is None:
-            self._pending_job_count = self.info().get(
-                "pending_job_count", None
-            )
+            self._pending_job_count = self.info().get("pending_job_count", None)
         return self._pending_job_count
 
     @classmethod
@@ -705,6 +703,15 @@ class Slice:
         )
         return api_payload
 
+    def export_class_labels(self):
+        """Fetches a list of class labels for the slice."""
+        api_payload = self._client.make_request(
+            payload=None,
+            route=f"slice/{self.id}/class_labels",
+            requests_command=requests.get,
+        )
+        return api_payload.get("data", [])
+
 
 def check_annotations_are_in_slice(
     annotations: List[Annotation], slice_to_check: Slice

{scale_nucleus-0.17.8.dist-info → scale_nucleus-0.17.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: scale-nucleus
-Version: 0.17.8
+Version: 0.17.9
 Summary: The official Python client library for Nucleus, the Data Platform for AI
 Home-page: https://scale.com/nucleus
 License: MIT

{scale_nucleus-0.17.8.dist-info → scale_nucleus-0.17.9.dist-info}/RECORD

@@ -11,8 +11,8 @@ cli/reference.py,sha256=RuHVhmGTZNe0MfwpL96YjJdaH0OJzg98rz4xeIu4hJU,256
 cli/slices.py,sha256=nxq_Zg1m5oXuhz0ibyHkElvyVWt1AcE9tG-fN4CQxF8,1397
 cli/tests.py,sha256=NiwEVGuF08_jlCiKEIjKhwq55NvyU4xvPEJW5MJmdZg,4590
 nucleus/__init__.py,sha256=RSXlW0oL5ThX9LdRb5Eng6W9Fn_H9bqNZhAQrFQWMx8,49712
-nucleus/annotation.py,sha256=s79v-BmI3MjJiRoZCEoAeFUKn43Pghl63ZJI3P7mHc4,43803
-nucleus/annotation_uploader.py,sha256=CXvIjDNuQczGk8poNLimP7s2owRwEG7xxycMjFm0pYI,9639
+nucleus/annotation.py,sha256=0JpBMl3UA5CXL4mdiDoBK6yTpLpY7B-TRY1nYopEcNI,44229
+nucleus/annotation_uploader.py,sha256=LvK5vcP2dVWglPZZ36kofrm14DE0XGaXpNOhXBnMNn8,10400
 nucleus/async_job.py,sha256=yjPDwyyLIrF0K67anGB40xux1AMhWrq1X_hPvQ_ewzc,6890
 nucleus/async_utils.py,sha256=ayqajeSonX68fre3u8AoNRYT8GFGPd4_iu6YPQTvpvU,8226
 nucleus/autocurate.py,sha256=kI0vRqad_An8SN5JX6sSdGP_vNHJI2Pq4NINHuhNf2U,1080
@@ -26,7 +26,7 @@ nucleus/data_transfer_object/dataset_info.py,sha256=5P_gpvAyaqXxj2ZQuzLkGN2XROaN
 nucleus/data_transfer_object/dataset_size.py,sha256=oe-dXaMLpsQRDcJQRZ9Ja8JTagYz4dviZuTognEylp0,111
 nucleus/data_transfer_object/job_status.py,sha256=hxvyNdrdVdj3UpEfwvryKC_QCJQEC9ru6IPjhPFcK44,2038
 nucleus/data_transfer_object/scenes_list.py,sha256=iTHE6vA47bRB6ciyEU4LArUXEXco4ArnGvZTGTeK8xs,432
-nucleus/dataset.py,sha256=azWq0ftX2QOx2pxYDqFuwRPo48DK9I_F_AO_g3xPPIs,94663
+nucleus/dataset.py,sha256=W-QR-RDvRk369m42osZjNNbdnMVk64CzWDjLma9T9fk,95412
 nucleus/dataset_item.py,sha256=y9ia47i31lX2wvw6EkVAxeHburMrrZpuyjEGlstWa2A,10166
 nucleus/dataset_item_uploader.py,sha256=BD0FTgimEFYmDbnOLIaQZS3OLDfLe5wumADDmgMX598,6684
 nucleus/deprecation_warning.py,sha256=5C9dVusR5UkUQnW2MrRkIXCfbc8ULc7xOaB134agNKk,976
@@ -61,7 +61,7 @@ nucleus/pydantic_base.py,sha256=ZBUVrf948qzaxSuTaiDWxPC_Y8AOBdLKfi52ozGpGWk,1388
 nucleus/quaternion.py,sha256=TAnwj4arQXoTeofFgZMdZsCyxAMnu23N6to0F1WFNwk,1111
 nucleus/retry_strategy.py,sha256=daKZqjZYCh87WtXoVUuR9BZu2TTE-CtOFEYZ-d6xVMY,312
 nucleus/scene.py,sha256=qZQD7QdF6Ics8kuszsl278NCowKVnAkVNGHvPr5luRo,26937
-nucleus/slice.py,sha256=DvZQZS9HvQku9Tj7SHLaE7bv5x7Z72_4T_cio-d2hdA,28312
+nucleus/slice.py,sha256=1WZLPrfEywFY8d65ekMnduwj0RFPqWm7dgP307ajFRM,28600
 nucleus/test_launch_integration.py,sha256=oFKLZWjFGeUvwVV0XAAjP1Y_oKFkaouh_SXVPXtCvcE,10688
 nucleus/track.py,sha256=ROmOyzYZKrHVTnLBhnk-qEBtklD_EDsSnRcGYE8xG4E,3247
 nucleus/upload_response.py,sha256=wR_pfZCBju1vGiGqbVgk8zhM6GhD3ebYxyGBm8y0GvY,3287
@@ -85,8 +85,8 @@ nucleus/validate/scenario_test.py,sha256=pCmM157dblSciZCDTw-f47Fpy3OUZFgXmokdhIL
 nucleus/validate/scenario_test_evaluation.py,sha256=Q0WzaEE9uUbPVc4EHlCoKjhJcqMNt4QbyiiJx12VOR0,4075
 nucleus/validate/scenario_test_metric.py,sha256=AhVFOB1ULwBqlZ2X_Au1TXy4iQELljtzR4ZpeLB35So,1209
 nucleus/validate/utils.py,sha256=VjdIJj9Pii4z4L6xbvClAc7ra_J7cX0vWB_J2X6yrGE,185
-scale_nucleus-0.17.8.dist-info/LICENSE,sha256=jaTGyQSQIZeWMo5iyYqgbAYHR9Bdy7nOzgE-Up3m_-g,1075
-scale_nucleus-0.17.8.dist-info/METADATA,sha256=XZWcJybnh0CG0lxxioOUf7KC-s2HNpkduNqvRmxU7k0,7920
-scale_nucleus-0.17.8.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-scale_nucleus-0.17.8.dist-info/entry_points.txt,sha256=fmqEzh6NZQyg9eFMILnWabKT8OWQTMSCdDzMiVq2zYs,32
-scale_nucleus-0.17.8.dist-info/RECORD,,
+scale_nucleus-0.17.9.dist-info/LICENSE,sha256=jaTGyQSQIZeWMo5iyYqgbAYHR9Bdy7nOzgE-Up3m_-g,1075
+scale_nucleus-0.17.9.dist-info/METADATA,sha256=v7fMJK93-vcbjE68FfsV4ADjpgqRJDGB57qNeSoUhzA,7920
+scale_nucleus-0.17.9.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+scale_nucleus-0.17.9.dist-info/entry_points.txt,sha256=fmqEzh6NZQyg9eFMILnWabKT8OWQTMSCdDzMiVq2zYs,32
+scale_nucleus-0.17.9.dist-info/RECORD,,