Superannotate

__________________________

**Updated**

- Improvements on working with large files.

**Fixed**

- ``SAClient.upload_annotations_from_folder_to_project()`` method to address the issue of the disappearing progress bar.
- ``SAClient.run_prediction()`` method to address the issue of the OCR model.
- ``SAClient.validate_annotations()`` method to address the issue of missing log messages.
- ``SAClient.create_project_from_metadata()`` method to address the issue of returning deprecated ``is_multiselect`` key.
- ``SAClient.get_annotations()`` method to address the issue of returning error messages as annotation dicts.

______________________________

**Updated**

- the **schema** of ``classes JSON`` to support new values for the ``"group_type"`` key for a given attribute group. ``"group_type": "radio" | "checklist" | "text" | "numeric"``.
- the **schema** of ``video annotation JSON`` to support instances that have a ``"tag"`` type.

**Fixed**

- ``SAClient.get_annotations()`` method to address the issue of working with the large projects.
- ``SAClient.get_annotations_per_frame()`` method to address the issue of throwing an error on small videos when the fps is set to 1.
- ``SAClient.upload_annotations_from_folder_to_project()`` to address the issue of timestamp values represented in seconds for the ``"lastAction"``.
- ``SAClient.download_export()`` method to address the issue of empty logs.
- ``SAClient.clone_project()`` method to address the issue of having a corrupted project clone, when the source project has a keypoint workflow.

_____________________

**Added**

- ``SAClient.create_custom_fields()`` method to create/add new custom fields to a project’s custom field schema.
- ``SAClient.get_custom_fields()`` method to get a project’s custom field schema.
- ``SAClient.delete_custom_fields()`` method to remove existing custom fields from a project’s custom field schema.
- ``SAClient.upload_custom_values()`` method to attach custom field-value pairs to items.
- ``SAClient.delete_custom_values()`` method to remove custom field-value pairs from items.

**Updated**

- The **schema** of ``classes JSON`` to support the new ``"default_value"`` key to set a default attribute(s) for a given attribute group.
- ``SAClient.get_item_metadata()`` method to add a new input argument ``include_custom_metadata`` to return custom metadata in the result items.
- ``SAClient.search_items()`` method to add a new input argument ``include_custom_metadata`` to return custom metadata in the result items.
- ``SAClient.query()`` method to return custom metadata in the result items.

**Fixed**

- ``SAClient`` class to address the system crash that occurs on instantiation via ``config.json`` file.
- ``SAClient.query()`` method to address the issue of not returning more than 50 items.
- ``SAClient.upload_annotations_from_folder_to_project()`` to address the issue of some fields not being auto populated after the upload is finished.
- ``SAClient.get_folder_metadata()``, ``SAClient.search_folders()`` to address the issue of transforming the ‘+’ sign in a folder to a whitespace.

**Removed**

- ``superannotate.assign_images()`` function. Please use the ``SAClient.assign_items()`` method instead.
- ``superannotate.unassign_images()`` function. Please use the ``SAClient.unassign_items()`` method instead.
- ``superannotate.delete_images()`` function. Please use the ``SAClient.delete_items()`` method instead.

_____________________

**Added**

- ``superannotate.SAClient()`` class to instantiate team-level authentication and inheriting methods to access the back-end.
- ``SAClient.download_annotations()`` method to download annotations without preparing an Export object.
- ``SAClient.get_subsets()`` method to get the existing subsets for a given project.
- ``SAClient.assign_items()`` method to assign items in a given project to annotators or quality specialists.
- ``SAClient.unassign_items()`` method to remove assignments from items.
- ``SAClient.delete_items()`` method to delete items in a given project.

**Updated**

- ``JSON Schema`` for video annotations to version ``1.0.45`` to show **polygon** and **polyline** annotations.
- ``SAClient.get_annotations_per_frame()`` method to show **polygon** and **polyline** annotations.
- ``SAClient.get_annotations_per_frame()`` method to pick instances closer to a given **frame start** instead of the **median**.
- ``SAClient.query()`` method to add the ``subset`` argument to support querying in a subset.

**Fixed**

- ``SAClient.set_annotation_statuses()`` method to address the issue occurring with more than 500 items.
- ``SAClient.get_annotations()`` method to address the ``PayloadError`` occurring with more than 20000 items.
- ``SAClient.get_annotations()`` method to address the missing ``'duration'`` and ``'tags'`` keys for newly uploaded and unannotated videos.
- ``SAClient.get_annotations_per_frame()`` method to address missing ``'duration'`` and ``'tags'`` keys for newly uploaded and unannotated videos.
- ``SAClient.get_annotations_per_frame()`` method to address the wrong ``classId`` value for unclassified instances.

**Removed**

- ``superannotate.init()`` function. Please instantiate ``superannotate.SAClient()`` class to authenticate.
- ``superannotate.set_image_annotation_status()`` function. Please use the ``SAClient.set_annotation_statuses()`` method instead.
- ``superannotate.set_images_annotations_statuses()`` function. Please use the ``SAClient.set_annotation_statuses()`` method instead.

____________________

**Updated**

- ``JSON Schema`` for video annotations to version ``x`` to reflect point annotations.
- ``superannotate.download_export()`` function to preserve SA folder structure while downloading to S3 bucket.
- ``superannotate.get_item_metadata()`` function to have string type values instead of int type for the ``approval_status`` key.
- ``superannotate.get_item_metadata()`` function to change the value for the ``path`` key in the item metadata from ``project/folder/item`` format to ``project/folder``.
- ``superannotate.get_item_metadata()`` function to add the ``is_pinned`` key in the returned metadata.
- ``superannotate.clone_project()`` function to have ``NotStarted`` project status for the newly created project.

**Fixed**

- ``superannotate.query()`` function to address the missing value for the ``path`` key.
- ``superannotate.import_annotation()`` function to address the extension issue with JPEG files while converting from ``VOC`` to SA.
- ``superannotate.import_annotation()`` function to address int type pointlabels in the converted ``JSON`` from ``COCO`` to SA.
- ``superannotate_get_annotations()`` & ``superannotate.add_annotation_comment_to_image()`` to address the issue with ``asyncio`` occurring on Windows.
- ``superannotate.set_image_annotation_status()`` function add a deprecation warning.
- ``superannotate.set_images_annotation_statuses()`` function add a deprecation warning.

**Removed**

- ``share_projects()`` function.
- ``superannotate.attach_image_urls_to_project()`` function. Please use the ``superannotate.attach_items()`` function instead.
- ``superannotate.attach_document_urls_to_project()`` function. Please use the ``superannotate.attach_items()`` function instead.
- ``superannotate.attach_video_urls_to_project()`` function. Please use the ``superannotate.attach_items()`` function instead.
- ``superannotate.copy_images()`` function. Please use the ``superannotate.copy_items()`` function instead.
- ``superannotate.move_images()`` function. Please use the ``superannotate.move_items()`` function instead.

___________________

**Added**

- ``attach_items()`` function to link items (images, videos, and documents) from external storages to SuperAnnotate using URLs.
- ``copy_items()`` function to copy items (images, videos, and documents) in bulk between folders in a project.
- ``move_items()`` function to move items (images, videos, and documents) in bulk between folders in a project.
- ``set_annotation_statuses()`` function to change the annotation status of items (images, videos, and documents) in bulk.

**Updated**

- ``aggregate_annotations_as_df()`` function now supports Text Projects.

**Fixed**

- ``validate_annotations()`` function to accept only numeric type values for the ``points`` field.
- ``prepare_export()`` function to address the issue when the entire project is prepared when a wrong folder name is provided.
- ``search_team_contributors()`` function to address the error message when ``email`` parameter is used.
- ``get_item_metadata()`` to address the issue with approved/disapproved items.

**Removed**

- ``get_project_and_folder_metadata()`` function.
- ``get_image_metadata()`` function. Please use ``get_item_metadata()`` instead.
- ``search_images()`` function. Please use ``search_items()`` instead.
- ``search images_all_folders()`` function. Please use ``search_items()`` instead.