dataformats

Loads dataformat.yaml and exposes hardcoded directory names as a typed object.

Functions

load()

Load and return the DataFormat from dataformat.yaml.

Classes

DataFormat(data_dir, splits_dir, ...)

Hardcoded directory names loaded from dataformat.yaml.
class DataFormat(data_dir, splits_dir, leaderboard_dir, tracks_dirname, annotations_dirname, beats_suffix, metadata_suffix)[source]

Bases: object

Hardcoded directory names loaded from dataformat.yaml.

Parameters:

  • data_dir (str) – Root data directory name.

  • splits_dir (str) – Splits subdirectory name.

  • leaderboard_dir (str) – Subdirectory holding the running leaderboard. DVC tracked like splits, so a board survives the machine that wrote it.

  • tracks_dirname (str) – Per-dataset subfolder holding custom-recorded audio.

  • annotations_dirname (str) – Per-dataset subfolder holding annotation sidecars.

  • beats_suffix (str) – File suffix for beat-time annotation files.

  • metadata_suffix (str) – File suffix for track metadata sidecar files.

annotations_dirname: str
beats_suffix: str
data_dir: str
leaderboard_dir: str
metadata_suffix: str
splits_dir: str
tracks_dirname: str
load()[source]

Load and return the DataFormat from dataformat.yaml.

Returns:

Populated DataFormat instance.

Return type:

DataFormat

Modules

track_io

Track data model, on-disk file I/O, and lookup helpers for this project's own tracks/+annotations/ dataset format (see docs/source/data.rst).