Skip to content

Python API

LightlyStudio has a powerful Python interface. You can not only index datasets but also query and manipulate them using code.

Overview

  • Dataset setup — Image Dataset, Video Dataset
  • Reuse Datasets — Reuse Datasets covers the DuckDB file location and load_or_create workflow.
  • Cloud Storage — Cloud Storage covers loading images and videos directly from S3, GCS, and Azure.
  • Annotations — Annotations covers annotation workflows, examples, and format notes.
  • Search and Filter — Search and Filter covers the DatasetQuery API for filtering, sorting, and slicing.
  • Sampling — Sampling covers diverse, metadata-weighted, similarity, class-balancing, and combined sampling strategies.
  • Evaluation — Evaluation covers evaluation runs, per-sample metrics, and GUI visualizations.

The full API reference for each module is available in the navigation sidebar: Dataset, Sample, DatasetQuery, Sampling, Plugin, Annotation, Evaluation.

API Reference

See the menu on the left for the full API reference of the Python interface.