scale-nucleus 0.17.6__py3-none-any.whl → 0.17.6b0__py3-none-any.whl

nucleus/dataset.py

@@ -997,9 +997,9 @@ class Dataset:
             raise Exception("Must provide at least one list of internal IDs")
         payload = {
             NAME_KEY: name,
-            DATASET_ITEM_IDS_KEY: dataset_item_ids
-            if dataset_item_ids
-            else None,
+            DATASET_ITEM_IDS_KEY: (
+                dataset_item_ids if dataset_item_ids else None
+            ),
             SCENE_IDS_KEY: scene_ids if scene_ids else None,
             OBJECT_IDS_KEY: [*(annotation_ids or []), *(prediction_ids or [])]
             or None,
@@ -1449,16 +1449,34 @@ class Dataset:
         )
         return convert_export_payload(api_payload[EXPORTED_ROWS])
 
-    def scene_and_annotation_generator(self, page_size=10):
-        """Provides a generator of all DatasetItems and Annotations in the dataset grouped by scene.
+    def scene_and_annotation_generator(self, page_size: int = 10):
+        """Provides a generator of all Scenes and Annotations in the dataset grouped by scene.
 
+        Args:
+            page_size: Number of scenes to fetch per page. Default is 10.
 
         Returns:
-            Generator where each element is a nested dict (representing a JSON) structured in the following way:
+            Generator where each element is a nested dict containing scene and annotation information of the dataset structured as a JSON.
+
+            Track grouping is slightly more complicated and is done in the following order:
+            1. If track_id is defined in the annotations table, use it as the track id.
+            2. If track_reference_id is defined in the metadata field of the annotations table, use it as the track id.
+            3. If track_id is defined in the metadata field of the annotations table, use it as the track id.
+            4. If track_id is not defined and annotation_id is defined, use annotation_id as track id.
+            5. If annotation_id grouping is unsuccessful such that the annotation id is unique across all frames in the scene for all annotations, throw an error that the annotation format is incompatible.
+            6. If there is no track or annotation id, throw an error that the annotation format is incompatible.
+
+            If you use the generator and discover that no scenes were generated, check the response error message for more information. It is likely that the annotations are not in the correct format.
 
+            ::
             Iterable[{
-                "file_location": str,
-                "metadata": Dict[str, Any],
+                "scene": {
+                    "id": str,
+                    "reference_id": str,
+                    "metadata": Dict[str, Any]
+                    "type": str,
+                    "fileLocation": str,
+                }
                 "annotations": {
                     "{trackId}": {
                         "label": str,

{scale_nucleus-0.17.6.dist-info → scale_nucleus-0.17.6b0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: scale-nucleus
-Version: 0.17.6
+Version: 0.17.6b0
 Summary: The official Python client library for Nucleus, the Data Platform for AI
 Home-page: https://scale.com/nucleus
 License: MIT
@@ -14,6 +14,7 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Provides-Extra: launch
 Provides-Extra: metrics
 Requires-Dist: Pillow (>=7.1.2)

{scale_nucleus-0.17.6.dist-info → scale_nucleus-0.17.6b0.dist-info}/RECORD

@@ -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=ekYreXpUY2kUyKJLJEopNXfezc0u9EzQyWlAYAtt3-8,92751
+nucleus/dataset.py,sha256=pmtUpYKWgSReT-lxA1dODCL3VzY_8Tq7yuyNWL7CkUk,94080
 nucleus/dataset_item.py,sha256=y9ia47i31lX2wvw6EkVAxeHburMrrZpuyjEGlstWa2A,10166
 nucleus/dataset_item_uploader.py,sha256=BD0FTgimEFYmDbnOLIaQZS3OLDfLe5wumADDmgMX598,6684
 nucleus/deprecation_warning.py,sha256=5C9dVusR5UkUQnW2MrRkIXCfbc8ULc7xOaB134agNKk,976
@@ -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.6.dist-info/LICENSE,sha256=jaTGyQSQIZeWMo5iyYqgbAYHR9Bdy7nOzgE-Up3m_-g,1075
-scale_nucleus-0.17.6.dist-info/METADATA,sha256=HHN0a8wl3wVYBELMNFiG5uQ1-59ke402OCTm_dkty6Q,7920
-scale_nucleus-0.17.6.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-scale_nucleus-0.17.6.dist-info/entry_points.txt,sha256=fmqEzh6NZQyg9eFMILnWabKT8OWQTMSCdDzMiVq2zYs,32
-scale_nucleus-0.17.6.dist-info/RECORD,,
+scale_nucleus-0.17.6b0.dist-info/LICENSE,sha256=jaTGyQSQIZeWMo5iyYqgbAYHR9Bdy7nOzgE-Up3m_-g,1075
+scale_nucleus-0.17.6b0.dist-info/METADATA,sha256=U4EVzUIyio7za63G_XZz43WJ81rR_io-IfZHAWlqllo,7973
+scale_nucleus-0.17.6b0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+scale_nucleus-0.17.6b0.dist-info/entry_points.txt,sha256=fmqEzh6NZQyg9eFMILnWabKT8OWQTMSCdDzMiVq2zYs,32
+scale_nucleus-0.17.6b0.dist-info/RECORD,,

{scale_nucleus-0.17.6.dist-info → scale_nucleus-0.17.6b0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.6.1
+Generator: poetry-core 1.9.0
 Root-Is-Purelib: true
 Tag: py3-none-any