This the open source repository for remo python library.

Remo is an open-access web-application for managing and visualising images and annotations for Computer Vision.

Use remo to:

• visualise and inspect datasets and annotations
• organise and search your images
• visualise statistics like # objects per class
• quickly annotate your images

Remo runs on Windows, Linux and Mac. It is written using Python and React.JS and uses a lightweight database to store metadata.

1. In a Python 3.6+ environment: pip install remo

This will install both the Python library and the remo app.

2. Initialise config: python -m remo_app init

That's it!

To launch remo, run python -m remo_app. To call remo from python once you have a server running, use import remo.

To read more about installation and other features, visit remo.ai

You can see example of usage of the library in our documentiation or in the examples folder.

If you have any issues around the library, feel free to open an issue in the repo.

For anything else, you can write on our discuss forum.

The library is organized in 3 main layers:

• api
• sdk
• domain objects, such as datasets

We exepect the end user to use mainly the SDK layer and domain objets.

API is responsible for low level communication with the server. It mostly returns raw data.

SDK doesn't access backend endpoints directly, rather it uses the API layer for that. This layer knows about domain objects, so instead of raw data, it returns domain objects.

Domain objects keeps entity information and knows about the SDK layer. Most functions are simple short-hands for sdk methods. This layer doesn't know anything about API.

• Functions which are responsible to open the UI on a specific page use the view_ prefix

    view_dataset, view_annotations
  

• Functions which return always only one object, present the name of that object in singular form.

    get_image(id) - returns one image
  

• Functions which might return multiple objects use the plural form of that object

    get_images() - may return multiple images