scale-nucleus 0.14.5b1__tar.gz → 0.14.14__tar.gz

{scale-nucleus-0.14.5b1 → scale-nucleus-0.14.14}/PKG-INFO

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

{scale-nucleus-0.14.5b1 → scale-nucleus-0.14.14}/cli/slices.py

@@ -23,12 +23,9 @@ def slices(ctx, web):
 @slices.command("list")
 def list_slices():
     """List all available Slices"""
-    with Live(
-        Spinner("dots4", text="Finding your Slices!"),
-        vertical_overflow="visible",
-    ) as live:
-        client = init_client()
-        datasets = client.datasets
+    client = init_client()
+    console = Console()
+    with console.status("Finding your Slices!", spinner="dots4"):
         table = Table(
             Column("id", overflow="fold", min_width=24),
             "name",
@@ -37,26 +34,15 @@ def list_slices():
             title=":cake: Slices",
             title_justify="left",
         )
-        errors = {}
-        for ds in datasets:
-            try:
-                ds_slices = ds.slices
-                if ds_slices:
-                    for slc_id in ds_slices:
-                        slice_url = nucleus_url(f"{ds.id}/{slc_id}")
-                        slice_info = client.get_slice(slc_id).info()
-                        table.add_row(
-                            slc_id, slice_info["name"], ds.name, slice_url
-                        )
-                        live.update(table)
-            except NucleusAPIError as e:
-                errors[ds.id] = e
-
-        error_tree = Tree(
-            ":x: Encountered the following errors while fetching information"
-        )
-        for ds_id, error in errors.items():
-            dataset_branch = error_tree.add(f"Dataset: {ds_id}")
-            dataset_branch.add(f"Error: {error}")
+        datasets = client.datasets
+        id_to_datasets = {d.id: d for d in datasets}
+        all_slices = client.slices
+        for s in all_slices:
+            table.add_row(
+                s.id,
+                s.name,
+                id_to_datasets[s.dataset_id].name,
+                nucleus_url(f"{s.dataset_id}/{s.id}"),
+            )
 
-        Console().print(error_tree)
+    console.print(table)

{scale-nucleus-0.14.5b1 → scale-nucleus-0.14.14}/nucleus/__init__.py

@@ -235,6 +235,12 @@ class NucleusClient:
         """
         return self.list_jobs()
 
+    @property
+    def slices(self) -> List[Slice]:
+        response = self.make_request({}, "slice/", requests.get)
+        slices = [Slice.from_request(info, self) for info in response]
+        return slices
+
     @deprecated(msg="Use the NucleusClient.models property in the future.")
     def list_models(self) -> List[Model]:
         return self.models
@@ -441,7 +447,8 @@ class NucleusClient:
         Deletes a dataset by ID.
 
         All items, annotations, and predictions associated with the dataset will
-        be deleted as well.
+        be deleted as well. Note that if this dataset is linked to a Scale or Rapid
+        labeling project, the project itself will not be deleted.
 
         Parameters:
             dataset_id: The ID of the dataset to delete.
@@ -852,7 +859,7 @@ class NucleusClient:
 
     @deprecated("Prefer calling Dataset.delete_annotations instead.")
     def delete_annotations(
-        self, dataset_id: str, reference_ids: list = None, keep_history=False
+        self, dataset_id: str, reference_ids: list = None, keep_history=True
     ) -> AsyncJob:
         dataset = self.get_dataset(dataset_id)
         return dataset.delete_annotations(reference_ids, keep_history)
@@ -1020,6 +1027,7 @@ class NucleusClient:
         payload: Optional[dict],
         route: str,
         requests_command=requests.post,
+        return_raw_response: bool = False,
     ) -> dict:
         """Makes a request to a Nucleus API endpoint.
 
@@ -1029,9 +1037,10 @@ class NucleusClient:
             payload: Given request payload.
             route: Route for the request.
             Requests command: ``requests.post``, ``requests.get``, or ``requests.delete``.
+            return_raw_response: return the request's response object entirely
 
         Returns:
-            Response payload as JSON dict.
+            Response payload as JSON dict or request object.
         """
         if payload is None:
             payload = {}
@@ -1041,18 +1050,7 @@ class NucleusClient:
                     "Received defined payload with GET request! Will ignore payload"
                 )
             payload = None
-        return self._connection.make_request(payload, route, requests_command)  # type: ignore
-
-    def handle_bad_response(
-        self,
-        endpoint,
-        requests_command,
-        requests_response=None,
-        aiohttp_response=None,
-    ):
-        self._connection.handle_bad_response(
-            endpoint, requests_command, requests_response, aiohttp_response
-        )
+        return self._connection.make_request(payload, route, requests_command, return_raw_response)  # type: ignore
 
     def _set_api_key(self, api_key):
         """Fetch API key from environment variable NUCLEUS_API_KEY if not set"""

{scale-nucleus-0.14.5b1 → scale-nucleus-0.14.14}/nucleus/annotation.py

@@ -105,7 +105,7 @@ class BoxAnnotation(Annotation):  # pylint: disable=R0902
             reference_id="image_1",
             annotation_id="image_1_car_box_1",
             metadata={"vehicle_color": "red"},
-            embedding_vector=[0.1423, 1.432, ...3.829],
+            embedding_vector=[0.1423, 1.432, ..., 3.829],
         )
 
     Parameters:
@@ -310,7 +310,7 @@ class PolygonAnnotation(Annotation):
             reference_id="image_2",
             annotation_id="image_2_bus_polygon_1",
             metadata={"vehicle_color": "yellow"},
-            embedding_vector=[0.1423, 1.432, ...3.829],
+            embedding_vector=[0.1423, 1.432, ..., 3.829],
         )
 
     Parameters:
@@ -691,7 +691,7 @@ class SegmentationAnnotation(Annotation):
         from nucleus import SegmentationAnnotation
 
         segmentation = SegmentationAnnotation(
-            mask_url="s3://your-bucket-name/segmentation-masks/image_2_mask_id1.png",
+            mask_url="s3://your-bucket-name/segmentation-masks/image_2_mask_id_1.png",
             annotations=[
                 Segment(label="grass", index="1"),
                 Segment(label="road", index="2"),
@@ -704,7 +704,8 @@ class SegmentationAnnotation(Annotation):
 
     Parameters:
         mask_url (str): A URL pointing to the segmentation prediction mask which is
-          accessible to Scale, or a local path. The mask is an HxW int8 array saved in PNG format,
+          accessible to Scale. This "URL" can also be a path to a local file.
+          The mask is an HxW int8 array saved in PNG format,
           with each pixel value ranging from [0, N), where N is the number of
           possible classes (for semantic segmentation) or instances (for instance
           segmentation).

{scale-nucleus-0.14.5b1 → scale-nucleus-0.14.14}/nucleus/connection.py

@@ -40,7 +40,11 @@ class Connection:
         return self.make_request(payload, route, requests_command=requests.put)
 
     def make_request(
-        self, payload: dict, route: str, requests_command=requests.post
+        self,
+        payload: dict,
+        route: str,
+        requests_command=requests.post,
+        return_raw_response: bool = False,
     ) -> dict:
         """
         Makes a request to Nucleus endpoint and logs a warning if not
@@ -49,6 +53,7 @@ class Connection:
         :param payload: given payload
         :param route: route for the request
         :param requests_command: requests.post, requests.get, requests.delete
+        :param return_raw_response: return the request's response object entirely
         :return: response JSON
         """
         endpoint = f"{self.endpoint}/{route}"
@@ -73,6 +78,9 @@ class Connection:
         if not response.ok:
             self.handle_bad_response(endpoint, requests_command, response)
 
+        if return_raw_response:
+            return response
+
         return response.json()
 
     def handle_bad_response(

{scale-nucleus-0.14.5b1 → scale-nucleus-0.14.14}/nucleus/constants.py

@@ -28,6 +28,7 @@ AUTOTAGS_KEY = "autotags"
 AUTOTAG_SCORE_THRESHOLD = "score_threshold"
 EXPORTED_ROWS = "exportedRows"
 EXPORTED_SCALE_TASK_INFO_ROWS = "exportedScaleTaskInfoRows"
+EXPORT_FOR_TRAINING_KEY = "data"
 CAMERA_MODEL_KEY = "camera_model"
 CAMERA_PARAMS_KEY = "camera_params"
 CLASS_PDF_KEY = "class_pdf"
@@ -82,7 +83,6 @@ JOB_CREATION_TIME_KEY = "job_creation_time"
 KEYPOINTS_KEY = "keypoints"
 KEYPOINTS_NAMES_KEY = "names"
 KEYPOINTS_SKELETON_KEY = "skeleton"
-LAST_PAGE = "lastPage"
 LABEL_KEY = "label"
 LABELS_KEY = "labels"
 MASK_URL_KEY = "mask_url"
@@ -98,8 +98,9 @@ NEW_ITEMS = "new_items"
 NUCLEUS_ENDPOINT = "https://api.scale.com/v1/nucleus"
 NUM_SENSORS_KEY = "num_sensors"
 ORIGINAL_IMAGE_URL_KEY = "original_image_url"
-PAGE_SIZE = "pageSize"
-PAGE_TOKEN = "pageToken"
+PAGE_SIZE_KEY = "pageSize"
+PAGE_TOKEN_KEY = "pageToken"
+NEXT_TOKEN_KEY = "nextPageToken"
 P1_KEY = "p1"
 P2_KEY = "p2"
 POINTCLOUD_KEY = "pointcloud"