Skip to content

Commit 46d3475

Browse files
committed
Updating README
1 parent c0b8e97 commit 46d3475

File tree

1 file changed

+33
-4
lines changed

1 file changed

+33
-4
lines changed

README.md

+33-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,40 @@
11
# AugmentedNet
2-
A Roman Numeral Analysis Network with Synthetic Training Examples and Additional Tonal Tasks
32

4-
> The `main` branch is now an improved neural network. The source code of the published version (`v1.0.0`) can be found in the [v1](https://github.com/napulen/AugmentedNet/tree/v1) branch. The differences are indicated in any releases > `v1.0.0`. If you report against the published results, you are comparing against `v1.0.0`. If you want to compare against the latest network, train a model using this code.
3+
AugmentedNet is an automatic Roman numeral analysis neural network.
54

6-
### ISMIR Paper
5+
The network was developed by Néstor Nápoles López as part of his PhD research. It was first mentioned in a co-authored ISMIR paper in 2021, and later on in the body of the dissertation.
76

8-
N. Nápoles López, M. Gotham, and I. Fujinaga, "AugmentedNet: A Roman Numeral Analysis Network with Synthetic Training Examples and Additional Tonal Tasks." in *Proceedings of the 22nd International Society for Music Information Retrieval Conference*, 2021, pp. 404–411. https://doi.org/10.5281/zenodo.5624533
7+
It has been used to power the analysis features in at least the following projects:
8+
- [Sibelius](https://www.avid.com/resource-center/data-driven-workflows-within-sibelius)
9+
- [Vimu.app](https://www.vimu.app/)
10+
- [MusicLang](https://github.com/MusicLang/musiclang)
11+
12+
The version documented in the [PhD dissertation](https://escholarship.mcgill.ca/concern/theses/qr46r6307) matches the `v1.9.1` release of this repository.
13+
14+
The older version of the model described in the [ISMIR paper](https://archives.ismir.net/ismir2021/paper/000050.pdf) matches the `v1.0.0` release of this repository.
15+
16+
In general, the results of `v1.9.1` are better and it is encouraged to use (and compare against) that version.
17+
18+
### PhD Dissertation
19+
20+
Nápoles López, Néstor. 2022. “Automatic Roman Numeral Analysis in Symbolic Music Representations.” PhD Thesis, McGill University. https://escholarship.mcgill.ca/concern/theses/qr46r6307.
21+
22+
23+
```bibtex
24+
@phdthesis{napoleslopez22automatic,
25+
type = {{PhD} {Thesis}},
26+
title = {Automatic {Roman} {Numeral} {Analysis} in {Symbolic} {Music} {Representations}},
27+
url = {https://escholarship.mcgill.ca/concern/theses/qr46r6307},
28+
school = {McGill University},
29+
author = {Nápoles López, Néstor},
30+
month = dec,
31+
year = {2022}
32+
}
33+
```
34+
35+
### ISMIR Paper
36+
37+
N. Nápoles López, M. Gotham, and I. Fujinaga, “AugmentedNet: A Roman Numeral Analysis Network with Synthetic Training Examples and Additional Tonal Tasks.” in *Proceedings of the 22nd International Society for Music Information Retrieval Conference*, 2021, pp. 404–411. https://doi.org/10.5281/zenodo.5624533
938

1039

1140
```bibtex

0 commit comments

Comments
 (0)