Exporting Annotations

Overview of Ango Hub's Export Functionality

Administrators and project managers can create and download an export of all annotations performed in a project on Ango Hub.

If the project you are attempting to obtain the export for contains individual videos with more than ~50k annotated frames, in order to obtain the export for that video, you must enable the Only Key Frames option to attempt to reduce the number of annotations that are exported.

Exporting videos with more than 50k frames, each with annotations, would require manual intervention from the dev team. Please contact us in case this is required.

Getting your Export

Whole Project / Selected Batches / Selected Stages

Enter your project's Export tab. The Export button at the bottom will allow you to download your annotations.

You may filter by certain stages or batches, and pick what fields you'd like to obtain in the export.

You will receive a notification within Ango Hub when the export is ready. You may navigate away from the page while the export is being prepared.

Selected Tasks

From the Tasks tab, select the tasks you'd like to export. Then, from the items dropdown, select Export.

Using Custom Private Buckets for Exports

By default, after Ango Hub has computed the export, it uploads it to iMerit's own private bucket, and presents it to you as a signed URL from which you will be able to download it. When you click on the link, you are downloading the export as it is found in iMerit's private bucket.

In case this is not an option for you for data security reasons, or if you'd like to automatically collect your exports in a private bucket of your choice, you may have Ango Hub send the export to a bucket of your choice instead of iMerit's. Here are the steps to accomplish this:

From your project's dashboard, navigate to the Settings tab, then enter the General section.
Enable the Export Storage toggle. The Export Storage details will appear:

Pick a storage from the first dropdown. If you have not yet set up a storage within Ango Hub, please follow this guide for AWS S3 and this guide for Google Cloud Platform.
In the Bucket field, enter the name of the bucket where you'd like to receive your exports.
In the Path field, enter the folder where you'd like to receive your exports, followed by slashes and names of subfolders if any. Folders will be created if they do not exist.

For example, to obtain your exports in a folder called exports located on the root of your bucket, simply write exports. To get them in a subfolder of exports called 2023, write exports/2023.

Click on Save at the bottom of the page.

Now, when you obtain the export in this project, the export .zip file will be created directly within the bucket you specified, and when you click on the notification to download it, you will be downloading it directly from your own bucket. This also includes exports obtained from export-type plugins.

For exports obtained with Export Plugins, Hub will save to the bucket both the original export in Ango Export Format and the converted export.

Export Options

Export Format

You can download your export in the JSON, NDJSON, and NDJSON (Split) formats.

File names and archive contents

Regardless of the format you select, Ango Hub delivers the export as a .zip archive. For annotation exports, the archive name follows this pattern:

<project-id>-task-export-YYYY-MM-DD-HH_MM_SS_GMT-<unique-suffix>.zip

The timestamp indicates when the export was created, and the unique eight-character suffix prevents exports created at the same time from overwriting one another.

The selected format determines the files inside the archive:

Format

Archive contents

JSON

One .json file containing the export as a JSON array.

NDJSON

One .ndjson file containing one exported task per line.

NDJSON (Split)

One .json file per exported asset. Each filename is based on the asset's external ID, or on its asset or task ID when no external ID is available.

For JSON and NDJSON exports, the file inside the archive follows this pattern:

<project-name>-task-export-YYYY-MM-DD-HH_MM_SS_GMT-<unique-suffix>.json

NDJSON exports use the same pattern with the .ndjson extension. Spaces in the project name are replaced with underscores.

For more details on our export format, please consult the docs page on the Ango Export Format.

If you need to download your export in more, different formats, we recommend you use our Export Converter Plugins.

We have developed the JSON export format to be as easy to parse and convert to other formats as possible. If you need your annotations in a format that is not supported by our plugins and you are a paid customer, contact us and we will provide you a script to convert our JSON export to the format of your choice.

If you need to reuse an Ango Hub export as pre-labels, use the Export as Ango Import plugin to generate an import-ready JSON file.

Stage

By default, the export will contain only tasks in the Complete stage. From this field, however, you can pick the stages you wish to get the export for.

Fields

Click on the checkboxes next to the desired fields to include them in the export. Details of each toggle are as follows:

Toggle

Description

Format

Annotation Metadata

Metadata regarding each individual annotation in the task.

"metadata": {
  "createdAt": "2023-02-02T08:06:03.263Z",
  "createdBy": "Lorenzo Gravina",
  "updatedAt": "2023-02-02T08:06:07.276Z",
  "updatedBy": "Lorenzo Gravina"
}

Stage History

Object containing, for each task, its stage history, so which stages it has traveled through and for how long.

"stageHistory": [
        {
          "_id": "64774fb6e58cac001554d9e0",
          "stageId": "Start",
          "duration": 0,
          "completedAt": "2023-05-31T13:46:30.942Z",
          "stageName": "Start"
        },
        {
          "_id": "64774fc8e58cac001554da05",
          "stageId": "bd112eb0-a8e4-418b-b1fb-fa728316e36e",
          "taskHistory": "64774fc8e58cac001554da03",
          "duration": 11893,
          "submittedBy": "example@ango.ai",
          "completedAt": "2023-05-31T13:46:48.358Z",
          "completedBy": "example@ango.ai",
          "consensusId": "d3292fa9-4b8c-4237-86f0-8e8a79adfb4b",
          "stageName": "Consensus_1"
        },
        {
          "_id": "64774fe2e58cac001554da5d",
          "stageId": "4758ed37-61c7-4a63-8362-fd36cf48e14f",
          "taskHistory": "64774fe2e58cac001554da5b",
          "duration": 18734,
          "submittedBy": "example@ango.ai",
          "completedAt": "2023-05-31T13:47:14.883Z",
          "completedBy": "example@ango.ai",
          "consensusId": "d3292fa9-4b8c-4237-86f0-8e8a79adfb4b",
          "stageName": "Consensus_2"
        }
      ]

Only Key Frames

When toggled, for video assets, only include key frames. Do not include interpolation frames. For frame-specific classifications, disabling this option omits answers on frames marked out of view. Enabling it includes the stored keyframes, even when they fall inside an out-of-view range.

Email Notifications

Enable Send export link as email to receive an email with a link to your export when it is ready.

Email notification options in the export dialog

You can also enable Also email me if the export fails to receive an email if Ango Hub cannot complete the export. This option is only available when Send export link as email is enabled.

Export History

From the Export tab of a project, by clicking on the Export History section, you may access a history of the exports that have been obtained for that project before and redownload them.

Sample Export

Complete_Export-export-2023-09-01-13_11_48_GMT_v3.json

115KB

Open

Last updated 1 month ago