Skip to main content

JAMS: A JSON Audio Metadata Standard

Project description

jams

PyPI License Tests codecov

A JSON Annotated Music Specification for Reproducible MIR Research.

Please, refer to documentation for a comprehensive description of JAMS.

What

JAMS is a JSON-based music annotation format.

We provide:

  • A formal JSON schema for generic annotations
  • The ability to store multiple annotations per file
  • Schema definitions for a wide range of annotation types (beats, chords, segments, tags, etc.)
  • Error detection and validation for annotations
  • A translation layer to interface with mir eval for evaluating annotations

Why

Music annotations are traditionally provided as plain-text files employing simple formatting schema (comma or tab separated) when possible. However, as the field of MIR has continued to evolve, such annotations have become increasingly complex, and more often custom conventions are employed to represent this information. And, as a result, these custom conventions can be unwieldy and non-trivial to parse and use.

Therefore, JAMS provides a simple, structured, and sustainable approach to representing rich information in a human-readable, language agnostic format. Importantly, JAMS supports the following use-cases:

  • multiple types annotations
  • multiple annotations for a given task
  • rich file level and annotation level metadata

How

This library is offered as a proof-of-concept, demonstrating the promise of a JSON-based schema to meet the needs of the MIR community. To install, clone the repository into a working directory and proceed thusly.

The full documentation can be found here.

Who

To date, the initial JAMS effort has evolved out of internal needs at MARL@NYU, with some great feedback from our friends at LabROSA.

If you want to get involved, do let us know!

Details

JAMS is proposed in the following publication:

[1] Eric J. Humphrey, Justin Salamon, Oriol Nieto, Jon Forsyth, Rachel M. Bittner, and Juan P. Bello, "JAMS: A JSON Annotated Music Specification for Reproducible MIR Research", Proceedings of the 15th International Conference on Music Information Retrieval, 2014.

The JAMS schema and data representation used in the API were overhauled significantly between versions 0.1 (initial proposal) and 0.2 (overhauled), see the following technical report for details:

[2] B. McFee, E. J. Humphrey, O. Nieto, J. Salamon, R. Bittner, J. Forsyth, J. P. Bello, "Pump Up The JAMS: V0.2 And Beyond", Technical report, October 2015.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jams-0.3.5.tar.gz (72.8 kB view details)

Uploaded Source

Built Distribution

jams-0.3.5-py3-none-any.whl (67.3 kB view details)

Uploaded Python 3

File details

Details for the file jams-0.3.5.tar.gz.

File metadata

  • Download URL: jams-0.3.5.tar.gz
  • Upload date:
  • Size: 72.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for jams-0.3.5.tar.gz
Algorithm Hash digest
SHA256 260b1922f0fac0b30d82f750e0b1d240905070db4e500b52efa8f3202409d0fe
MD5 149d4e9fcb60edaec0a314021d8b4c9d
BLAKE2b-256 35911df6b53375bd1f45821cbce864ab451a869c2714756dd852085e10373878

See more details on using hashes here.

Provenance

The following attestation bundles were made for jams-0.3.5.tar.gz:

Publisher: release.yml on marl/jams

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file jams-0.3.5-py3-none-any.whl.

File metadata

  • Download URL: jams-0.3.5-py3-none-any.whl
  • Upload date:
  • Size: 67.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for jams-0.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 b9f17ff2d95deb125e13001a50bafe338b68a9bf0c6df217f5b0f9e153041d0d
MD5 9a01f5193efad4b9f10563815cb79c3d
BLAKE2b-256 f2a879e80fef627eedf196c7e4efe758306eae46b1bc2b8411b8992c6d600eb4

See more details on using hashes here.

Provenance

The following attestation bundles were made for jams-0.3.5-py3-none-any.whl:

Publisher: release.yml on marl/jams

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page