Skip to main content

Musically motivated piano transcription evaluation

Project description

Towards Musically Informed Evaluation of Piano Transcription Models

PyPI Package DOI

This repository provides a set of evaluation metrics designed for piano transcription evaluation. The metrics are musically informed, meaning they take into account the nuances of musical performance, such as dynamics, note onset, and duration, to offer more differentiated and musically relevant assessments of transcription quality. Note that these metrics are a work in progress and actively being developed/refined/extended. Expect future updates, and feel free to contribute or share feedback!

Setup

The easiest way to install the package is via:

pip install mpteval

Dependencies

  • Python 3.10+
  • Parangonar 3.2.0
  • Partitura 1.8.0

Metrics computation

The following code loads a reference and a predicted MIDI and computes how well the transcription preserves timing information in the performance:

import mpteval
import partitura as pt

from mpteval.metrics_feature.timing import timing_metrics_from_perf

ref_perf = pt.load_performance_midi(mpteval.REF_MID)
pred_perf = pt.load_performance_midi(mpteval.PRED_MID)

timing_metrics = timing_metrics_from_perf(ref_perf, pred_perf)

Demo notebooks

You can find more examples of how the metrics and related functionality can be used in notebooks_demo. Likewise, you can check out our related work on biases in transcription models and [evaluation of large scale transcribed datasets](TODO add link).

Citing

If you use our metrics in your research, please cite the relevant paper:

@inproceedings{hu2024towards,
    title = {{Towards Musically Informed Evaluation of Piano Transcription Models}},
    author = {Hu, Patricia and Mart\'ak, Luk\'a\v{s} Samuel and Cancino-Chac\'on, Carlos and Widmer, Gerhard},
    booktitle = {{Proceedings of the International Society for Music Information Retrieval Conference (ISMIR)}},
    year = {2024}
}

Acknowledgments

This work is supported by the European Research Council (ERC) under the EU’s Horizon 2020 research & innovation programme, grant agreement No. 10101937 ("Whither Music?").

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

mpteval-1.1.0.tar.gz (37.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mpteval-1.1.0-py3-none-any.whl (38.8 kB view details)

Uploaded Python 3

File details

Details for the file mpteval-1.1.0.tar.gz.

File metadata

  • Download URL: mpteval-1.1.0.tar.gz
  • Upload date:
  • Size: 37.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for mpteval-1.1.0.tar.gz
Algorithm Hash digest
SHA256 22972ab8ad61201fc803e743bc39120a9cc2ce3b752295a37dd397365ff47e24
MD5 2b4b5d70d62aa3a907a52eb182681341
BLAKE2b-256 de719fef70d64da8fd7b7c508bc202b0393354d87da9a9156b915beb84c43673

See more details on using hashes here.

File details

Details for the file mpteval-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: mpteval-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 38.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for mpteval-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3d49f7d196c6fd4b129b11239a3963283220591ee1755f7186becb39d80ff777
MD5 d27b3d101b61e7a0c22d30fe75661f92
BLAKE2b-256 3e559f15b354b1aee57a31d9964965b9c346cd485f18a32383a78d38f0fd29e2

See more details on using hashes here.

Supported by

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