scale-nucleus 0.16.2__py3-none-any.whl → 0.16.3__py3-none-any.whl

nucleus/constants.py

@@ -89,6 +89,7 @@ KEYPOINTS_SKELETON_KEY = "skeleton"
 LABEL_KEY = "label"
 LABELS_KEY = "labels"
 MASK_URL_KEY = "mask_url"
+MAX_ES_PAGE_SIZE = 10000  # Max number of document fetches allowed per ES page
 MAX_PAYLOAD_SIZE = 0x1FFFFFE8  # Set to max string size since we currently convert payloads to strings for processing on the server-side
 MESSAGE_KEY = "message"
 METADATA_KEY = "metadata"

nucleus/dataset.py

@@ -46,6 +46,7 @@ from .constants import (
     ITEMS_KEY,
     JOB_REQ_LIMIT,
     KEEP_HISTORY_KEY,
+    MAX_ES_PAGE_SIZE,
     MESSAGE_KEY,
     NAME_KEY,
     OBJECT_IDS_KEY,
@@ -1972,12 +1973,32 @@ class Dataset:
             client=self._client,
             endpoint=f"dataset/{self.id}/queryItemsPage",
             result_key=ITEMS_KEY,
-            page_size=10000,  # max ES page size
+            page_size=MAX_ES_PAGE_SIZE,
             query=query,
         )
         for item_json in json_generator:
             yield DatasetItem.from_json(item_json)
 
+    def query_scenes(self, query: str) -> Iterable[Scene]:
+        """
+        Fetches all Scenes that pertain to a given structured query.
+
+        Args:
+            query: Structured query compatible with the `Nucleus query language <https://nucleus.scale.com/docs/query-language-reference>`_.
+
+        Returns:
+            A list of Scene query results.
+        """
+        json_generator = paginate_generator(
+            client=self._client,
+            endpoint=f"dataset/{self.id}/queryScenesPage",
+            result_key=ITEMS_KEY,
+            page_size=MAX_ES_PAGE_SIZE,
+            query=query,
+        )
+        for item_json in json_generator:
+            yield Scene.from_json(item_json, None, True)
+
     @property
     def tracks(self) -> List[Track]:
         """Tracks unique to this dataset.

{scale_nucleus-0.16.2.dist-info → scale_nucleus-0.16.3.dist-info}/METADATA

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

{scale_nucleus-0.16.2.dist-info → scale_nucleus-0.16.3.dist-info}/RECORD

@@ -18,14 +18,14 @@ nucleus/async_utils.py,sha256=ZUlhjhxdNVZ842TJl32hRcXDkS09vR8S6jwvroZBhsA,6373
 nucleus/autocurate.py,sha256=kI0vRqad_An8SN5JX6sSdGP_vNHJI2Pq4NINHuhNf2U,1080
 nucleus/camera_params.py,sha256=fl17aaSAZDAJIWo6F2HFvM6HKGcQh9fXvo4t3RzGMc4,3726
 nucleus/connection.py,sha256=U7G7h_ufcTYBwqehhKWk899-TTvbRNFzXo7khtb5fy0,2900
-nucleus/constants.py,sha256=kU_Gkw-91O_NFNEqtkD-1UTbkyZiTGGZcJNe84fH26Y,4582
+nucleus/constants.py,sha256=r4W-OuFeI07fhKQwzhclqLtR14Y8jc1GyL564I2shaE,4661
 nucleus/data_transfer_object/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 nucleus/data_transfer_object/dataset_details.py,sha256=1YGvfKkPSqDrXK_y5mBXyRThY07tU-nwOCYTkYCSl6k,214
 nucleus/data_transfer_object/dataset_info.py,sha256=5P_gpvAyaqXxj2ZQuzLkGN2XROaN9Me56OLybCmO3R4,940
 nucleus/data_transfer_object/dataset_size.py,sha256=oe-dXaMLpsQRDcJQRZ9Ja8JTagYz4dviZuTognEylp0,111
 nucleus/data_transfer_object/job_status.py,sha256=BbIo22-27Ue2-pEeVUvb-M7e-FyDw6rshkeJ6YRZ6VA,1665
 nucleus/data_transfer_object/scenes_list.py,sha256=iTHE6vA47bRB6ciyEU4LArUXEXco4ArnGvZTGTeK8xs,432
-nucleus/dataset.py,sha256=rkgPmQJOpPi8fu6e3bD4Jhqftj3Qm9y6tQegEmr_uq4,79499
+nucleus/dataset.py,sha256=OUNr2k_5TRRkugU8r8Hcn6s4Ysf0Fja03mfQUkKx98s,80226
 nucleus/dataset_item.py,sha256=_ZsTBJ9I7IN5YTos1TVs8R_vMoiXgRFCNiNNQevKvvE,9617
 nucleus/dataset_item_uploader.py,sha256=oT1HRFPu9J3iu0raKdtLS4fz7q1pO3fttjabgFGBuxc,6696
 nucleus/deprecation_warning.py,sha256=5C9dVusR5UkUQnW2MrRkIXCfbc8ULc7xOaB134agNKk,976
@@ -82,8 +82,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.16.2.dist-info/LICENSE,sha256=jaTGyQSQIZeWMo5iyYqgbAYHR9Bdy7nOzgE-Up3m_-g,1075
-scale_nucleus-0.16.2.dist-info/METADATA,sha256=oQtA3lLS6aXVH3B9Jg9yzQxGF1gbPE421LNWh9S0Keo,7822
-scale_nucleus-0.16.2.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-scale_nucleus-0.16.2.dist-info/entry_points.txt,sha256=fmqEzh6NZQyg9eFMILnWabKT8OWQTMSCdDzMiVq2zYs,32
-scale_nucleus-0.16.2.dist-info/RECORD,,
+scale_nucleus-0.16.3.dist-info/LICENSE,sha256=jaTGyQSQIZeWMo5iyYqgbAYHR9Bdy7nOzgE-Up3m_-g,1075
+scale_nucleus-0.16.3.dist-info/METADATA,sha256=k57X75iYqpE_cp-fizyVrwK0YB-1_75s-Qfo9SJDLpg,7822
+scale_nucleus-0.16.3.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+scale_nucleus-0.16.3.dist-info/entry_points.txt,sha256=fmqEzh6NZQyg9eFMILnWabKT8OWQTMSCdDzMiVq2zYs,32
+scale_nucleus-0.16.3.dist-info/RECORD,,