Merge branch 'master' of https://github.com/superannotateai/superannotate-python-sdk

Author: agyurjin

docs/source/superannotate.sdk.rst

@@ -333,6 +333,7 @@ ________________________
 .. autofunction:: superannotate.df_to_annotations
 .. _ref_filter_annotation_instances:
 .. autofunction:: superannotate.filter_annotation_instances
+.. autofunction:: superannotate.filter_images_by_comments
 
 ----------
 

docs/source/tutorial.sdk.rst

@@ -368,7 +368,7 @@ Example of created DataFrame:
 Each row represents annotation information. One full annotation with multiple
 attribute groups can be grouped under :code:`instanceId` field.
 
-A helper function :ref:`filter_annotation_instances <ref_filter_annotation_instances>` to annotation instances by their class or attribute from the DataFrame is available. E.g., to get annotations that have annotation class :code:`Human` and attribute  :code:`"height" : "tall"`  that are **not** of type :code:`polygon`:
+A helper function :ref:`filter_annotation_instances <ref_filter_annotation_instances>` is available to filter annotation instances by their class, attribute, type or error fields from the DataFrame. E.g., to get annotations that have annotation class :code:`Human` and attribute  :code:`"height" : "tall"`  that are **not** of type :code:`polygon`:
 
 .. code-block:: python
 

superannotate/__init__.py

@@ -21,7 +21,9 @@
     image_path_to_annotation_paths, project_type_int_to_str,
     project_type_str_to_int, user_role_str_to_int
 )
-from .dataframe_filtering import filter_annotation_instances, filter_comments
+from .dataframe_filtering import (
+    filter_annotation_instances, filter_images_by_comments
+)
 from .db.annotation_classes import (
     create_annotation_class, create_annotation_classes_from_classes_json,
     delete_annotation_class, download_annotation_classes_json,

superannotate/dataframe_filtering.py

@@ -1,28 +1,51 @@
 import pandas as pd
 
 
-def filter_comments(annotations_df, resolved=False):
-    """Filter comments on resolve status
+def filter_images_by_comments(
+    annotations_df,
+    include_unresolved_comments=True,
+    include_resolved_comments=False,
+    include_without_comments=False
+):
+    """Filter images on comment resolve status and comment resolve status
 
     :param annotations_df: pandas DataFrame of project annotations
     :type annotations_df: pandas.DataFrame
-    :param resolved: resolved criterion
-    :type resolved: bool
-
-    :return: filtered DataFrame
-    :rtype: pandas.DataFrame
+    :param include_unresolved_comments: include images with unresolved state
+    :type include_unresolved_comments: bool
+    :param include_resolved_comments: include images with resolved state
+    :type include_resolved_comments: bool
+    :param include_resolved_comments: include images with resolved state
+    :type include_resolved_comments: bool
+    :param include_without_comments: include images without any comments
+    :type include_without_comments: bool
+
+    :return: filtered image names
+    :rtype: list of strs
 
     """
+    images = set()
     df = annotations_df[annotations_df["type"] == "comment"]
-    df = df[df["commentResolved"] == resolved]
-
-    return df
+    if include_unresolved_comments:
+        images.update(
+            df[df["commentResolved"] == False]["imageName"].dropna().unique()
+        )
+    if include_resolved_comments:
+        images.update(
+            df[df["commentResolved"] == True]["imageName"].dropna().unique()
+        )
+    if include_without_comments:
+        all_images = set(annotations_df["imageName"].dropna().unique())
+        with_comments = set(df["imageName"].dropna().unique())
+        images.update(all_images - with_comments)
+
+    return list(images)
 
 
 def filter_annotation_instances(annotations_df, include=None, exclude=None):
     """Filter annotation instances from project annotations pandas DataFrame.
 
-    include and exclude rulses should be a list of rules of following type: [{"className": "<className>", "type" : "<bbox, polygon,...>", "attributes" : [{"name" : "<attribute_value>", "groupName" : "<attribute_group_name>"},...]},...]
+    include and exclude rulses should be a list of rules of following type: [{"className": "<className>", "type" : "<bbox, polygon,...>", "error": <True or False>, "attributes" : [{"name" : "<attribute_value>", "groupName" : "<attribute_group_name>"},...]},...]
 
 
     :param annotations_df: pandas DataFrame of project annotations
@@ -52,6 +75,8 @@ def filter_annotation_instances(annotations_df, include=None, exclude=None):
                     ) & (df_new["attributeName"] == attribute["name"])]
             if "type" in include_rule:
                 df_new = df_new[df_new["type"] == include_rule["type"]]
+            if "error" in include_rule:
+                df_new = df_new[df_new["error"] == include_rule["error"]]
             included_dfs.append(df_new)
 
         df = pd.concat(included_dfs)
@@ -71,6 +96,8 @@ def filter_annotation_instances(annotations_df, include=None, exclude=None):
                         (df_new["attributeName"] == attribute["name"])]
             if "type" in exclude_rule:
                 df_new = df_new[df_new["type"] == exclude_rule["type"]]
+            if "error" in exclude_rule:
+                df_new = df_new[df_new["error"] == exclude_rule["error"]]
 
             df = df.drop(df_new.index)
 

superannotate/db/exports.py

@@ -141,7 +141,7 @@ def prepare_export(
         )
     res = response.json()
     logger.info(
-        "Prepared export %s for project %s.", res['name'], project["name"]
+        "Prepared export %s for project %s (ID %s).", res['name'], project["name"], project["id"]
     )
     return res["name"]
 

superannotate/version.py

@@ -1 +1 @@
-__version__ = "2.1.3"
+__version__ = "2.1.4"

tests/sample_project_vector/example_image_1.jpg___objects.json

@@ -11,6 +11,18 @@
         ],
         "resolved": true
     },
+    {
+        "type": "comment",
+        "x": 521.4069213867188,
+        "y": 531.5987548828125,
+        "comments": [
+            {
+                "text": "dd",
+                "id": "hovnatan@superannotate.com"
+            }
+        ],
+        "resolved": false
+    },
     {
         "type": "bbox",
         "classId": 55917,