Common loaders for MIR datasets.
Project description
mirdata
Common loaders for Music Information Retrieval (MIR) datasets. Find the API documentation here.
This library provides tools for working with common MIR datasets, including tools for:
- downloading datasets to a common location and format
- validating that the files for a dataset are all present
- loading annotation files to a common format, consistent with the format required by mir_eval
- parsing track level metadata for detailed evaluations
Installation
To install, simply run:
pip install mirdata
Quick example
import mirdata
orchset = mirdata.initialize('orchset')
orchset.download() # download the dataset
orchset.validate() # validate that all the expected files are there
example_track = orchset.choice_track() # choose a random example track
print(example_track) # see the available data
See the documentation for more examples and the API reference.
Currently supported datasets
Supported datasets include AcousticBrainz, DALI, Guitarset, MAESTRO, TinySOL, among many others.
For the complete list of supported datasets, see the documentation
Citing
There are two ways of citing mirdata:
If you are using the library for your work, please cite the version you used as indexed at Zenodo:
If you refer to mirdata's design principles, motivation etc., please cite the following paper:
"mirdata: Software for Reproducible Usage of Datasets"
Rachel M. Bittner, Magdalena Fuentes, David Rubinstein, Andreas Jansson, Keunwoo Choi, and Thor Kell
in International Society for Music Information Retrieval (ISMIR) Conference, 2019
@inproceedings{
bittner_fuentes_2019,
title={mirdata: Software for Reproducible Usage of Datasets},
author={Bittner, Rachel M and Fuentes, Magdalena and Rubinstein, David and Jansson, Andreas and Choi, Keunwoo and Kell, Thor},
booktitle={International Society for Music Information Retrieval (ISMIR) Conference},
year={2019}
}
When working with datasets, please cite the version of mirdata that you are using (given by the DOI above) AND include the reference of the dataset, which can be found in the respective dataset loader using the cite() method.
Contributing a new dataset loader
We welcome contributions to this library, especially new datasets. Please see contributing for guidelines.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file mirdata-0.3.9.tar.gz.
File metadata
- Download URL: mirdata-0.3.9.tar.gz
- Upload date:
- Size: 204.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7c987685c179ad5e9b80c645c3c33f3eb3aba7772dec0f2747a40425a4f92011 |
|
| MD5 | ca7e2345a3b7f642d107f9bfb5b69581 |
|
| BLAKE2b-256 | b6a30a91689af615c756b5a652e9cd247b086597ee0eb1d279ed87e12ad55478 |
File details
Details for the file mirdata-0.3.9-py3-none-any.whl.
File metadata
- Download URL: mirdata-0.3.9-py3-none-any.whl
- Upload date:
- Size: 260.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0d965f62d33041dd51bc0757854210ec851184956ab4f00818bd5374fffea1d3 |
|
| MD5 | ce711d17952e144546d7b61a54cfba7f |
|
| BLAKE2b-256 | 18a7319f375b7824c42b8be310ead7a09817265ea437403a789c5f516dbc497f |
