Remo Python documentation

Here you can find the documentation for our Python library remo-sdk.

To facilitate integration from code, Remo exposes a set of end points that can directly called as an API. In this section, we document the Python library built on top of the endpoints, which we distribute as a pip package.

The library is open source, you can checkout our GitHub repo.

Work in progress

We are iterating quite fast on the SDK design in this phase, which means some functionalities might break from one version to the other.

Any feedback on the design or missing functionalities is welcome.

Main entities

The main entities in the Python library are:

For finer control, you can use:

  • Annotation Set Class: high-level operations on annotations
  • Image Class: low-level operations on individual images
  • Annotation Class: low-level operations on individual annotation objects
  • API Class: here we call directly the Rest API endpoints. You shouldn't need to look here, except if you want to build new functionalities

Tutorials

To get you quickly started, you can have a look at some notebook Tutorials

Tutorial What Download
Intro Notebook Quick intro to main functionalities intro_to_remo-SDK.ipynb
Upload Annotations Notebook Tutorial on uploading annotations tutorial_upload_annotations.ipynb

Other programming languages

If you are using a programming language other than Python, you can still call Remo from code

You still need a version of Remo installed, but then you could directly call the app REST API end-points - maybe taking inspiration from what we have done within the Python SDK.