Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation - specify model for each function exactly #41

Open
keunwoochoi opened this issue Aug 24, 2021 · 2 comments
Open

Documentation - specify model for each function exactly #41

keunwoochoi opened this issue Aug 24, 2021 · 2 comments

Comments

@keunwoochoi
Copy link

(openjournals/joss-reviews#3391)

For developers who are not MIR researchers, it'd be much clearer if the used model is specified in each API (e.g., https://music-and-culture-technology-lab.github.io/omnizart-doc/music/cli.html) instead of only in the main doc (https://music-and-culture-technology-lab.github.io/omnizart-doc/). And that's because,

musical notes of instruments [WCS20], chord progression [CS19], drum events [WWS20], frame-level vocal melody [LS18], note-level vocal melody [HS20], and beat [CS20].

this description might not be 100% clear for non-researchers.

@keunwoochoi
Copy link
Author

To clarify; just realized they are specified in the APIs (https://music-and-culture-technology-lab.github.io/omnizart-doc/music/api.html). Maybe specifying which API is being used for each command line interface would do the job.

@BreezeWhite
Copy link
Member

Maybe I can add a reference link to the API page if someone wants to know more information about the model.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants