supervisely 6.73.353__py3-none-any.whl → 6.73.355__py3-none-any.whl

supervisely/convert/image/image_helper.py

@@ -58,12 +58,11 @@ def validate_mimetypes(name: str, path: str) -> list:
     if new_img_ext == ".bin" or new_img_ext is None:
         new_img_ext = ".jpeg"
     new_img_name = f"{get_file_name(name)}{new_img_ext}"
-    logger.info(
-        f"Image {name} with mimetype {mimetype} will be converted to {new_img_ext}"
-    )
+    logger.info(f"Image {name} with mimetype {mimetype} will be converted to {new_img_ext}")
 
     return new_img_name
 
+
 def convert_to_jpg(path) -> tuple:
     """Convert image to jpg."""
 
@@ -79,6 +78,7 @@ def convert_to_jpg(path) -> tuple:
     silent_remove(path)
     return new_path
 
+
 def read_tiff_image(path: str) -> Union[np.ndarray, None]:
     """
     Read tiff image.
@@ -95,9 +95,7 @@ def read_tiff_image(path: str) -> Union[np.ndarray, None]:
         if image.ndim == 3:
             if tiff_shape[0] < tiff_shape[1] and tiff_shape[0] < tiff_shape[2]:
                 image = image.transpose(1, 2, 0)
-                logger.warning(
-                    f"{name}: transposed shape from {tiff_shape} to {image.shape}"
-                )
+                logger.warning(f"{name}: transposed shape from {tiff_shape} to {image.shape}")
 
     return image
 

supervisely/convert/volume/nii/nii_planes_volume_converter.py

@@ -71,7 +71,7 @@ class NiiPlaneStructuredConverter(NiiConverter, VolumeConverter):
 
         def create_empty_annotation(self):
             return VolumeAnnotation(self.volume_meta)
-        
+
     def __str__(self):
         return "nii_custom"
 
@@ -89,16 +89,20 @@ class NiiPlaneStructuredConverter(NiiConverter, VolumeConverter):
             for file in files:
                 path = os.path.join(root, file)
                 if is_nifti_file(path):
-                    full_name = get_file_name(path)
-                    if full_name.endswith(".nii"):
-                        full_name = get_file_name(full_name)
-                    prefix = full_name.split("_")[0]
-                    if prefix not in helper.PlanePrefix.values():
+                    name_parts = helper.parse_name_parts(file)
+                    if name_parts is None:
+                        logger.warning(
+                            f"File recognized as NIfTI, but failed to parse plane identifier from name. Path: {path}",
+                        )
                         continue
-                    if any(label_name in full_name for label_name in helper.LABEL_NAME):
-                        ann_dict[prefix].append(path)
-                    else:
-                        volumes_dict[prefix].append(path)
+
+                    dict_to_use = ann_dict if name_parts.is_ann else volumes_dict
+                    key = (
+                        name_parts.plane
+                        if name_parts.patient_uuid is None and name_parts.case_uuid is None
+                        else f"{name_parts.plane}_{name_parts.patient_uuid}_{name_parts.case_uuid}"
+                    )
+                    dict_to_use[key].append(path)
                 ext = get_file_ext(path)
                 if ext == ".txt":
                     cls_color_map = helper.read_cls_color_map(path)
@@ -106,22 +110,22 @@ class NiiPlaneStructuredConverter(NiiConverter, VolumeConverter):
                         logger.warning(f"Failed to read class color map from {path}.")
 
         self._items = []
-        for prefix, paths in volumes_dict.items():
+        for key, paths in volumes_dict.items():
             if len(paths) == 1:
                 item = self.Item(item_path=paths[0])
-                item.ann_data = ann_dict.get(prefix, [])
+                item.ann_data = ann_dict.get(key, [])
                 item.is_semantic = len(item.ann_data) == 1
                 if cls_color_map is not None:
                     item.custom_data["cls_color_map"] = cls_color_map
                 self._items.append(item)
             elif len(paths) > 1:
                 logger.info(
-                    f"Found {len(paths)} volumes with prefix {prefix}. Will try to match them by directories."
+                    f"Found {len(paths)} volumes with key {key}. Will try to match them by directories."
                 )
                 for path in paths:
                     item = self.Item(item_path=path)
                     possible_ann_paths = []
-                    for ann_path in ann_dict.get(prefix, []):
+                    for ann_path in ann_dict.get(key, []):
                         if Path(ann_path).parent == Path(path).parent:
                             possible_ann_paths.append(ann_path)
                     item.ann_data = possible_ann_paths
@@ -129,6 +133,7 @@ class NiiPlaneStructuredConverter(NiiConverter, VolumeConverter):
                     if cls_color_map is not None:
                         item.custom_data["cls_color_map"] = cls_color_map
                     self._items.append(item)
+
         self._meta = ProjectMeta()
         return self.items_count > 0
 
@@ -221,20 +226,22 @@ class NiiPlaneStructuredAnnotationConverter(NiiConverter, VolumeConverter):
         if json_map is not None:
             self._json_map = helper.read_json_map(json_map)
 
-        is_ann = lambda x: any(label_name in x for label_name in helper.LABEL_NAME)
+        is_nii = lambda x: any(x.endswith(ext) for ext in [".nii", ".nii.gz"])
         for root, _, files in os.walk(self._input_data):
             for file in files:
                 path = os.path.join(root, file)
-                if is_ann(file):
-                    prefix = get_file_name(path).split("_")[0]
-                    if prefix not in helper.PlanePrefix.values():
+                if is_nii(file):
+                    name_parts = helper.parse_name_parts(file)
+                    if name_parts is None or not name_parts.is_ann:
                         continue
                     try:
                         nii = load(path)
                     except filebasedimages.ImageFileError:
+                        logger.warning(f"Failed to load NIfTI file: {path}")
                         continue
                     item = self.Item(item_path=None, ann_data=path)
                     item.set_shape(nii.shape)
+                    item.custom_data["name_parts"] = name_parts
                     if cls_color_map is not None:
                         item.custom_data["cls_color_map"] = cls_color_map
                     self._items.append(item)
@@ -254,15 +261,11 @@ class NiiPlaneStructuredAnnotationConverter(NiiConverter, VolumeConverter):
         renamed_tags: dict = None,
     ) -> VolumeAnnotation:
         """Convert to Supervisely format."""
-        import re
         try:
             objs = []
             spatial_figures = []
             ann_path = item.ann_data
-            ann_idx = 0
-            match = re.search(r"_(\d+)(?:\.[^.]+)+$", ann_path)
-            if match:
-                ann_idx = int(match.group(1))
+            ann_idx = item.custom_data["name_parts"].ending_idx or 0
             for mask, pixel_id in helper.get_annotation_from_nii(ann_path):
                 class_id = pixel_id if item.is_semantic else ann_idx
                 class_name = f"Segment_{class_id}"
@@ -337,7 +340,6 @@ class NiiPlaneStructuredAnnotationConverter(NiiConverter, VolumeConverter):
             logger.info("Resulting dataset is empty. Removing it.")
             api.dataset.remove(dataset_id)
 
-
         if log_progress:
             if is_development():
                 progress.close()

supervisely/convert/volume/nii/nii_volume_converter.py

@@ -81,9 +81,9 @@ class NiiConverter(VolumeConverter):
                     if name.endswith(".nii"):
                         name = get_file_name(name)
                     nifti_dict[name] = path
-                    for prefix in planes_detected.keys():
-                        if name.startswith(prefix):
-                            planes_detected[prefix] = True
+                    for plane in planes_detected.keys():
+                        if plane in name:
+                            planes_detected[plane] = True
 
         if any(planes_detected.values()):
             return False

supervisely/convert/volume/nii/nii_volume_helper.py

@@ -72,6 +72,7 @@ def read_cls_color_map(path: str) -> dict:
         return None
     return cls_color_map
 
+
 def read_json_map(path: str) -> dict:
     import json
 
@@ -115,6 +116,7 @@ def get_annotation_from_nii(path: str) -> Generator[Mask3D, None, None]:
         mask = Mask3D(data == class_id)
         yield mask, class_id
 
+
 class AnnotationMatcher:
     def __init__(self, items, dataset_id):
         self._items = items
@@ -143,7 +145,9 @@ class AnnotationMatcher:
         if dataset_info.items_count > 0 and len(self._ann_paths.keys()) == 1:
             self._project_wide = False
         else:
-            datasets = {dsinfo.name: dsinfo for dsinfo in api.dataset.get_list(project_id, recursive=True)}
+            datasets = {
+                dsinfo.name: dsinfo for dsinfo in api.dataset.get_list(project_id, recursive=True)
+            }
             self._project_wide = True
 
         volumes = defaultdict(lambda: {})
@@ -164,86 +168,55 @@ class AnnotationMatcher:
         """Match annotation files with corresponding volumes using regex-based matching."""
         import re
 
-        def extract_prefix(ann_file):
-            import re
-            pattern = r'^(?P<prefix>cor|sag|axl).*?(?:' + "|".join(LABEL_NAME) + r')'
-            m = re.match(pattern, ann_file, re.IGNORECASE)
-            if m:
-                return m.group("prefix").lower()
-            return None
-
-        def is_volume_match(volume_name, prefix):
-            pattern = r'^' + re.escape(prefix) + r'.*?anatomic'
-            return re.match(pattern, volume_name, re.IGNORECASE) is not None
-
-        def find_best_volume_match(prefix, available_volumes):
-            candidates = {name: volume for name, volume in available_volumes.items() if is_volume_match(name, prefix)}
-            if not candidates:
-                return None, None
-
-            # Prefer an exact candidate
-            ann_name_no_ext = ann_file.split(".")[0]
-            exact_candidate = re.sub(r'(' + '|'.join(LABEL_NAME) + r')', 'anatomic', ann_name_no_ext, flags=re.IGNORECASE)
-            for name in candidates:
-                if re.fullmatch(re.escape(exact_candidate), name, re.IGNORECASE):
-                    return name, candidates[name]
-
-            # Otherwise, choose the candidate with the shortest name
-            best_match = sorted(candidates.keys(), key=len)[0]
-            return best_match, candidates[best_match]
-
         item_to_volume = {}
 
-        def process_annotation_file(ann_file, dataset_name, volumes):
-            prefix = extract_prefix(ann_file)
-            if prefix is None:
-                logger.warning(f"Failed to extract prefix from annotation file {ann_file}. Skipping.")
-                return
-
-            matched_name, matched_volume = find_best_volume_match(prefix, volumes)
-            if not matched_volume:
-                logger.warning(f"No matching volume found for annotation with prefix '{prefix}' in dataset {dataset_name}.")
-                return
-
-            # Retrieve the correct item based on matching mode.
-            item = (
-                self._item_by_path.get((dataset_name, ann_file))
-                if self._project_wide
-                else self._item_by_filename.get(ann_file)
-            )
-            if not item:
-                logger.warning(f"Item not found for annotation file {ann_file} in {'dataset ' + dataset_name if self._project_wide else 'single dataset mode'}.")
-                return
-
-            item_to_volume[item] = matched_volume
-            ann_file = ann_file.split(".")[0]
-            ann_supposed_match = re.sub(r'(' + '|'.join(LABEL_NAME) + r')', 'anatomic', ann_file, flags=re.IGNORECASE)
-            if matched_name.lower() != ann_supposed_match:
-                logger.debug(f"Fuzzy matched {ann_file} to volume {matched_name} using prefix '{prefix}'.")
-
         # Perform matching
         for dataset_name, volumes in self._volumes.items():
-            ann_files = self._ann_paths.get(dataset_name, []) if self._project_wide else list(self._ann_paths.values())[0]
+            volume_names = [parse_name_parts(name) for name in list(volumes.keys())]
+            _volume_names = [vol for vol in volume_names if vol is not None]
+            if len(_volume_names) == 0:
+                logger.warning(f"No valid volume names found in dataset {dataset_name}.")
+                continue
+            elif len(_volume_names) != len(volume_names):
+                logger.debug(f"Some volume names in dataset {dataset_name} could not be parsed.")
+            volume_names = _volume_names
+
+            ann_files = (
+                self._ann_paths.get(dataset_name, [])
+                if self._project_wide
+                else list(self._ann_paths.values())[0]
+            )
             for ann_file in ann_files:
-                process_annotation_file(ann_file, dataset_name, volumes)
+                ann_name = parse_name_parts(ann_file)
+                if ann_name is None:
+                    logger.warning(f"Failed to parse annotation name: {ann_file}")
+                    continue
+                match = find_best_volume_match_for_ann(ann_name, volume_names)
+                if match is not None:
+                    if match.plane != ann_name.plane:
+                        logger.warning(
+                            f"Plane mismatch: {match.plane} != {ann_name.plane} for {ann_file}. Skipping."
+                        )
+                        continue
+                    item_to_volume[self._item_by_filename[ann_file]] = volumes[match.full_name]
 
         # Mark volumes having only one matching item as semantic and validate shape.
         volume_to_items = defaultdict(list)
         for item, volume in item_to_volume.items():
             volume_to_items[volume.id].append(item)
-        
+
         for volume_id, items in volume_to_items.items():
             if len(items) == 1:
                 items[0].is_semantic = True
 
-        items_to_remove = []
+        # items_to_remove = []
         for item, volume in item_to_volume.items():
             volume_shape = tuple(volume.file_meta["sizes"])
             if item.shape != volume_shape:
                 logger.warning(f"Volume shape mismatch: {item.shape} != {volume_shape}")
                 # items_to_remove.append(item)
-        for item in items_to_remove:
-            del item_to_volume[item]
+        # for item in items_to_remove:
+        # del item_to_volume[item]
 
         return item_to_volume
 
@@ -304,3 +277,148 @@ class AnnotationMatcher:
                 items[0].is_semantic = True
 
         return item_to_volume
+
+
+NameParts = namedtuple(
+    "NameParts",
+    [
+        "full_name",
+        "name_no_ext",
+        "type",
+        "plane",
+        "is_ann",
+        "patient_uuid",
+        "case_uuid",
+        "ending_idx",
+    ],
+)
+
+
+def parse_name_parts(full_name: str) -> NameParts:
+    from uuid import UUID
+
+    name = get_file_name(full_name)
+    if name.endswith(".nii"):
+        name = get_file_name(name)
+    name_no_ext = name
+
+    type = None
+    is_ann = False
+    if VOLUME_NAME in full_name:
+        type = "anatomic"
+    else:
+        type = next((part for part in LABEL_NAME if part in full_name), None)
+        is_ann = type is not None
+
+    if type is None:
+        return
+
+    plane = None
+    for part in PlanePrefix.values():
+        if part in name:
+            plane = part
+            break
+
+    if plane is None:
+        return
+
+    is_ann = any(part in name.lower() for part in LABEL_NAME)
+
+    patient_uuid = None
+    case_uuid = None
+
+    if len(name_no_ext) > 73:
+        try:
+            uuids = name_no_ext[:73].split("_")
+            if len(uuids) != 2:
+                raise ValueError("Invalid UUID format")
+            patient_uuid = UUID(name_no_ext[:36])
+            case_uuid = UUID(name_no_ext[37:73])
+        except ValueError:
+            logger.debug(
+                f"Failed to parse UUIDs from name: {name_no_ext}.",
+                extra={"full_name": full_name},
+            )
+            patient_uuid = None
+            case_uuid = None
+
+    try:
+        ending_idx = name_no_ext.split("_")[-1]
+        if ending_idx.isdigit():
+            ending_idx = int(ending_idx)
+        else:
+            ending_idx = None
+    except ValueError:
+        ending_idx = None
+        logger.debug(
+            f"Failed to parse ending index from name: {name_no_ext}.",
+            extra={"full_name": full_name},
+        )
+
+    return NameParts(
+        full_name=full_name,
+        name_no_ext=name_no_ext,
+        type=type,
+        plane=plane,
+        is_ann=is_ann,
+        patient_uuid=patient_uuid,
+        case_uuid=case_uuid,
+        ending_idx=ending_idx,
+    )
+
+
+def find_best_volume_match_for_ann(ann, volumes):
+    """
+    Finds the best matching NameParts object from `volumes` for the given annotation NameParts `ann`.
+    Prefers an exact match where all fields except `type` are the same, and `type` is 'anatomic'.
+    Returns the matched NameParts object or None if not found.
+    """
+    volume_names = [volume.full_name for volume in volumes]
+    ann_name = ann.full_name
+    # Prefer exact match except for type
+    for vol in volumes:
+        if vol.name_no_ext == ann.name_no_ext.replace(ann.type, "anatomic"):
+            logger.debug(
+                "Found exact match for annotation.",
+                extra={"ann": ann_name, "vol": vol.full_name},
+            )
+            return vol
+
+    logger.debug(
+        "Failed to find exact match, trying to find a fallback match UUIDs.",
+        extra={"ann": ann_name, "volumes": volume_names},
+    )
+
+    # Fallback: match by plane and patient_uuid, type='anatomic'
+    for vol in volumes:
+        if (
+            vol.plane == ann.plane
+            and vol.patient_uuid == ann.patient_uuid
+            and vol.case_uuid == ann.case_uuid
+        ):
+            logger.debug(
+                "Found fallback match for annotation by UUIDs.",
+                extra={"ann": ann_name, "vol": vol.full_name},
+            )
+            return vol
+
+    logger.debug(
+        "Failed to find fallback match, trying to find a fallback match by plane.",
+        extra={"ann": ann_name, "volumes": volume_names},
+    )
+
+    # Fallback: match by plane and type='anatomic'
+    for vol in volumes:
+        if vol.plane == ann.plane:
+            logger.debug(
+                "Found fallback match for annotation by plane.",
+                extra={"ann": ann_name, "vol": vol.full_name},
+            )
+            return vol
+
+    logger.debug(
+        "Failed to find any match for annotation.",
+        extra={"ann": ann_name, "volumes": volume_names},
+    )
+
+    return None

supervisely/project/download.py

@@ -322,6 +322,8 @@ def download_fast(
     :type download_blob_files: :class:`bool`, optional
     :param project_info: Project info object. To avoid additional API requests.
     :type project_info: :class:`ProjectInfo`, optional
+    :param skip_create_readme: Skip creating README.md file. Default is False.
+    :type skip_create_readme: bool, optional
     :return: None
     :rtype: NoneType
 

supervisely/project/project.py

@@ -3323,6 +3323,8 @@ class Project:
         :param download_blob_files: Default is False. It will download images in classic way.
                                 If True, it will download blob files, if they are present in the project, to optimize download process.
         :type download_blob_files: bool, optional
+        :param skip_create_readme: Skip creating README.md file. Default is False.
+        :type skip_create_readme: bool, optional
         :return: None
         :rtype: NoneType
         :Usage example:
@@ -3926,6 +3928,8 @@ class Project:
         :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 skip_create_readme: Skip creating README.md file. Default is False.
+        :type skip_create_readme: bool, optional
         :return: None
         :rtype: NoneType
 
@@ -4217,6 +4221,7 @@ def _download_project(
     **kwargs,
 ):
     download_blob_files = kwargs.pop("download_blob_files", False)
+    skip_create_readme = kwargs.pop("skip_create_readme", False)
 
     dataset_ids = set(dataset_ids) if (dataset_ids is not None) else None
     project_fs = None
@@ -4456,14 +4461,15 @@ def _download_project(
         for item_name in dataset_fs.get_items_names():
             if item_name not in items_names_set:
                 dataset_fs.delete_item(item_name)
-    try:
-        if download_blob_files:
-            project_info = api.project.get_info_by_id(project_id)
-            create_blob_readme(project_fs=project_fs, project_info=project_info)
-        else:
-            create_readme(dest_dir, project_id, api)
-    except Exception as e:
-        logger.info(f"There was an error while creating README: {e}")
+    if not skip_create_readme:
+        try:
+            if download_blob_files:
+                project_info = api.project.get_info_by_id(project_id)
+                create_blob_readme(project_fs=project_fs, project_info=project_info)
+            else:
+                create_readme(dest_dir, project_id, api)
+        except Exception as e:
+            logger.info(f"There was an error while creating README: {e}")
 
 
 def upload_project(
@@ -4722,6 +4728,8 @@ def download_project(
     :param download_blob_files: Default is False. It will download images in classic way.
                                 If True, it will download blob files, if they are present in the project, to optimize download process.
     :type download_blob_files: bool, optional
+    :param skip_create_readme: Skip creating README.md file. Default is False.
+    :type skip_create_readme: bool, optional
     :return: None.
     :rtype: NoneType
     :Usage example:
@@ -4806,6 +4814,9 @@ def _download_project_optimized(
     images_ids: List[int] = None,
     **kwargs,
 ):
+
+    skip_create_readme = kwargs.pop("skip_create_readme", False)
+
     project_info = api.project.get_info_by_id(project_id)
     project_id = project_info.id
     logger.info("Annotations are not cached (always download latest version from server)")
@@ -4851,11 +4862,11 @@ def _download_project_optimized(
                 save_images=save_images,
                 images_ids=images_ids,
             )
-
-    try:
-        create_readme(project_dir, project_id, api)
-    except Exception as e:
-        logger.info(f"There was an error while creating README: {e}")
+    if not skip_create_readme:
+        try:
+            create_readme(project_dir, project_id, api)
+        except Exception as e:
+            logger.info(f"There was an error while creating README: {e}")
 
 
 def _split_images_by_cache(images, cache):
@@ -5311,7 +5322,7 @@ def _project_info_md(project_info: sly.ProjectInfo) -> str:
 
 
 def _dataset_structure_md(
-    project_info: sly.ProjectInfo, api: sly.Api, entity_limit: Optional[int] = 10
+    project_info: sly.ProjectInfo, api: sly.Api, entity_limit: Optional[int] = 4
 ) -> str:
     """Creates a markdown string with the dataset structure of the project.
     Supports only images and videos projects.
@@ -5321,6 +5332,7 @@ def _dataset_structure_md(
     :param api: Supervisely API address and token.
     :type api: :class:`Api<supervisely.api.api.Api>`
     :param entity_limit: The maximum number of entities to display in the README.
+                        This is the limit for top level datasets and items in the dataset at the same time.
     :type entity_limit: int, optional
     :return: Markdown string with the dataset structure of the project.
     :rtype: str
@@ -5347,28 +5359,76 @@ def _dataset_structure_md(
 
     result_md = f"🗂️ {project_info.name}<br>"
 
-    # if project_info
+    # Build a dataset hierarchy tree
+    dataset_tree = {}
+    root_datasets = []
 
     for parents, dataset_info in api.dataset.tree(project_info.id):
-        # The dataset path is needed to create a clickable link in the README.
-        dataset_path = Dataset._get_dataset_path(dataset_info.name, parents)
-        basic_indent = "┃ " * len(parents)
-        result_md += (
-            basic_indent + "┣ " + dataset_icon + f"[{dataset_info.name}]({dataset_path})" + "<br>"
+        level = len(parents)
+        parent_id = dataset_info.parent_id
+
+        if level == 0:  # Root dataset
+            root_datasets.append(dataset_info)
+
+        dataset_tree[dataset_info.id] = {
+            "info": dataset_info,
+            "path": Dataset._get_dataset_path(dataset_info.name, parents),
+            "level": level,
+            "parents": parents,
+            "children": [],
+        }
+
+    # Connect parents with children
+    for ds_id, ds_data in dataset_tree.items():
+        parent_id = ds_data["info"].parent_id
+        if parent_id in dataset_tree:
+            dataset_tree[parent_id]["children"].append(ds_id)
+
+    # Display only top entity_limit root datasets
+    if len(root_datasets) > entity_limit:
+        root_datasets = root_datasets[:entity_limit]
+        result_md += f"(Showing only {entity_limit} top-level datasets)<br>"
+
+    # Function to render a dataset and its children up to a certain depth
+    def render_dataset(ds_id, current_depth=0, max_depth=2):
+        if current_depth > max_depth:
+            return
+
+        ds_data = dataset_tree[ds_id]
+        ds_info = ds_data["info"]
+        basic_indent = "┃ " * current_depth
+
+        # Render the dataset
+        result_md.append(
+            basic_indent + "┣ " + dataset_icon + f"[{ds_info.name}]({ds_data['path']})" + "<br>"
         )
-        entity_infos = list_function(dataset_info.id)
+
+        # Render items in the dataset
+        entity_infos = list_function(ds_info.id)
         for idx, entity_info in enumerate(entity_infos):
             if idx == entity_limit:
-                result_md += (
+                result_md.append(
                     basic_indent + "┃ ┗ ... " + str(len(entity_infos) - entity_limit) + " more<br>"
                 )
                 break
             symbol = "┗" if idx == len(entity_infos) - 1 else "┣"
-            result_md += (
-                "┃ " * (len(parents) + 1) + symbol + entity_icon + entity_info.name + "<br>"
-            )
+            result_md.append(basic_indent + "┃ " + symbol + entity_icon + entity_info.name + "<br>")
 
-    return result_md
+        # Render children (limited to entity_limit)
+        children = ds_data["children"]
+        if len(children) > entity_limit:
+            children = children[:entity_limit]
+            result_md.append(basic_indent + f"┃ (Showing only {entity_limit} child datasets)<br>")
+
+        for child_id in children:
+            render_dataset(child_id, current_depth + 1, max_depth)
+
+    # Render each root dataset
+    result_md = [result_md]  # Convert to list for appending in the recursive function
+    for root_ds in root_datasets:
+        render_dataset(root_ds.id)
+
+    return "".join(result_md)
 
 
 async def _download_project_async(
@@ -5401,6 +5461,8 @@ async def _download_project_async(
     batch_size = kwargs.get("batch_size", 100)
     # control whether to download blob files
     download_blob_files = kwargs.get("download_blob_files", False)
+    # control whether to create README file
+    skip_create_readme = kwargs.get("skip_create_readme", False)
 
     if semaphore is None:
         semaphore = api.get_default_semaphore()
@@ -5631,15 +5693,15 @@ async def _download_project_async(
         for item_name in dataset_fs.get_items_names():
             if item_name not in items_names_set:
                 dataset_fs.delete_item(item_name)
-
-    try:
-        if download_blob_files:
-            project_info = api.project.get_info_by_id(project_id)
-            create_blob_readme(project_fs=project_fs, project_info=project_info)
-        else:
-            create_readme(dest_dir, project_id, api)
-    except Exception as e:
-        logger.info(f"There was an error while creating README: {e}")
+    if not skip_create_readme:
+        try:
+            if download_blob_files:
+                project_info = api.project.get_info_by_id(project_id)
+                create_blob_readme(project_fs=project_fs, project_info=project_info)
+            else:
+                create_readme(dest_dir, project_id, api)
+        except Exception as e:
+            logger.info(f"There was an error while creating README: {e}")
 
 
 async def _download_project_item_async(

supervisely/project/video_project.py

@@ -1182,6 +1182,7 @@ class VideoProject(Project):
         log_progress: bool = True,
         progress_cb: Optional[Union[tqdm, Callable]] = None,
         include_custom_data: bool = False,
+        **kwargs,
     ) -> None:
         """
         Download video project from Supervisely to the given directory asynchronously.
@@ -1224,7 +1225,7 @@ class VideoProject(Project):
 
             coroutine = sly.VideoProject.download_async(api, project_id, save_directory)
             run_coroutine(coroutine)
-            
+
         """
         await download_video_project_async(
             api=api,
@@ -1237,6 +1238,7 @@ class VideoProject(Project):
             log_progress=log_progress,
             progress_cb=progress_cb,
             include_custom_data=include_custom_data,
+            **kwargs,
         )
 
 
@@ -1468,7 +1470,7 @@ def upload_video_project(
             parent_id = dataset_map.get(parent)
         else:
             parent = ""
-            parent_id = None      
+            parent_id = None
         dataset = api.dataset.create(project.id, dataset_fs.short_name, parent_id=parent_id)
         dataset_map[os.path.join(parent, dataset.name)] = dataset.id
 
@@ -1547,6 +1549,7 @@ async def download_video_project_async(
     log_progress: bool = True,
     progress_cb: Optional[Union[tqdm, Callable]] = None,
     include_custom_data: Optional[bool] = False,
+    **kwargs,
 ) -> None:
     """
     Download video project to the local directory.

{supervisely-6.73.353.dist-info → supervisely-6.73.355.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: supervisely
-Version: 6.73.353
+Version: 6.73.355
 Summary: Supervisely Python SDK.
 Home-page: https://github.com/supervisely/supervisely
 Author: Supervisely
@@ -34,7 +34,7 @@ Requires-Dist: bidict<1.0.0,>=0.21.2
 Requires-Dist: varname<1.0.0,>=0.8.1
 Requires-Dist: python-dotenv<=1.0.0,>=0.19.2
 Requires-Dist: pynrrd<1.0.0,>=0.4.2
-Requires-Dist: SimpleITK<3.0.0.0,>=2.1.1.2
+Requires-Dist: SimpleITK<=2.4.1.0,>=2.1.1.2
 Requires-Dist: pydicom<3.0.0,>=2.3.0
 Requires-Dist: stringcase<2.0.0,>=1.2.0
 Requires-Dist: python-magic<1.0.0,>=0.4.25

{supervisely-6.73.353.dist-info → supervisely-6.73.355.dist-info}/RECORD

@@ -570,7 +570,7 @@ supervisely/convert/base_converter.py,sha256=O2SP4I_Hd0aSn8kbOUocy8orkc_-iD-TQ-z
 supervisely/convert/converter.py,sha256=022I1UieyaPDVb8lOcKW20jSt1_1TcbIWhghSmieHAE,10885
 supervisely/convert/image/__init__.py,sha256=JEuyaBiiyiYmEUYqdn8Mog5FVXpz0H1zFubKkOOm73I,1395
 supervisely/convert/image/image_converter.py,sha256=8vak8ZoKTN1ye2ZmCTvCZ605-Rw1AFLIEo7bJMfnR68,10426
-supervisely/convert/image/image_helper.py,sha256=j1HqgmCiUIOBft43OkdPSOxQD8aB7zWXPmOXNvzP6j4,3697
+supervisely/convert/image/image_helper.py,sha256=VfFJmMEdMTOZ-G15lFEYUuFC0z62aHWrw8MLigxJS58,3647
 supervisely/convert/image/cityscapes/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 supervisely/convert/image/cityscapes/cityscapes_converter.py,sha256=tnelQJHvGz_IGMXWe-EKWAkBhexRzmkv_0Kln5sN12E,8100
 supervisely/convert/image/cityscapes/cityscapes_helper.py,sha256=in5nR7__q_u5dCkVtZmynfZ_ZuvsIAHrTzyTG4EvNgU,2988
@@ -665,9 +665,9 @@ supervisely/convert/volume/dicom/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRk
 supervisely/convert/volume/dicom/dicom_converter.py,sha256=Hw4RxU_qvllk6M26udZE6G-m1RWR8-VVPcEPwFlqrVg,3354
 supervisely/convert/volume/dicom/dicom_helper.py,sha256=OrKlyt1hA5BOXKhE1LF1WxBIv3b6t96xRras4OSAuNM,2891
 supervisely/convert/volume/nii/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-supervisely/convert/volume/nii/nii_planes_volume_converter.py,sha256=TrV7Mkczt8w2WpJizmOZwqeG9zlcLy-8p4D22B9nYyo,14344
-supervisely/convert/volume/nii/nii_volume_converter.py,sha256=n8HWRvwXUzugTQt4PKpbSacsuC4EQxoYHAWXcXC5KE8,8526
-supervisely/convert/volume/nii/nii_volume_helper.py,sha256=8cS1LCvDcgGuinBARTmbOm-lLQmJ___3gyemt26W_-Y,11572
+supervisely/convert/volume/nii/nii_planes_volume_converter.py,sha256=dXoBA8AYUOEjLpV2cZJ5n1HDq4_gNhnD__NVsgfc_Qc,14551
+supervisely/convert/volume/nii/nii_volume_converter.py,sha256=BAOKX96-bp6WfTFLrCQNrXk2YhKqIFSU5LJ-auKiAfc,8514
+supervisely/convert/volume/nii/nii_volume_helper.py,sha256=ME_2bgbKZg4IYDFOYqhGRdt7LbwigdF2p6oSgPgPWpw,14132
 supervisely/convert/volume/sly/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 supervisely/convert/volume/sly/sly_volume_converter.py,sha256=XmSuxnRqxchG87b244f3h0UHvOt6IkajMquL1drWlCM,5595
 supervisely/convert/volume/sly/sly_volume_helper.py,sha256=gUY0GW3zDMlO2y-zQQG36uoXMrKkKz4-ErM1CDxFCxE,5620
@@ -1018,16 +1018,16 @@ 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=N6UEXY_eLtzjz61Y2SaJLg2-vv_Cvp9cXCUUM9R8-d8,27677
+supervisely/project/download.py,sha256=Veu1wNt1ho-flOPo5-z55nBm5OlkxxqzqOyccjq7dsg,27801
 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
+supervisely/project/project.py,sha256=k0eE6Jy9eDYO-WUbDK0a-IVA34VVWYRzMBVkPY9XdGw,235812
 supervisely/project/project_meta.py,sha256=26s8IiHC5Pg8B1AQi6_CrsWteioJP2in00cRNe8QlW0,51423
 supervisely/project/project_settings.py,sha256=NLThzU_DCynOK6hkHhVdFyezwprn9UqlnrLDe_3qhkY,9347
 supervisely/project/project_type.py,sha256=7mQ7zg6r7Bm2oFn5aR8n_PeLqMmOaPZd6ph7Z8ZISTw,608
 supervisely/project/readme_template.md,sha256=NKYEoJubNWLV_HmhVmdB6L4dneLqDkvl2b71xy5fc54,9150
 supervisely/project/upload.py,sha256=AjgHYgVZwUE25ygC5pqvFjdAladbyB8T78mlet5Qpho,3750
-supervisely/project/video_project.py,sha256=bkQI3JTimQR-83iWAThjoz7bTcbCIqvvk039AG3BPXc,64081
+supervisely/project/video_project.py,sha256=_WsVdIdGZ_VFaXEVs6_Y46YYOzeJpvt82X4rOkt40nk,64117
 supervisely/project/volume_project.py,sha256=Kn9VEvWuKKZvL2nx6B6bjSvHuoZhAOxEc6DvPRexUco,22666
 supervisely/pyscripts_utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 supervisely/pyscripts_utils/utils.py,sha256=scEwHJvHRQa8NHIOn2eTwH6-Zc8CGdLoxM-WzH9jcRo,314
@@ -1083,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.353.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-supervisely-6.73.353.dist-info/METADATA,sha256=U-dj-ZEJnbbIuHQrW8dU2-_iXFK54VhmQFno01bC9so,33597
-supervisely-6.73.353.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
-supervisely-6.73.353.dist-info/entry_points.txt,sha256=U96-5Hxrp2ApRjnCoUiUhWMqijqh8zLR03sEhWtAcms,102
-supervisely-6.73.353.dist-info/top_level.txt,sha256=kcFVwb7SXtfqZifrZaSE3owHExX4gcNYe7Q2uoby084,28
-supervisely-6.73.353.dist-info/RECORD,,
+supervisely-6.73.355.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+supervisely-6.73.355.dist-info/METADATA,sha256=DE9HbZdlEcZ9MLqTf-5GBkvaY6kYoomrBKAAK_8Od60,33598
+supervisely-6.73.355.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
+supervisely-6.73.355.dist-info/entry_points.txt,sha256=U96-5Hxrp2ApRjnCoUiUhWMqijqh8zLR03sEhWtAcms,102
+supervisely-6.73.355.dist-info/top_level.txt,sha256=kcFVwb7SXtfqZifrZaSE3owHExX4gcNYe7Q2uoby084,28
+supervisely-6.73.355.dist-info/RECORD,,