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

Author: agyurjin

README.md

@@ -29,15 +29,11 @@ pip install 'git+https://github.com/philferriere/cocoapi.git#egg=pycocotools&sub
 ```
 
 
-The package officially supports Python 3.6+ and was tested under Linux platform.
-For Windows based Anaconda distribution 
-you might also need to install *shapely* package separately:
+The package officially supports Python 3.6+ and was tested under Linux and
+Windows ([Anaconda](https://www.anaconda.com/products/individual#windows)) platforms.
 
-```console
-conda install shapely
-```
-
-For further steps please have a look at the [tutorial](https://superannotate.readthedocs.io/en/latest/tutorial.sdk.html).
+For more detailed installation steps and package usage please have a look at the 
+[tutorial](https://superannotate.readthedocs.io/en/stable/tutorial.sdk.html).
 
 ## Supported Features
 

docs/source/index.rst

@@ -54,7 +54,8 @@ for COCO annotation format converters support also need to install:
    pip install "git+https://github.com/cocodataset/panopticapi.git"
    pip install "git+https://github.com/philferriere/cocoapi.git#egg=pycocotools&subdirectory=PythonAPI"
 
-The package officially supports Python 3.6+ and was tested under Linux platform.
+The package officially supports Python 3.6+ and was tested under Linux and
+Windows (`Anaconda <https://www.anaconda.com/products/individual#windows>`_) platforms.
 
 For more detailed installation steps and package usage please have a look at 
 the :ref:`tutorial <ref_tutorial>`.

docs/source/tutorial.sdk.rst

@@ -24,16 +24,17 @@ for COCO annotation format converters support also need to install:
    pip install "git+https://github.com/cocodataset/panopticapi.git"
    pip install "git+https://github.com/philferriere/cocoapi.git#egg=pycocotools&subdirectory=PythonAPI"
 
-The package officially supports Python 3.6+ and was tested under Linux platform.
+The package officially supports Python 3.6+ and was tested under Linux and
+Windows (`Anaconda <https://www.anaconda.com/products/individual#windows>`_) platforms.
 
 For Windows based Anaconda distribution 
-you might also need to install :py:obj:`shapely` package separately:
+you might also need to install beforehand :py:obj:`shapely` package:
 
 .. code-block:: bash
 
    conda install shapely
 
-and also need to install C++ build tools from `Microsoft Visual Studio Tools
+and C++ build tools from `Microsoft Visual Studio Tools
 <https://visualstudio.microsoft.com/visual-cpp-build-tools/>`_.
 
 ----------

superannotate/__init__.py

@@ -8,6 +8,7 @@
 from .analytics.class_analytics import (
     attribute_distribution, class_distribution
 )
+from .analytics.user_analytics import image_analytics
 from .analytics.common import aggregate_annotations_as_df, df_to_annotations
 from .annotation_helpers import (
     add_annotation_bbox_to_json, add_annotation_comment_to_json,

superannotate/analytics/user_analytics.py

@@ -0,0 +1,56 @@
+import pandas as pd
+from tqdm import tqdm
+import plotly.express as px
+
+def image_analytics(annotations_df, visualize = False):
+    """
+    Aggregates image analytics: num instances/annotation time in seconds per image
+    :param annotations_df: pandas DataFrame of project annotations
+    :type annotations_df: pandas.DataFrame
+    :param visulaize: enables image analytics scatter plot
+    :type visualize: bool
+
+    :return: DataFrame on image analytics with columns ["image", "instances", "time"]
+    :rtype: pandas DataFrame
+
+    """
+    def fix_spent_time(grp: pd.Series) -> pd.Series:
+        grp = grp.copy()
+        grp_lost_msk = (grp > 600) | (grp.isna())
+        grp.loc[grp_lost_msk] = grp[~grp_lost_msk].median()
+        return grp
+    
+    analytics = {"user_id": [], "user_role": [], "image": [], "time": [], "ninstances": [] }
+    annot_cols = ["imageName", "instanceId", "createdAt", "creatorEmail", "creatorRole"]
+    annotations_df = annotations_df[annotations_df["creationType"] == "Manual"][annot_cols].drop_duplicates()
+
+    for annot, grp in annotations_df.groupby(["creatorEmail", "creatorRole"]):
+        grp_sorted = grp.sort_values("createdAt")
+        time_spent = grp_sorted.createdAt.diff().shift(-1).dt.total_seconds()
+        grp["time_spent"] = fix_spent_time(time_spent)
+        img_time = grp.groupby("imageName", as_index=False)["time_spent"].agg("sum")
+        img_n_instance = grp.groupby("imageName")["instanceId"].agg("count")
+
+        analytics["image"] += img_time.imageName.tolist()
+        analytics["time"] += img_time.time_spent.tolist()
+        analytics["ninstances"] += img_n_instance.tolist()
+        analytics["user_id"] += [annot[0]] * len(img_time)
+        analytics["user_role"] += [annot[1]] * len(img_time)
+
+    analytics_df = pd.DataFrame(analytics)
+    if visualize:
+        #scatter plot of number of instances vs annotation time
+        fig = px.scatter(
+            analytics_df,
+            x="ninstances",
+            y="time",
+            color="user_id",
+            facet_col="user_role",
+            custom_data = ["image"],
+            color_discrete_sequence=px.colors.qualitative.Dark24,
+            labels = {'user_id': "User Email", "ninstances": "Number of Instances", "time": "Annotation time"}
+        )
+        fig.for_each_annotation(lambda a: a.update(text=a.text.split("=")[-1]))
+        fig.update_traces(hovertemplate="%{customdata[0]}")
+        fig.show()
+    return analytics_df

superannotate/api.py

@@ -74,6 +74,8 @@ def init(self, config_location=None):
             if "main_endpoint" in self._api_config:
                 self._main_endpoint = self._api_config["main_endpoint"]
             self._verify = True
+            if "ssl_verify" in self._api_config:
+                self._verify = self._api_config["ssl_verify"]
             self._session = None
             self._authenticated = True
             response = self.send_request(

superannotate/input_converters/conversion.py

@@ -143,7 +143,7 @@ def _passes_converter_sanity(args, direction):
     if not test_passed:
         raise SABaseException(
             0,
-            "Please enter valid converter values. You can check available candidates in the documentation(https://superannotate.readthedocs.io/en/latest/index.html)."
+            "Please enter valid converter values. You can check available candidates in the documentation (https://superannotate.readthedocs.io/en/stable/index.html)."
         )