Supervisely
AboutAPI ReferenceSDK Reference
  • 🤖What's Supervisely
  • 🚀Ecosystem of Supervisely Apps
  • 💡FAQ
  • 📌Getting started
    • How to import
    • How to annotate
    • How to invite team members
    • How to connect agents
    • How to train models
  • 🔁Import and Export
    • Import
      • Overview
      • Import using Web UI
      • Supported annotation formats
        • Images
          • 🤖Supervisely JSON
          • 🤖Supervisely Blob
          • COCO
          • Yolo
          • Pascal VOC
          • Cityscapes
          • Images with PNG masks
          • Links from CSV, TXT and TSV
          • PDF files to images
          • Multiview images
          • Multispectral images
          • Medical 2D images
          • LabelMe
          • LabelStudio
          • Fisheye
          • High Color Depth
        • Videos
          • Supervisely
        • Pointclouds
          • Supervisely
          • .PCD, .PLY, .LAS, .LAZ pointclouds
          • Lyft
          • nuScenes
          • KITTI 3D
        • Pointcloud Episodes
          • Supervisely
          • .PCD, .PLY, .LAS, .LAZ pointclouds
          • Lyft
          • nuScenes
          • KITTI 360
        • Volumes
          • Supervisely
          • .NRRD, .DCM volumes
          • NIfTI
      • Import sample dataset
      • Import into an existing dataset
      • Import using Team Files
      • Import from Cloud
      • Import using API & SDK
      • Import using agent
    • Migrations
      • Roboflow to Supervisely
      • Labelbox to Supervisely
      • V7 to Supervisely
      • CVAT to Supervisely
    • Export
  • 📂Data Organization
    • Core concepts
    • MLOps Workflow
    • Projects
      • Datasets
      • Definitions
      • Collections
    • Team Files
    • Disk usage & Cleanup
    • Quality Assurance & Statistics
      • Practical applications of statistics
    • Operations with Data
      • Data Filtration
        • How to use advanced filters
      • Pipelines
      • Augmentations
      • Splitting data
      • Converting data
        • Convert to COCO
        • Convert to YOLO
        • Convert to Pascal VOC
    • Data Commander
      • Clone Project Meta
  • 📝Labeling
    • Labeling Toolboxes
      • Images
      • Videos 2.0
      • Videos 3.0
      • 3D Point Clouds
      • DICOM
      • Multiview images
      • Fisheye
    • Labeling Tools
      • Navigation & Selection Tools
      • Point Tool
      • Bounding Box (Rectangle) Tool
      • Polyline Tool
      • Polygon Tool
      • Brush Tool
      • Mask Pen Tool
      • Smart Tool
      • Graph (Keypoints) Tool
      • Frame-based tagging
    • Labeling Jobs
      • Labeling Queues
      • Labeling Consensus
      • Labeling Statistics
    • Labeling Performance
    • Labeling with AI-Assistance
  • 🤝Collaboration
    • Admin panel
      • Users management
      • Teams management
      • Server disk usage
      • Server trash bin
      • Server cleanup
      • Server stats and errors
    • Teams & workspaces
    • Members
    • Issues
    • Guides & exams
    • Activity log
    • Sharing
  • 🖥️Agents
    • Installation
      • Linux
      • Windows
      • AMI AWS
      • Kubernetes
    • How agents work
    • Restart and delete agents
    • Status and monitoring
    • Storage and cleanup
    • Integration with Docker
  • 🔮Neural Networks
    • Overview
    • Inference & Deployment
      • Overview
      • Supervisely Serving Apps
      • Deploy & Predict with Supervisely SDK
      • Using trained models outside of Supervisely
    • Model Evaluation Benchmark
      • Object Detection
      • Instance Segmentation
      • Semantic Segmentation
      • Custom Benchmark Integration
    • Custom Model Integration
      • Overview
      • Custom Inference
      • Custom Training
    • Legacy
      • Starting with Neural Networks
      • Train custom Neural Networks
      • Run pre-trained models
  • 👔Enterprise Edition
    • Get Supervisely
      • Installation
      • Post-installation
      • Upgrade
      • License Update
    • Kubernetes
      • Overview
      • Installation
      • Connect cluster
    • Advanced Tuning
      • HTTPS
      • Remote Storage
      • Single Sign-On (SSO)
      • CDN
      • Notifications
      • Moving Instance
      • Generating Troubleshoot Archive
      • Storage Cleanup
      • Private Apps
      • Data Folder
      • Firewall
      • HTTP Proxy
      • Offline usage
      • Multi-disk usage
      • Managed Postgres
      • Scalability Tuning
  • 🔧Customization and Integration
    • Supervisely .JSON Format
      • Project Structure
      • Project Meta: Classes, Tags, Settings
      • Tags
      • Objects
      • Single-Image Annotation
      • Single-Video Annotation
      • Point Cloud Episodes
      • Volumes Annotation
    • Developer Portal
    • SDK
    • API
  • 💡Resources
    • Changelog
    • GitHub
    • Blog
    • Ecosystem
Powered by GitBook
On this page
  • Format description
  • Input files structure
  • Single-Video Annotation JSON
  • Key id map file
  • Useful links

Was this helpful?

  1. Import and Export
  2. Import
  3. Supported annotation formats
  4. Videos

Supervisely

PreviousVideosNextPointclouds

Last updated 3 months ago

Was this helpful?

Easily import your videos with annotations in the Supervisely format. The Supervisely json-based annotation format supports such figures: rectangle, line (polyline), polygon, point, bitmap (mask), graph (keypoints). It is a universal format that supports various types of annotations and is used in the Supervisely platform.

All information about the Supervisely JSON format can be found

Enterprise users have access to "Import as links" option, which supports import of this format with annotations. This option might be beneficial in many cases, as it allows data import to Supervisely platform without re-uploading, maintaining a single source and speeding up import process.

To step up import speed even further you can compress all annotation files (.json's) into an archive and import it together with the images. (Note: This method is format-dependent and may not apply to all formats.)

Format description

Supported video formats: .avi, .mp4, .3gp, .flv, .webm, .wmv, .mov, and .mkv With annotations: yes Supported annotation format: .json. Data structure: Information is provided below.

Input files structure

Example data: .

Both directory and archive are supported.

Recommended directory structure:

  📦input_folder
   ┣ 📂dataset_name_01
   ┃  ┣ 📂ann
   ┃  ┃  ┣ 📄vid_0748.mp4.json
   ┃  ┃  ┗ 📄vid_8144.mp4.json
   ┃  ┣ 📂video
   ┃  ┃  ┣ 🎬vid_0748.mp4
   ┃  ┃  ┗ 🎬vid_8144.mp4
   ┃  ┗ 📂meta (optional)
   ┃     ┣ 📄vid_0748.mp4.json
   ┃     ┗ 📄vid_8144.mp4.json
   ┣ 📄meta.json
   ┗ 📄key_id_map.json file (optional)

Struggled with the structure? No worries! All videos will be uploaded to a single dataset, so you don't have to worry about the full project structure in Supervisely format. All you need is to prepare videos with annotations and meta.json file (recommended).

Items even can be placed in any subdirectories or the root directory. Just make sure that the annotation file names match the video file names (e.g. annotaion file video_1.jpg.json is for the video video_1.jpg) and that the annotation file format is correct (we will provide an example in the next section). The application will do the rest.

Single-Video Annotation JSON

For each video, we store the annotations in a separate json file named video_name.video_format.json with the following file structure:

{
  "size": {
    "height": 1080,
    "width": 1920
  },
  "description": "",
  "key": "c8168b43ae1b45c38930f456df9d0f2b",
  "tags": [],
  "objects": [
    {
      "key": "198f727d40c749eebcacc4aed299b39a",
      "classTitle": "rect",
      "tags": [],
      "labelerLogin": "alexxx",
      "updatedAt": "2020-08-23T12:06:11.963Z",
      "createdAt": "2020-08-23T12:06:11.963Z"
    }
  ],
  "frames": [
    {
      "index": 0,
      "figures": [
        {
          "key": "65f21690780e43b49863c3cbd07eab3a",
          "objectKey": "198f727d40c749eebcacc4aed299b39a",
          "geometryType": "rectangle",
          "geometry": {
            "points": {
              "exterior": [
                [266, 420],
                [847, 845]
              ],
              "interior": []
            }
          },
          "labelerLogin": "alexxx",
          "updatedAt": "2020-08-23T12:06:13.544Z",
          "createdAt": "2020-08-23T12:06:13.544Z"
        }
      ]
    }
  ],
  "framesCount": 375
}

Fields definitions:

  • size - string - is equal to image(frame) size

  • description - string - (optional) - this field is used to store the text we want to assign to the video. In the labeling intrface it corresponds to the 'data' filed.

  • key - string, unique key for a given video (used in key_id_map.json to get the video ID)

  • frames - list of frames of which the video consists. List contains only frames with an object from the 'objects' field

    • index - integer - number of the current frame

    • figures - integer - list of objects which the current frame contains

  • framesCount - integer - total number of frames in the video

  • objectKey - string - unique key for a given object (used in key_id_map.json)

  • labelerLogin - string - the name of a user who created the current figure

  • geometryType - "cuboid_3d" - class shape

  • geometry - a dictionary containing indicators of location, rotation and dimensions of cuboids

Fields definitions for objects field:

  • key - string, a unique key for the given object (used in key_id_map.json to get the object ID)

  • classTitle - string - the title of a class. It's used to identify the class shape from the meta.json file

  • tags - list of strings that will be interpreted as object tags

  • labelerLogin - string - the name of the user that added this figure to the project

Fields description for figures field:

  • key - string, a unique key for the given figure (used in key_id_map.json to get the figure ID)

  • objectKey - string, a unique key for the given object (used in key_id_map.json to get the object ID).

  • geometryType - "rectangle" -class shape

  • geometry - geometry of the object

  • classTitle - string - the title of a class. It's used to identify the class shape from the meta.json file

  • labelerLogin - string - the name of the user that added this figure to the current frame

Key id map file

Key_id_map.json file is optional. It is created when annotating the video inside Supervisely interface and sets the correspondence between the unique identifiers of the video, object and the frame on which the object is located. If you annotate manually, you do not need to create this file. This will not affect the work being done.

Json format of key_id_map.json:

{
  "tags": {},
  "objects": {
    "198f727d40c749eebcacc4aed299b39a": 20520
  },
  "figures": {
    "65f21690780e43b49863c3cbd07eab3a": 503130811
  },
  "videos": {
    "c8168b43ae1b45c38930f456df9d0f2b": 157876296
  }
}

Fields definitions:

  • objects - dictionary, where the key is a unique string, generated inside Supervisely environment to set correspondence of current object in annotation, and values are unique integer ID corresponding to the current object

  • figures - dictionary, where the key is a unique string, generated inside Supervisely environment to set correspondence of object on current frame in annotation, and values are unique integer ID corresponding to the current frame

  • videos - dictionary, where the key is unique string, generated inside Supervisely environment to set correspondence of video in annotation, and value is a unique integer ID corresponding to the current video

  • tags - dictionary, where the keys are unique strings, generated inside Supervisely environment to set correspondence of tag on current frame in annotation, and values are a unique integer ID corresponding to the current tag

Useful links

Project meta file meta.json is recommended to be present in the project directory. It contains classes and tags definitions for the project. If it is not present, it will try to create it from the annotations. Learn more about the meta.json file .

tags - list of strings that will be interpreted as video

objects - list of

🔁
here
download ⬇️
here
tags
objects on the video
Supervisely Annotation Format
Supervisely Video Annotation
[SDK CLI] Upload projects in Supervisely format
[CLI Tool Beta] Upload projects in Supervisely format
[Supervisely Ecosystem] Import video in Supervisely format