Docstring change

Author: hovnatan

superannotate/consensus_benchmark/consensus.py

@@ -23,8 +23,8 @@ def consensus(
 ):
     """Computes consensus score for each instance of given images that are present in at least 2 of the given projects:    
     
-    :param project: project name or metadata of the project
-    :type project: str or dict
+    :param project: project name
+    :type project: str
     :param folder_names: list of folder names in the project for which the scores will be computed
     :type folder_names: list of str
     :param export_root: root export path of the projects

superannotate/db/annotation_classes.py

@@ -20,8 +20,8 @@
 def create_annotation_class(project, name, color, attribute_groups=None):
     """Create annotation class in project
 
-    :param project: project name or metadata of the project
-    :type project: str or dict
+    :param project: project name
+    :type project: str
     :param name: name for the class
     :type name: str
     :param color: RGB hex color value, e.g., "#FFFFAA"
@@ -82,8 +82,8 @@ def create_annotation_class(project, name, color, attribute_groups=None):
 def delete_annotation_class(project, annotation_class):
     """Deletes annotation class from project
 
-    :param project: project name or metadata of the project
-    :type project: str or dict
+    :param project: project name
+    :type project: str
     :param project: annotation class name or  metadata
     :type project: str or dict
     """
@@ -119,8 +119,8 @@ def create_annotation_classes_from_classes_json(
     """Creates annotation classes in project from a SuperAnnotate format
     annotation classes.json.
 
-    :param project: project name or metadata of the project
-    :type project: str or dict
+    :param project: project name
+    :type project: str
     :param classes_json: JSON itself or path to the JSON file
     :type classes_json: list or Pathlike (str or Path)
     :param from_s3_bucket: AWS S3 bucket to use. If None then classes_json is in local filesystem
@@ -203,8 +203,8 @@ def del_unn(d):
 def search_annotation_classes(project, name_prefix=None):
     """Searches annotation classes by name_prefix (case-insensitive)
 
-    :param project: project name or metadata of the project
-    :type project: str or dict
+    :param project: project name
+    :type project: str
     :param name_prefix: name prefix for search. If None all annotation classes
      will be returned
     :type name_prefix: str
@@ -242,8 +242,8 @@ def search_annotation_classes(project, name_prefix=None):
 def get_annotation_class_metadata(project, annotation_class_name):
     """Returns annotation class metadata
 
-    :param project: project name or metadata of the project
-    :type project: str or dict
+    :param project: project name
+    :type project: str
     :param annotation_class_name: annotation class name
     :type annotation_class_name: str
 
@@ -275,8 +275,8 @@ def get_annotation_class_metadata(project, annotation_class_name):
 def download_annotation_classes_json(project, folder):
     """Downloads project classes.json to folder
 
-    :param project: project name or metadata of the project
-    :type project: str or dict
+    :param project: project name
+    :type project: str
     :param folder: folder to download to
     :type folder: Pathlike (str or Path)
 

superannotate/db/exports.py

@@ -28,8 +28,8 @@
 def get_export_metadata(project, export_name):
     """Returns project metadata
 
-    :param project: project name or metadata of the project
-    :type project: str or dict
+    :param project: project name
+    :type project: str
     :param export_name: export name
     :type project: str
 
@@ -58,8 +58,8 @@ def get_export_metadata(project, export_name):
 def get_exports(project, return_metadata=False):
     """Get all prepared exports of the project.
 
-    :param project: project name or metadata of the project
-    :type project: str or dict
+    :param project: project name
+    :type project: str
     :param return_metadata: return metadata of images instead of names
     :type return_metadata: bool
 
@@ -106,8 +106,10 @@ def prepare_export(
     """Prepare annotations and classes.json for export. Original and fused images for images with
     annotations can be included with include_fuse flag.
 
-    :param project: project name or metadata of the project
-    :type project: str or dict
+    :param project: project name
+    :type project: str
+    :param folder_names: names of folders to include in the export. If None, whole project will be exported
+    :type project: list of str
     :param annotation_statuses: images with which status to include, if None, [ "InProgress", "QualityCheck", "Returned", "Completed"] will be chose
            list elements should be one of NotStarted InProgress QualityCheck Returned Completed Skipped
     :type annotation_statuses: list of strs
@@ -209,10 +211,10 @@ def download_export(
     WARNING: Starting from version 1.9.0 :ref:`download_export <ref_download_export>` additionally
     requires :py:obj:`project` as first argument.
 
-    :param project: project name or metadata of the project
-    :type project: str or dict
-    :param export: export name or metadata of the prepared export
-    :type export: str or dict
+    :param project: project name
+    :type project: str
+    :param export: export name
+    :type export: str
     :param folder_path: where to download the export
     :type folder_path: Pathlike (str or Path)
     :param extract_zip_contents: if False then a zip file will be downloaded,

superannotate/db/images.py

@@ -40,8 +40,8 @@ def search_images(
 ):
     """Search images by name_prefix (case-insensitive) and annotation status
 
-    :param project: project name or metadata of the project
-    :type project: str or dict
+    :param project: project name or folder path (e.g., "project1/folder1")
+    :type project: str
     :param image_name_prefix: image name prefix for search
     :type image_name_prefix: str
     :param annotation_status: if not None, annotation statuses of images to filter,
@@ -119,8 +119,8 @@ def process_result(x):
 def get_image_metadata(project, image_names, return_dict_on_single_output=True):
     """Returns image metadata
 
-    :param project: project name or metadata of the project
-    :type project: str or dict
+    :param project: project name or folder path (e.g., "project1/folder1")
+    :type project: str
     :param image_name: image name
     :type image: str
 
@@ -186,8 +186,8 @@ def get_image_metadata(project, image_names, return_dict_on_single_output=True):
 def set_image_annotation_status(project, image_name, annotation_status):
     """Sets the image annotation status
 
-    :param project: project name or metadata of the project
-    :type project: str or dict
+    :param project: project name or folder path (e.g., "project1/folder1")
+    :type project: str
     :param image_name: image name
     :type image: str
     :param annotation_status: annotation status to set,
@@ -229,8 +229,8 @@ def add_annotation_comment_to_image(
 ):
     """Add a comment to SuperAnnotate format annotation JSON
 
-    :param project: project name or metadata of the project
-    :type project: str or dict
+    :param project: project name or folder path (e.g., "project1/folder1")
+    :type project: str
     :param image_name: image name
     :type image: str
     :param comment_text: comment text
@@ -265,8 +265,8 @@ def add_annotation_bbox_to_image(
 
     annotation_class_attributes has the form [ {"name" : "<attribute_value>" }, "groupName" : "<attribute_group>"} ], ... ]
 
-    :param project: project name or metadata of the project
-    :type project: str or dict
+    :param project: project name or folder path (e.g., "project1/folder1")
+    :type project: str
     :param image_name: image name
     :type image: str
     :param bbox: 4 element list of top-left x,y and bottom-right x, y coordinates
@@ -301,8 +301,8 @@ def add_annotation_polygon_to_image(
 
     annotation_class_attributes has the form [ {"name" : "<attribute_value>", "groupName" : "<attribute_group>"},  ... ]
 
-    :param project: project name or metadata of the project
-    :type project: str or dict
+    :param project: project name or folder path (e.g., "project1/folder1")
+    :type project: str
     :param image_name: image name
     :type image: str
     :param polygon: [x1,y1,x2,y2,...] list of coordinates
@@ -335,8 +335,8 @@ def add_annotation_polyline_to_image(
 
     annotation_class_attributes has the form [ {"name" : "<attribute_value>", "groupName" : "<attribute_group>"},  ... ]
 
-    :param project: project name or metadata of the project
-    :type project: str or dict
+    :param project: project name or folder path (e.g., "project1/folder1")
+    :type project: str
     :param image_name: image name
     :type image: str
     :param polyline: [x1,y1,x2,y2,...] list of coordinates
@@ -368,8 +368,8 @@ def add_annotation_point_to_image(
 
     annotation_class_attributes has the form [ {"name" : "<attribute_value>", "groupName" : "<attribute_group>"},  ... ]
 
-    :param project: project name or metadata of the project
-    :type project: str or dict
+    :param project: project name or folder path (e.g., "project1/folder1")
+    :type project: str
     :param image_name: image name
     :type image: str
     :param point: [x,y] list of coordinates
@@ -401,8 +401,8 @@ def add_annotation_ellipse_to_image(
 
     annotation_class_attributes has the form [ {"name" : "<attribute_value>", "groupName" : "<attribute_group>"},  ... ]
 
-    :param project: project name or metadata of the project
-    :type project: str or dict
+    :param project: project name or folder path (e.g., "project1/folder1")
+    :type project: str
     :param image_name: image name
     :type image: str
     :param ellipse: [center_x, center_y, r_x, r_y, angle] list of coordinates and angle
@@ -435,8 +435,8 @@ def add_annotation_template_to_image(
 
     annotation_class_attributes has the form [ {"name" : "<attribute_value>", "groupName" : "<attribute_group>"},  ... ]
 
-    :param project: project name or metadata of the project
-    :type project: str or dict
+    :param project: project name or folder path (e.g., "project1/folder1")
+    :type project: str
     :param image_name: image name
     :type image: str
     :param template_points: [x1,y1,x2,y2,...] list of coordinates
@@ -474,8 +474,8 @@ def add_annotation_cuboid_to_image(
 
     annotation_class_attributes has the form [ {"name" : "<attribute_value>", "groupName" : "<attribute_group>"},  ... ]
 
-    :param project: project name or metadata of the project
-    :type project: str or dict
+    :param project: project name or folder path (e.g., "project1/folder1")
+    :type project: str
     :param image_name: image name
     :type image: str
     :param cuboid: [x_front_tl,y_front_tl,x_front_br,y_front_br,
@@ -509,8 +509,8 @@ def download_image(
 ):
     """Downloads the image (and annotation if not None) to local_dir_path
 
-    :param project: project name or metadata of the project
-    :type project: str or dict
+    :param project: project name or folder path (e.g., "project1/folder1")
+    :type project: str
     :param image_name: image name
     :type image: str
     :param local_dir_path: where to download the image
@@ -569,8 +569,8 @@ def download_image(
 def delete_image(project, image_name):
     """Deletes image
 
-    :param project: project name or metadata of the project
-    :type project: str or dict
+    :param project: project name or folder path (e.g., "project1/folder1")
+    :type project: str
     :param image_name: image name
     :type image: str
     """
@@ -592,8 +592,8 @@ def get_image_bytes(project, image_name, variant='original'):
     """Returns an io.BytesIO() object of the image. Suitable for creating
     PIL.Image out of it.
 
-    :param project: project name or metadata of the project
-    :type project: str or dict
+    :param project: project name or folder path (e.g., "project1/folder1")
+    :type project: str
     :param image_name: image name
     :type image: str
     :param variant: which resolution to get, can be 'original' or 'lores'
@@ -640,8 +640,8 @@ def get_image_bytes(project, image_name, variant='original'):
 def get_image_preannotations(project, image_name):
     """Get pre-annotations of the image. Only works for "vector" projects.
 
-    :param project: project name or metadata of the project
-    :type project: str or dict
+    :param project: project name or folder path (e.g., "project1/folder1")
+    :type project: str
     :param image_name: image name
     :type image: str
 
@@ -658,8 +658,8 @@ def get_image_preannotations(project, image_name):
 def get_image_annotations(project, image_name):
     """Get annotations of the image.
 
-    :param project: project name or metadata of the project
-    :type project: str or dict
+    :param project: project name or folder path (e.g., "project1/folder1")
+    :type project: str
     :param image_name: image name
     :type image: str
 
@@ -758,8 +758,8 @@ def download_image_annotations(project, image_name, local_dir_path):
     """Downloads annotations of the image (JSON and mask if pixel type project)
     to local_dir_path.
 
-    :param project: project name or metadata of the project
-    :type project: str or dict
+    :param project: project name or folder path (e.g., "project1/folder1")
+    :type project: str
     :param image_name: image name
     :type image: str
     :param local_dir_path: local directory path to download to
@@ -814,8 +814,8 @@ def download_image_preannotations(project, image_name, local_dir_path):
     """Downloads pre-annotations of the image to local_dir_path.
     Only works for "vector" projects.
 
-    :param project: project name or metadata of the project
-    :type project: str or dict
+    :param project: project name or folder path (e.g., "project1/folder1")
+    :type project: str
     :param image_name: image name
     :type image: str
     :param local_dir_path: local directory path to download to
@@ -835,8 +835,8 @@ def upload_image_annotations(
     """Upload annotations from JSON (also mask for pixel annotations)
     to the image.
 
-    :param project: project name or metadata of the project
-    :type project: str or dict
+    :param project: project name or folder path (e.g., "project1/folder1")
+    :type project: str
     :param image_name: image name
     :type image: str
     :param annotation_json: annotations in SuperAnnotate format JSON dict or path to JSON file

superannotate/db/project_api.py

@@ -152,8 +152,8 @@ def search_folders(project, folder_name=None, return_metadata=False):
 def create_folder(project, folder_name):
     """Create a new folder in the project.
 
-    :param project: project name or metadata of the project
-    :type project: str or dict
+    :param project: project name
+    :type project: str
     :param folder_name: the new folder's name
     :type folder_name: str
 
@@ -184,13 +184,11 @@ def create_folder(project, folder_name):
 def delete_folders(project, folder_names):
     """Delete folder in project.
 
-    :param project: project name or metadata of the project to be deleted
-    :type project: str or dict
+    :param project: project name
+    :type project: str
     :param folder_names: to be deleted folders' names
     :type folder_names: str or list of strs
     """
-    if isinstance(folder_names, str):
-        folder_names = [folder_names]
     if not isinstance(project, dict):
         project = get_project_metadata_bare(project)
     all_folders_metadata = search_folders(project, return_metadata=True)
@@ -218,8 +216,8 @@ def delete_folders(project, folder_names):
 def rename_folder(project, new_folder_name):
     """Renames folder in project.
 
-    :param project: project name or metadata of the project to be deleted
-    :type project: str or dict
+    :param project: project name or folder path (e.g., "project1/folder1")
+    :type project: str
     :param new_folder_name: folder's new name
     :type new_folder_name: str
     """