supervisely 6.73.347__py3-none-any.whl → 6.73.349__py3-none-any.whl

supervisely/__init__.py

@@ -54,6 +54,7 @@ from supervisely.task.progress import (
 
 
 import supervisely.project as project
+import supervisely.api.constants as api_constants
 from supervisely.project import read_project, get_project_class
 from supervisely.project.download import download, download_async, download_fast
 from supervisely.project.upload import upload

supervisely/api/constants.py

@@ -0,0 +1,3 @@
+# coding: utf-8
+
+DOWNLOAD_BATCH_SIZE = None

supervisely/api/entity_annotation/figure_api.py

@@ -23,7 +23,7 @@ import numpy as np
 from requests_toolbelt import MultipartDecoder, MultipartEncoder
 from tqdm import tqdm
 
-from supervisely._utils import batched
+from supervisely._utils import batched, logger, run_coroutine
 from supervisely.api.module_api import ApiField, ModuleApi, RemoveableBulkModuleApi
 from supervisely.geometry.rectangle import Rectangle
 from supervisely.video_annotation.key_id_map import KeyIdMap
@@ -473,24 +473,24 @@ class FigureApi(RemoveableBulkModuleApi):
         :rtype: :class: `Dict[int, List[FigureInfo]]`
         """
         fields = [
-            "id",
-            "createdAt",
-            "updatedAt",
-            "imageId",
-            "objectId",
-            "classId",
-            "projectId",
-            "datasetId",
-            "geometry",
-            "geometryType",
-            "geometryMeta",
-            "tags",
-            "meta",
-            "area",
-            "priority",
+            ApiField.ID,
+            ApiField.CREATED_AT,
+            ApiField.UPDATED_AT,
+            ApiField.IMAGE_ID,
+            ApiField.OBJECT_ID,
+            ApiField.CLASS_ID,
+            ApiField.PROJECT_ID,
+            ApiField.DATASET_ID,
+            ApiField.GEOMETRY,
+            ApiField.GEOMETRY_TYPE,
+            ApiField.GEOMETRY_META,
+            ApiField.TAGS,
+            ApiField.META,
+            ApiField.AREA,
+            ApiField.PRIORITY,
         ]
         if skip_geometry is True:
-            fields = [x for x in fields if x != "geometry"]
+            fields = [x for x in fields if x != ApiField.GEOMETRY]
 
         if image_ids is None:
             filters = []
@@ -498,8 +498,8 @@ class FigureApi(RemoveableBulkModuleApi):
             filters = [
                 {
                     ApiField.FIELD: ApiField.ENTITY_ID,
-                    "operator": "in",
-                    "value": image_ids,
+                    ApiField.OPERATOR: "in",
+                    ApiField.VALUE: image_ids,
                 }
             ]
         data = {
@@ -784,3 +784,192 @@ class FigureApi(RemoveableBulkModuleApi):
 
         if tasks:
             await asyncio.gather(*tasks)
+
+    async def download_async(
+        self,
+        dataset_id: int,
+        image_ids: Optional[List[int]] = None,
+        skip_geometry: bool = False,
+        semaphore: Optional[asyncio.Semaphore] = None,
+        log_progress: bool = True,
+    ) -> Dict[int, List[FigureInfo]]:
+        """
+        Asynchronously download figures for the given dataset ID. Can be filtered by image IDs.
+        This method is significantly faster than the synchronous version for large datasets.
+
+        :param dataset_id: Dataset ID in Supervisely.
+        :type dataset_id: int
+        :param image_ids: Specify the list of image IDs within the given dataset ID. If image_ids is None, the method returns all possible pairs of images with figures.
+        :type image_ids: List[int], optional
+        :param skip_geometry: Skip the download of figure geometry. May be useful for a significant api request speed increase in the large datasets.
+        :type skip_geometry: bool
+        :param semaphore: Semaphore to limit the number of concurrent downloads.
+        :type semaphore: Optional[asyncio.Semaphore], optional
+        :param log_progress: If True, log the progress of the download.
+        :type log_progress: bool, optional
+        :return: A dictionary where keys are image IDs and values are lists of figures.
+        :rtype: Dict[int, List[FigureInfo]]
+
+        :Usage example:
+
+        .. code-block:: python
+
+            import supervisely as sly
+
+            os.environ['SERVER_ADDRESS'] = 'https://app.supervisely.com'
+            os.environ['API_TOKEN'] = 'Your Supervisely API Token'
+            api = sly.Api.from_env()
+
+            dataset_id = 12345
+            download_coroutine = api.image.figure.download_async(dataset_id)
+            figures = sly.run_coroutine(download_coroutine)
+        """
+        fields = [
+            ApiField.ID,
+            ApiField.CREATED_AT,
+            ApiField.UPDATED_AT,
+            ApiField.IMAGE_ID,
+            ApiField.OBJECT_ID,
+            ApiField.CLASS_ID,
+            ApiField.PROJECT_ID,
+            ApiField.DATASET_ID,
+            ApiField.GEOMETRY,
+            ApiField.GEOMETRY_TYPE,
+            ApiField.GEOMETRY_META,
+            ApiField.TAGS,
+            ApiField.META,
+            ApiField.AREA,
+            ApiField.PRIORITY,
+        ]
+        if skip_geometry is True:
+            fields = [x for x in fields if x != ApiField.GEOMETRY]
+
+        if image_ids is None:
+            filters = []
+        else:
+            filters = [
+                {
+                    ApiField.FIELD: ApiField.ENTITY_ID,
+                    ApiField.OPERATOR: "in",
+                    ApiField.VALUE: image_ids,
+                }
+            ]
+
+        data = {
+            ApiField.DATASET_ID: dataset_id,
+            ApiField.FIELDS: fields,
+            ApiField.FILTER: filters,
+        }
+
+        # Get first page to determine total pages
+        if semaphore is None:
+            semaphore = self._api.get_default_semaphore()
+        images_figures = defaultdict(list)
+        pages_count = None
+        total = 0
+        tasks = []
+
+        async def _get_page(page_data, page_num):
+            async with semaphore:
+                response = await self._api.post_async("figures.list", page_data)
+                response_json = response.json()
+                nonlocal pages_count, total
+                pages_count = response_json["pagesCount"]
+                if page_num == 1:
+                    total = response_json["total"]
+
+                page_figures = []
+                for info in response_json["entities"]:
+                    figure_info = self._convert_json_info(info, True)
+                    page_figures.append(figure_info)
+                return page_figures
+
+        # Get first page
+        data[ApiField.PAGE] = 1
+        first_page_figures = await _get_page(data, 1)
+
+        if log_progress:
+            progress_cb = tqdm(total=total, desc="Downloading figures")
+
+        for figure in first_page_figures:
+            images_figures[figure.entity_id].append(figure)
+            if log_progress:
+                progress_cb.update(1)
+
+        # Get rest of the pages in parallel
+        if pages_count > 1:
+            for page in range(2, pages_count + 1):
+                page_data = data.copy()
+                page_data[ApiField.PAGE] = page
+                tasks.append(asyncio.create_task(_get_page(page_data, page)))
+
+            for task in asyncio.as_completed(tasks):
+                page_figures = await task
+                for figure in page_figures:
+                    images_figures[figure.entity_id].append(figure)
+                    if log_progress:
+                        progress_cb.update(1)
+
+        return dict(images_figures)
+
+    def download_fast(
+        self,
+        dataset_id: int,
+        image_ids: Optional[List[int]] = None,
+        skip_geometry: bool = False,
+        semaphore: Optional[asyncio.Semaphore] = None,
+        log_progress: bool = True,
+    ) -> Dict[int, List[FigureInfo]]:
+        """
+        Download figures for the given dataset ID. Can be filtered by image IDs.
+        This method is significantly faster than the synchronous version for large datasets and
+        is designed to be used in an asynchronous context.
+        Will fallback to the synchronous version if async fails.
+
+        :param dataset_id: Dataset ID in Supervisely.
+        :type dataset_id: int
+        :param image_ids: Specify the list of image IDs within the given dataset ID. If image_ids is None, the method returns all possible pairs of images with figures.
+        :type image_ids: List[int], optional
+        :param skip_geometry: Skip the download of figure geometry. May be useful for a significant api request speed increase in the large datasets.
+        :type skip_geometry: bool
+        :param semaphore: Semaphore to limit the number of concurrent downloads.
+        :type semaphore: Optional[asyncio.Semaphore], optional
+        :param log_progress: If True, log the progress of the download.
+        :type log_progress: bool, optional
+
+        :return: A dictionary where keys are image IDs and values are lists of figures.
+        :rtype: Dict[int, List[FigureInfo]]
+
+        :Usage example:
+
+        .. code-block:: python
+
+            import supervisely as sly
+
+            os.environ['SERVER_ADDRESS'] = 'https://app.supervisely.com'
+            os.environ['API_TOKEN'] = 'Your Supervisely API Token'
+            api = sly.Api.from_env()
+
+            dataset_id = 12345
+            figures = api.image.figure.download_fast(dataset_id)
+        """
+        try:
+            return run_coroutine(
+                self.download_async(
+                    dataset_id=dataset_id,
+                    image_ids=image_ids,
+                    skip_geometry=skip_geometry,
+                    semaphore=semaphore,
+                    log_progress=log_progress,
+                )
+            )
+        except Exception:
+            # Fallback to the synchronous version if async fails
+            logger.debug("Async download of figures is failed, falling back to sync download.")
+            if log_progress:
+                logger.debug("Downloading figures without progress bar.")
+            return self.download(
+                dataset_id=dataset_id,
+                image_ids=image_ids,
+                skip_geometry=skip_geometry,
+            )

supervisely/api/image_api.py

@@ -55,6 +55,7 @@ from supervisely._utils import (
 from supervisely.annotation.annotation import Annotation
 from supervisely.annotation.tag import Tag
 from supervisely.annotation.tag_meta import TagApplicableTo, TagMeta, TagValueType
+from supervisely.api.constants import DOWNLOAD_BATCH_SIZE
 from supervisely.api.dataset_api import DatasetInfo
 from supervisely.api.entity_annotation.figure_api import FigureApi
 from supervisely.api.entity_annotation.tag_api import TagApi
@@ -368,7 +369,7 @@ class ImageInfo(NamedTuple):
     #: :class:`int`: ID of the blob file in Supervisely storage related to the image.
     related_data_id: Optional[int] = None
 
-    #: :class:`str`: Unique ID of the image that links it to the corresponding blob file in Supervisely storage 
+    #: :class:`str`: Unique ID of the image that links it to the corresponding blob file in Supervisely storage
     #: uses for downloading source blob file.
     download_id: Optional[str] = None
 
@@ -1015,7 +1016,14 @@ class ImageApi(RemoveableBulkModuleApi):
         """
         Get image id and it content from given dataset and list of images ids.
         """
-        for batch_ids in batched(ids):
+        if DOWNLOAD_BATCH_SIZE is not None and isinstance(DOWNLOAD_BATCH_SIZE, int):
+            batches = batched(ids, DOWNLOAD_BATCH_SIZE)
+            logger.debug(
+                f"Batch size for func 'ImageApi._download_batch' changed to: {DOWNLOAD_BATCH_SIZE}"
+            )
+        else:
+            batches = batched(ids)
+        for batch_ids in batches:
             response = self._api.post(
                 "images.bulk.download",
                 {ApiField.DATASET_ID: dataset_id, ApiField.IMAGE_IDS: batch_ids},
@@ -2352,7 +2360,9 @@ class ImageApi(RemoveableBulkModuleApi):
 
         for batch in blob_image_infos_generator:
             names = [item.name for item in batch]
-            metas_batch = [metas[name] for name in names] if metas is not None else [{}] * len(names)
+            metas_batch = (
+                [metas[name] for name in names] if metas is not None else [{}] * len(names)
+            )
             items = [
                 {ApiField.TEAM_FILE_ID: team_file_id, ApiField.SOURCE_BLOB: item.offsets_dict}
                 for item in batch

supervisely/project/download.py

@@ -284,8 +284,64 @@ def download_fast(
     Download project in a fast mode.
     Items are downloaded asynchronously. If an error occurs, the method will fallback to synchronous download.
     Automatically detects project type.
-    You can pass :class:`ProjectInfo` as `project_info` kwarg to avoid additional API requests.
+
+    :param api: Supervisely API address and token.
+    :type api: :class:`Api<supervisely.api.api.Api>`
+    :param project_id: Supervisely downloadable project ID.
+    :type project_id: :class:`int`
+    :param dest_dir: Destination directory.
+    :type dest_dir: :class:`str`
+    :param dataset_ids: Filter datasets by IDs.
+    :type dataset_ids: :class:`list` [ :class:`int` ], optional
+    :param log_progress: Show uploading progress bar.
+    :type log_progress: :class:`bool`
+    :param progress_cb: Function for tracking download progress.
+    :type progress_cb: tqdm or callable, optional
+    :param semaphore: Semaphore to limit the number of concurrent downloads of items.
+    :type semaphore: :class:`asyncio.Semaphore`, optional
+    :param only_image_tags: Download project with only images tags (without objects tags).
+    :type only_image_tags: :class:`bool`, optional
+    :param save_image_info: Download images infos or not.
+    :type save_image_info: :class:`bool`, optional
+    :param save_images: Download images or not.
+    :type save_images: :class:`bool`, optional
+    :param save_image_meta: Download images metadata in JSON format or not.
+    :type save_image_meta: :class:`bool`, optional
+    :param images_ids: Filter images by IDs.
+    :type images_ids: :class:`list` [ :class:`int` ], optional
+    :param resume_download: Resume download enables to download only missing files avoiding erase of existing files.
+    :type resume_download: :class:`bool`, optional
+    :param switch_size: Size threshold that determines how an item will be downloaded.
+                        Items larger than this size will be downloaded as single files, while smaller items will be downloaded as a batch.
+                        Useful for projects with different item sizes and when you exactly know which size will perform better with batch download.
+    :type switch_size: :class:`int`, optional
+    :param batch_size: Number of items to download in a single batch.
+    :type batch_size: :class:`int`, optional
+    :param download_blob_files: Download project with Blob files in native format.
+                                If False - download project like a regular project in classic Supervisely format.
+    :type download_blob_files: :class:`bool`, optional
+    :param project_info: Project info object. To avoid additional API requests.
+    :type project_info: :class:`ProjectInfo`, optional
+    :return: None
+    :rtype: NoneType
+
+    :Usage example:
+
+        .. code-block:: python
+
+            import supervisely as sly
+
+            os.environ['SERVER_ADDRESS'] = 'https://app.supervisely.com'
+            os.environ['API_TOKEN'] = 'Your Supervisely API Token'
+            api = sly.Api.from_env()
+
+            project_id = 8888
+            save_directory = "/path/to/save/projects"
+
+            sly.download_fast(api, project_id, save_directory)
+
     """
+
     download_async_or_sync(
         api=api,
         project_id=project_id,

{supervisely-6.73.347.dist-info → supervisely-6.73.349.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: supervisely
-Version: 6.73.347
+Version: 6.73.349
 Summary: Supervisely Python SDK.
 Home-page: https://github.com/supervisely/supervisely
 Author: Supervisely

{supervisely-6.73.347.dist-info → supervisely-6.73.349.dist-info}/RECORD

@@ -1,5 +1,5 @@
 supervisely/README.md,sha256=XM-DiMC6To3I9RjQZ0c61905EFRR_jnCUx2q3uNR-X8,3331
-supervisely/__init__.py,sha256=mVZ34ziMzw-Hlr5kaTt1xSh5VZIWrTgTNeSyLKcrOyI,10867
+supervisely/__init__.py,sha256=_qphKFT0_toEQmF5IjB1sWjztbF4lP1tLY29PBJhArY,10917
 supervisely/_utils.py,sha256=DA-sPMk68GyInrc4DMxO-Azp5-uWkwZx_NAr8mXVI0o,18280
 supervisely/function_wrapper.py,sha256=R5YajTQ0GnRp2vtjwfC9hINkzQc0JiyGsu8TER373xY,1912
 supervisely/sly_logger.py,sha256=z92Vu5hmC0GgTIJO1n6kPDayRW9__8ix8hL6poDZj-Y,6274
@@ -24,11 +24,12 @@ supervisely/api/agent_api.py,sha256=ShWAIlXcWXcyI9fqVuP5GZVCigCMJmjnvdGUfLspD6Y,
 supervisely/api/annotation_api.py,sha256=XE3Sr_oQOMraZ9NlWs9ZqUsff1j47XRDh9Fy8rW4ubw,82763
 supervisely/api/api.py,sha256=D90G6ivwyHHK7WVo4ByKtv65lSED_Sm1qlp_TpyCeAc,67398
 supervisely/api/app_api.py,sha256=RsbVej8WxWVn9cNo5s3Fqd1symsCdsfOaKVBKEUapRY,71927
+supervisely/api/constants.py,sha256=qwK9Q3mHGz5Ny5WuBmPQgawBWfzCT2DRiw3IcaCDRmo,44
 supervisely/api/dataset_api.py,sha256=c6rEVySSxbyDB5fUCilsc5AKk0pWN_5vVN6OceDbEvc,47918
 supervisely/api/file_api.py,sha256=EX_Cam93QkR5SOOIkIznkzERIr0u7N7GHVGK27iOm20,92952
 supervisely/api/github_api.py,sha256=NIexNjEer9H5rf5sw2LEZd7C1WR-tK4t6IZzsgeAAwQ,623
 supervisely/api/image_annotation_tool_api.py,sha256=YcUo78jRDBJYvIjrd-Y6FJAasLta54nnxhyaGyanovA,5237
-supervisely/api/image_api.py,sha256=pPY8K4hKKE4hvWNB6VEXd-AypSCqrivCWWsHDQKKu6g,223223
+supervisely/api/image_api.py,sha256=sE2lIPPYLv1tJsuFSjc9IvLVB07kmq9PnPodU3J6aEs,223637
 supervisely/api/import_storage_api.py,sha256=BDCgmR0Hv6OoiRHLCVPKt3iDxSVlQp1WrnKhAK_Zl84,460
 supervisely/api/issues_api.py,sha256=BqDJXmNoTzwc3xe6_-mA7FDFC5QQ-ahGbXk_HmpkSeQ,17925
 supervisely/api/labeling_job_api.py,sha256=VM1pjM65cUTeer1hrI7cSmCUOHJb7fzK6gJ-abA07hg,55097
@@ -49,7 +50,7 @@ supervisely/api/video_annotation_tool_api.py,sha256=3A9-U8WJzrTShP_n9T8U01M9FzGY
 supervisely/api/workspace_api.py,sha256=5KAxpI9DKBmgF_pyQaXHpGT30HZ9wRtR6DP3FoYFZtY,9228
 supervisely/api/entity_annotation/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 supervisely/api/entity_annotation/entity_annotation_api.py,sha256=K79KdDyepQv4FiNQHBj9V4-zLIemxK9WG1ig1bfBKb8,3083
-supervisely/api/entity_annotation/figure_api.py,sha256=_v7Nhi63Ksw1OE38ZvFwj9F4O0GNmf96U3gFyGTs4Hs,27776
+supervisely/api/entity_annotation/figure_api.py,sha256=rmsE3L_JfqN94sLN637pQ0syiBAXPd8RyAwhl41j1xs,35318
 supervisely/api/entity_annotation/object_api.py,sha256=gbcNvN_KY6G80Me8fHKQgryc2Co7VU_kfFd1GYILZ4E,8875
 supervisely/api/entity_annotation/tag_api.py,sha256=M-28m9h8R4k9Eqo6P1S0UH8_D5kqCwAvQLYY6_Yz4oM,11161
 supervisely/api/pointcloud/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -1017,7 +1018,7 @@ supervisely/pointcloud_episodes/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm
 supervisely/pointcloud_episodes/pointcloud_episodes.py,sha256=cRXdtw7bMsbsdVQjxfWxFSESrO-LGiqqsZyyExl2Mbg,3430
 supervisely/project/__init__.py,sha256=hlzdj9Pgy53Q3qdP8LMtGTChvZHQuuShdtui2eRUQeE,2601
 supervisely/project/data_version.py,sha256=P5Lui6i64pYeJWmAdGJDv8GRXxjfpSSZ8zT_MxIrynE,19553
-supervisely/project/download.py,sha256=4QOEQZnolmOpEO6Wl6DIc73BwIYr9m-6anbarrU6VwQ,24902
+supervisely/project/download.py,sha256=N6UEXY_eLtzjz61Y2SaJLg2-vv_Cvp9cXCUUM9R8-d8,27677
 supervisely/project/pointcloud_episode_project.py,sha256=yiWdNBQiI6f1O9sr1pg8JHW6O-w3XUB1rikJNn3Oung,41866
 supervisely/project/pointcloud_project.py,sha256=Kx1Vaes-krwG3BiRRtHRLQxb9G5m5bTHPN9IzRqmNWo,49399
 supervisely/project/project.py,sha256=OunVB11sVQSOvkqkjsEEkX1nq9OUXOXpHTdcLDjOFe0,233256
@@ -1082,9 +1083,9 @@ supervisely/worker_proto/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZ
 supervisely/worker_proto/worker_api_pb2.py,sha256=VQfi5JRBHs2pFCK1snec3JECgGnua3Xjqw_-b3aFxuM,59142
 supervisely/worker_proto/worker_api_pb2_grpc.py,sha256=3BwQXOaP9qpdi0Dt9EKG--Lm8KGN0C5AgmUfRv77_Jk,28940
 supervisely_lib/__init__.py,sha256=7-3QnN8Zf0wj8NCr2oJmqoQWMKKPKTECvjH9pd2S5vY,159
-supervisely-6.73.347.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-supervisely-6.73.347.dist-info/METADATA,sha256=7GkOnoQKswP3aWdQvd8kRV27PVdnozTXeuKEqlGv734,33596
-supervisely-6.73.347.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
-supervisely-6.73.347.dist-info/entry_points.txt,sha256=U96-5Hxrp2ApRjnCoUiUhWMqijqh8zLR03sEhWtAcms,102
-supervisely-6.73.347.dist-info/top_level.txt,sha256=kcFVwb7SXtfqZifrZaSE3owHExX4gcNYe7Q2uoby084,28
-supervisely-6.73.347.dist-info/RECORD,,
+supervisely-6.73.349.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+supervisely-6.73.349.dist-info/METADATA,sha256=OuZBH6eZb1yw77nA2ghY1OmGJ9ZPmki8IlMCPIE_2bU,33596
+supervisely-6.73.349.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
+supervisely-6.73.349.dist-info/entry_points.txt,sha256=U96-5Hxrp2ApRjnCoUiUhWMqijqh8zLR03sEhWtAcms,102
+supervisely-6.73.349.dist-info/top_level.txt,sha256=kcFVwb7SXtfqZifrZaSE3owHExX4gcNYe7Q2uoby084,28
+supervisely-6.73.349.dist-info/RECORD,,