Improve docs

Author: hovnatan

docs/source/superannotate.sdk.rst

@@ -137,16 +137,14 @@ Project metadata example:
      "creator_id": "hovnatan@superannotate.com",
      "updatedAt": "2020-08-31T05:43:43.118Z",
      "createdAt": "2020-08-31T05:43:43.118Z"
-     "type": 1,
+     "type": "Vector",
      "attachment_name": None,
      "attachment_path": None,
      "entropy_status": 1,
      "status": 0,
      "...": "..."
    }
 
-Most of the fields here are self-explanatory. "type" is an integer value that can be
-translated to a string "Pixel" or "Vector" project types using :ref:`project_type_int_to_str <ref_project_type_int_to_str>`.
 
 ----------
 
@@ -178,7 +176,7 @@ Image metadata example:
 
    {
       "name": "000000000001.jpg",
-      "annotation_status": 1,
+      "annotation_status": "Completed",
       "prediction_status": 1,
       "segmentation_status": 1,
       "annotator_id": None,
@@ -193,12 +191,6 @@ Image metadata example:
       "...": "...",
    }
 
-Most of the fields here are self-explanatory. "annotation_status" is an integer
-value that can be
-translated to one of "NotStarted", "InProgress", "QualityCheck", "Returned",
-"Completed" or "Skipped" using :ref:`annotation_status_int_to_str
-<ref_annotation_status_int_to_str>`.
-
 
 ----------
 
@@ -264,24 +256,15 @@ Team contributor metadata example:
     "...": "...",
   }
 
-----------
-
-Metadata helper functions
-_________________________
-
-.. _ref_project_type_int_to_str:
-.. autofunction:: superannotate.project_type_int_to_str
-.. _ref_annotation_status_int_to_str:
-.. autofunction:: superannotate.annotation_status_int_to_str
-
-.. _ref_converter:
 
 
 ----------
 
 Annotation JSON helper functions
 --------------------------------
 
+.. _ref_converter:
+
 Converting annotation format to and from SuperAnnotate format
 _____________________________________________________________
 

superannotate/dataframe_filtering.py

@@ -7,16 +7,14 @@ def filter_images_by_comments(
     include_resolved_comments=False,
     include_without_comments=False
 ):
-    """Filter images on comment resolve status and comment resolve status
+    """Filter images on comment resolve status and comment existence
 
     :param annotations_df: pandas DataFrame of project annotations
     :type annotations_df: 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
 
@@ -79,7 +77,10 @@ def filter_images_by_tags(annotations_df, include=None, exclude=None):
 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,...>", "error": <True or False>, "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

superannotate/db/project_api.py

@@ -35,6 +35,7 @@ def get_project_metadata_bare(project_name):
     elif len(results) == 1:
         res = results[0]
         res["type"] = common.project_type_int_to_str(res["type"])
+        res["user_role"] = common.user_role_int_to_str(res["user_role"])
         return res
     else:
         raise SANonExistingProjectNameException(

superannotate/db/teams.py

@@ -45,8 +45,11 @@ def get_team_metadata():
         )
 
     res = response.json()
+    res["user_role"] = user_role_int_to_str(res["user_role"])
     for user in res["users"]:
         user["user_role"] = user_role_int_to_str(user["user_role"])
+    for user in res["pending_invitations"]:
+        user["user_role"] = user_role_int_to_str(user["user_role"])
 
     return res