diff --git a/README.md b/README.md index 49eba9d643c278120c97e37a950909a4e36c2b7f..758614211ede9b994ed78c089d8d0d226556782d 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,27 @@ The goal of the polytopic approach is to define a new compression criteria, then It can be installed with pip using `pip install MusicOnPolytopes`. -[1] Marmoret, A., Cohen, J. E., & Bibmot, F. (2022). Polytopic Analysis of Music. arXiv preprint arXiv:2212.11054. -[2] Guichaoua, C., Modèles de compression et critères de complexité pour la description et l’inférence de structure musicale. PhD thesis, 2017. -[3] Louboutin, C., Modélisation multi-échelle et multi-dimensionnelle de la structure musicale par graphes polytopiques. PhD thesis, Rennes 1, 2019. -[4] Sargent, G., Bimbot, F., & Vincent, E. (2016). Estimating the structural segmentation of popular music pieces under regularity constraints. IEEE/ACM Transactions on Audio, Speech, and Language Processing, 25(2), 344-358. +## How to cite ## + +You should cite the package `MusicOnPolytopes`, available on HAL (https://hal.archives-ouvertes.fr/hal-03151484). + +Here are two styles of citations: + +As a bibtex format, this should be cited as: @softwareversion{marmoret2021musiconpolytopes, title={MusicOnPolytopes}, author={Marmoret, Axel and Cohen, J{\'e}r{\'e}my and Bimbot, Fr{\'e}d{\'e}ric}, URL={https://gitlab.inria.fr/amarmore/musiconpolytopes}, LICENSE = {BSD 3-Clause ''New'' or ''Revised'' License}, year={2021}} + +In the IEEE style, this should be cited as: A. Marmoret, J.E. Cohen, and F. Bimbot, "MusicOnPolytopes," 2021, url: https://gitlab.inria.fr/amarmore/musiconpolytopes. + +## Credits ## + +Code was created by Axel Marmoret (<axel.marmoret@gmail.com>). + +The technique in itself was strongly developed by Corentin Guichaoua, Corentin Louboutin, and Frédéric Bimbot (<bimbot@irisa.fr>). + +## References ## +[1] A. Marmoret, J.E. Cohen, and F. Bibmot, "Polytopic Analysis of Music", 2022, arXiv preprint arXiv:2212.11054. + +[2] C. Guichaoua, "Modèles de compression et critères de complexité pour la description et l’inférence de structure musicale", PhD thesis, Rennes 1, 2017. + +[3] C. Louboutin, "Modélisation multi-échelle et multi-dimensionnelle de la structure musicale par graphes polytopiques", PhD thesis, Rennes 1, 2019. + +[4] G. Sargent, F. Bimbot, and E. Vincent, "Estimating the structural segmentation of popular music pieces under regularity constraints", IEEE/ACM Transactions on Audio, Speech, and Language Processing, 25(2), 2016, pp. 344-358.