Skip to main content

Python SDK to SuperAnnotate platform

Project description

SuperAnnotate Python SDK

SuperAnnotate Python SDK allows access to the platform without web browser:

import superannotate as sa

sa.create_project("Example Project 1", "example", "Vector")

sa.upload_images_from_folder_to_project("Example Project 1", "<path_to_my_images_folder>")

Installation

SDK is available on PyPI:

pip install superannotate

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. For Windows based Anaconda distribution you might also need to install shapely package separately:

conda install shapely

For further steps please have a look at the tutorial.

Supported Features

  • Search projects
  • Create/delete a project
  • Upload images to a project from a local or AWS S3 folder
  • Upload videos to a project from a local folder
  • Upload annotations/pre-annotations to a project from local or AWS S3 folder
  • Set the annotation status of the images being uploaded
  • Export annotations from a project to a local or AWS S3 folder
  • Share and unshare a project with a team contributor
  • Invite a team contributor
  • Search images in a project
  • Download a single image
  • Copy/move image between projects
  • Get image bytes (e.g., for numpy array creation)
  • Set image annotation status
  • Download image annotations/pre-annotations
  • Create/download project annotation classes
  • Convert annotation format from/to COCO
  • Convert annotation format from VOC, SuperVisely, LabelBox, DataLoop, VGG, VoTT, SageMaker, GoogleCloud, YOLO
  • Add annotations to images on platform
  • Add annotations to local SuperAnnotate format JSONs
  • CLI commands for simple tasks

Full SDK reference, tutorial available on Read the Docs

License

This SDK is distributed under the MIT License, see LICENSE.

Questions and Issues

For questions and issues please use this repo's issue tracker on GitHub.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

superannotate-2.3.12.tar.gz (76.5 kB view details)

Uploaded Source

File details

Details for the file superannotate-2.3.12.tar.gz.

File metadata

  • Download URL: superannotate-2.3.12.tar.gz
  • Upload date:
  • Size: 76.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/49.6.0.post20201009 requests-toolbelt/0.9.1 tqdm/4.52.0 CPython/3.8.6

File hashes

Hashes for superannotate-2.3.12.tar.gz
Algorithm Hash digest
SHA256 dbe24c0d0fd224172aaed34e7a3a9fcf46755bbc3434ebc7852eac3df224b6b5
MD5 3eb89e5995b3c0f02c48bca72948c4f3
BLAKE2b-256 b3ae88372ccf2defcc84205bd9ed514bdf9ae80b03af6c10bfc8375fc52233bb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page