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

nucleus/dataset.py

@@ -104,7 +104,7 @@ from .slice import (
 from .upload_response import UploadResponse
 
 if TYPE_CHECKING:
-    from . import NucleusClient
+    from . import Model, NucleusClient
 
 # TODO: refactor to reduce this file to under 1000 lines.
 # pylint: disable=C0302
@@ -1449,6 +1449,49 @@ 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.
+
+
+        Returns:
+            Generator where each element is a nested dict (representing a JSON) structured in the following way:
+
+            Iterable[{
+                "file_location": str,
+                "metadata": Dict[str, Any],
+                "annotations": {
+                    "{trackId}": {
+                        "label": str,
+                        "name": str,
+                        "frames": List[{
+                            "left": int,
+                            "top": int,
+                            "width": int,
+                            "height": int,
+                            "key": str, # frame key
+                            "metadata": Dict[str, Any]
+                        }]
+                    }
+                }
+            }]
+
+            This is similar to how the Scale API returns task data
+        """
+
+        if page_size > 30:
+            raise ValueError("Page size must be less than or equal to 30")
+
+        endpoint_name = "exportForTrainingByScene"
+        json_generator = paginate_generator(
+            client=self._client,
+            endpoint=f"dataset/{self.id}/{endpoint_name}",
+            result_key=EXPORT_FOR_TRAINING_KEY,
+            page_size=page_size,
+        )
+
+        for data in json_generator:
+            yield data
+
     def items_and_annotation_generator(
         self,
         query: Optional[str] = None,
@@ -2303,3 +2346,41 @@ class Dataset:
 
         else:
             print(f"Did not find any items in {dirname}.")
+
+    def upload_lidar_semseg_predictions(
+        self,
+        model: "Model",
+        pointcloud_ref_id: str,
+        predictions_s3_path: str,
+    ):
+        """Upload Lidar Semantic Segmentation predictions for a given point-cloud.
+
+        Assuming a point-cloud with only 4 points (three labeled as Car, one labeled as Person),
+        the contents of the predictions s3 object should be formatted as such:
+
+        .. code-block:: json
+
+            {
+                "objects": [
+                    { "label": "Car", "index": 1},
+                    { "label": "Person", "index": 2}
+                ],
+                "point_objects": [1, 1, 1, 2],
+                "point_confidence": [0.5, 0.9, 0.9, 0.3]
+            }
+
+        The order of the points in the `"point_objects"` should be in the same order as the points that
+        were originally uploaded to Scale.
+
+        Parameters:
+            model (:class:`Model`): Nucleus model used to store these predictions
+            pointcloud_ref_id (str): The reference ID of the pointcloud for which these predictions belong to
+            predictions_s3_path (str): S3 path to where the predictions are stored
+
+        """
+
+        return self._client.make_request(
+            payload={"pointsSegmentationUrl": predictions_s3_path},
+            route=f"dataset/{self.id}/model/{model.id}/pointcloud/{pointcloud_ref_id}/uploadLSSPrediction",
+            requests_command=requests.post,
+        )

nucleus/model.py

@@ -211,7 +211,9 @@ class Model:
         )
         return AsyncJob.from_json(response, self._client)
 
-    def run(self, dataset_id: str, slice_id: Optional[str]) -> str:
+    def run(
+        self, dataset_id: str, model_run_name: str, slice_id: Optional[str]
+    ) -> str:
         """Runs inference on the bundle associated with the model on the dataset. ::
 
             import nucleus
@@ -222,11 +224,18 @@ class Model:
 
         Args:
             dataset_id: The ID of the dataset to run inference on.
-            job_id: The ID of the :class:`AsyncJob` used to track job progress.
+            model_run_name: The name of the model run.
             slice_id: The ID of the slice of the dataset to run inference on.
+
+        Returns:
+            job_id: The ID of the :class:`AsyncJob` used to track job progress.
         """
         response = self._client.make_request(
-            {"dataset_id": dataset_id, "slice_id": slice_id},
+            {
+                "dataset_id": dataset_id,
+                "slice_id": slice_id,
+                "model_run_name": model_run_name,
+            },
             f"model/run/{self.id}/",
             requests_command=requests.post,
         )

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: scale-nucleus
-Version: 0.17.3
+Version: 0.17.6
 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.3.dist-info → scale_nucleus-0.17.6.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=LdhT-wGToWySUEZBgLSdXiNxSIIfeNeoh6IWRLKmBbQ,89824
+nucleus/dataset.py,sha256=ekYreXpUY2kUyKJLJEopNXfezc0u9EzQyWlAYAtt3-8,92751
 nucleus/dataset_item.py,sha256=y9ia47i31lX2wvw6EkVAxeHburMrrZpuyjEGlstWa2A,10166
 nucleus/dataset_item_uploader.py,sha256=BD0FTgimEFYmDbnOLIaQZS3OLDfLe5wumADDmgMX598,6684
 nucleus/deprecation_warning.py,sha256=5C9dVusR5UkUQnW2MrRkIXCfbc8ULc7xOaB134agNKk,976
@@ -52,7 +52,7 @@ nucleus/metrics/segmentation_loader.py,sha256=SdEhEYB5azCWp3iR8UaW-MXB23O-NQSTkE
 nucleus/metrics/segmentation_metrics.py,sha256=rvjfFeyK-4ZEIgxl6nelYyDkAr767WjNTnVFkcQHDh8,29556
 nucleus/metrics/segmentation_to_poly_metrics.py,sha256=92SuotttylxsTgebm3476wN21EJM19MT4rnjmiOlb68,29107
 nucleus/metrics/segmentation_utils.py,sha256=AkqCbyim67K9DA0VQYOUpYHe8vOwSvanFqWB1oOz1sU,10368
-nucleus/model.py,sha256=ZYGXfwZVRiM6aPB1CexiwE605AJeXmkRFq28y_5lOpE,10954
+nucleus/model.py,sha256=qZ8D7ZS0HobheEME5fZsdfWqjs472U32Q8_4RVuFZH8,11159
 nucleus/model_run.py,sha256=WtGy8cD86M_6aVNAp0ELZgunwbztNeOO8nv8ZSpbwhY,9280
 nucleus/package_not_installed.py,sha256=1ae0aqKAM3KrB0C-5MuPPXoz9tLWJUKtP1UZ-vw9Zik,1117
 nucleus/payload_constructor.py,sha256=EI5VDt5GG4jlJMI5k4vRve0GQ-zxJ79InnyRrjf5ZUY,4887
@@ -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.3.dist-info/LICENSE,sha256=jaTGyQSQIZeWMo5iyYqgbAYHR9Bdy7nOzgE-Up3m_-g,1075
-scale_nucleus-0.17.3.dist-info/METADATA,sha256=LgJefNOXq0dWMpOsMJCQywR19rRqn1mN5HNNSdJb5gA,7920
-scale_nucleus-0.17.3.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-scale_nucleus-0.17.3.dist-info/entry_points.txt,sha256=fmqEzh6NZQyg9eFMILnWabKT8OWQTMSCdDzMiVq2zYs,32
-scale_nucleus-0.17.3.dist-info/RECORD,,
+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,,