Merge pull request #342 from superannotateai/develop

Release candidate

Author: dshabin

docs/source/superannotate.sdk.rst

@@ -34,11 +34,9 @@ ________
 .. autofunction:: superannotate.get_folder_metadata
 .. autofunction:: superannotate.create_folder
 .. autofunction:: superannotate.delete_folders
-.. autofunction:: superannotate.rename_folder
 .. autofunction:: superannotate.upload_images_to_project
 .. autofunction:: superannotate.attach_image_urls_to_project
 .. autofunction:: superannotate.upload_images_from_public_urls_to_project
-.. autofunction:: superannotate.upload_images_from_s3_bucket_to_project
 .. autofunction:: superannotate.attach_document_urls_to_project
 .. autofunction:: superannotate.upload_image_to_project
 .. autofunction:: superannotate.delete_annotations
@@ -51,10 +49,7 @@ ________
 .. autofunction:: superannotate.upload_annotations_from_folder_to_project
 .. autofunction:: superannotate.upload_preannotations_from_folder_to_project
 .. autofunction:: superannotate.share_project
-.. autofunction:: superannotate.unshare_project
 .. autofunction:: superannotate.get_project_settings
-.. autofunction:: superannotate.set_project_settings
-.. autofunction:: superannotate.get_project_default_image_quality_in_editor
 .. autofunction:: superannotate.set_project_default_image_quality_in_editor
 .. autofunction:: superannotate.get_project_workflow
 .. autofunction:: superannotate.set_project_workflow
@@ -79,32 +74,21 @@ ______
 .. autofunction:: superannotate.search_images
 .. autofunction:: superannotate.search_images_all_folders
 .. autofunction:: superannotate.get_image_metadata
-.. autofunction:: superannotate.get_image_bytes
 .. autofunction:: superannotate.download_image
 .. autofunction:: superannotate.set_image_annotation_status
 .. autofunction:: superannotate.set_images_annotation_statuses
 .. autofunction:: superannotate.get_image_annotations
-.. autofunction:: superannotate.get_image_preannotations
 .. autofunction:: superannotate.download_image_annotations
-.. autofunction:: superannotate.download_image_preannotations
 .. autofunction:: superannotate.upload_image_annotations
 .. autofunction:: superannotate.copy_image
 .. autofunction:: superannotate.copy_images
-.. autofunction:: superannotate.move_image
 .. autofunction:: superannotate.move_images
 .. autofunction:: superannotate.pin_image
 .. autofunction:: superannotate.assign_images
-.. autofunction:: superannotate.delete_image
 .. autofunction:: superannotate.delete_images
 .. autofunction:: superannotate.add_annotation_bbox_to_image
-.. autofunction:: superannotate.add_annotation_polygon_to_image
-.. autofunction:: superannotate.add_annotation_polyline_to_image
 .. autofunction:: superannotate.add_annotation_point_to_image
-.. autofunction:: superannotate.add_annotation_ellipse_to_image
-.. autofunction:: superannotate.add_annotation_template_to_image
-.. autofunction:: superannotate.add_annotation_cuboid_to_image
 .. autofunction:: superannotate.add_annotation_comment_to_image
-.. autofunction:: superannotate.create_fuse_image
 
 ----------
 
@@ -114,7 +98,6 @@ __________________
 .. autofunction:: superannotate.create_annotation_class
 .. _ref_create_annotation_classes_from_classes_json:
 .. autofunction:: superannotate.create_annotation_classes_from_classes_json
-.. autofunction:: superannotate.get_annotation_class_metadata
 .. autofunction:: superannotate.search_annotation_classes
 .. autofunction:: superannotate.download_annotation_classes_json
 .. autofunction:: superannotate.delete_annotation_class
@@ -126,21 +109,15 @@ _________________
 
 .. autofunction:: superannotate.get_team_metadata
 .. autofunction:: superannotate.invite_contributor_to_team
-.. autofunction:: superannotate.delete_contributor_to_team_invitation
 .. autofunction:: superannotate.search_team_contributors
 
 ----------
 
 Neural Network
 _______________
 
-.. autofunction:: superannotate.delete_model
 .. autofunction:: superannotate.download_model
-.. autofunction:: superannotate.plot_model_metrics
 .. autofunction:: superannotate.run_prediction
-.. autofunction:: superannotate.run_segmentation
-.. autofunction:: superannotate.run_training
-.. autofunction:: superannotate.stop_model_training
 .. autofunction:: superannotate.search_models
 
 ----------
@@ -301,7 +278,6 @@ _________________________________________________________________
 .. autofunction:: superannotate.import_annotation
 .. autofunction:: superannotate.export_annotation
 .. autofunction:: superannotate.convert_project_type
-.. autofunction:: superannotate.coco_split_dataset
 .. autofunction:: superannotate.convert_json_version
 
 
@@ -311,19 +287,9 @@ _________________________________________________________________
 Working with annotations
 ________________________
 
-.. _ref_add_annotation_bbox_to_json:
-.. autofunction:: superannotate.validate_annotations
-.. autofunction:: superannotate.add_annotation_bbox_to_json
-.. autofunction:: superannotate.add_annotation_polygon_to_json
-.. autofunction:: superannotate.add_annotation_polyline_to_json
-.. autofunction:: superannotate.add_annotation_point_to_json
-.. autofunction:: superannotate.add_annotation_ellipse_to_json
-.. autofunction:: superannotate.add_annotation_template_to_json
-.. autofunction:: superannotate.add_annotation_cuboid_to_json
-.. autofunction:: superannotate.add_annotation_comment_to_json
 .. _ref_aggregate_annotations_as_df:
+.. autofunction:: superannotate.validate_annotations
 .. autofunction:: superannotate.aggregate_annotations_as_df
-.. autofunction:: superannotate.df_to_annotations
 
 ----------
 
@@ -337,6 +303,5 @@ _____________________________________________________________
 Utility functions
 --------------------------------
 
-.. autofunction:: superannotate.dicom_to_rgb_sequence
 .. autofunction:: superannotate.consensus
 .. autofunction:: superannotate.benchmark

docs/source/tutorial.sdk.rst

@@ -226,14 +226,6 @@ each JSON a mask image file should be present with the name
 :file:`"<image_name>___save.png"`. Image with :file:`<image_name>` should 
 already be present in the project for the upload to work.
 
-You can add an annotation to local annotations JSON with:
-
-.. code-block:: python
-
-   sa.add_annotation_bbox_to_json("<path_to_json>", [10, 10, 100, 100],
-                                  "Human")
-
-
 
 Exporting projects
 __________________
@@ -380,33 +372,12 @@ To download image annotations:
 
    sa.download_image_annotations(project, image, "<path_to_local_dir>")
 
-After the image annotations are downloaded, you can add annotations to it:
-
-.. code-block:: python
-
-   sa.add_annotation_bbox_to_json("<path_to_json>", [10, 10, 100, 100],
-                                  "Human")
-
-and upload back to the platform with:
+Upload back to the platform with:
 
 .. code-block:: python
 
    sa.upload_image_annotations(project, image, "<path_to_json>")
 
-Last two steps can be combined into one:
-
-.. code-block:: python
-
-   sa.add_annotation_bbox_to_image(project, image, [10, 10, 100, 100], "Human")
-
-but if bulk changes are made to many images it is much faster to add all required
-annotations using :ref:`add_annotation_bbox_to_json
-<ref_add_annotation_bbox_to_json>` 
-then upload them using
-:ref:`upload_annotations_from_folder_to_project
-<ref_upload_images_from_folder_to_project>`.
-
-
 ----------
 
 
@@ -453,13 +424,6 @@ Example of created DataFrame:
 Each row represents annotation information. One full annotation with multiple
 attribute groups can be grouped under :code:`instanceId` field.
 
-To transform back pandas DataFrame annotations to SuperAnnotate format annotation:
-
-.. code-block:: python
-
-   sa.df_to_annotations(filtered_df, "<path_to_output_folder>")
-
-
 ----------
 
 
@@ -486,14 +450,6 @@ Aggregated distribution is returned as pandas dataframe with columns className a
 Working with DICOM files
 _______________________________________________________
 
-
-To convert DICOM file images to JPEG images:
-
-
-.. code-block:: python
-
-   df = sa.dicom_to_rgb_sequence("<path_to_dicom_file>", "<path_to_output_dir>")
-
 JPEG images with names :file:`<dicom_file_name>_<frame_num>.jpg` will be created
 in :file:`<path_to_output_dir>`. Those JPEG images can be uploaded to
 SuperAnnotate platform using the regular:

requirements_dev.txt

@@ -3,4 +3,5 @@ tox==3.24.2
 pytest==6.2.4
 pytest-xdist==2.3.0
 pytest-parallel==0.1.0
-pytest-rerunfailures==10.2
+pytest-rerunfailures==10.2
+sphinx_rtd_theme==1.0.0