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

Add API documentation (e.g., readthedocs.io) #15

Open
adarob opened this issue Sep 15, 2020 · 7 comments
Open

Add API documentation (e.g., readthedocs.io) #15

adarob opened this issue Sep 15, 2020 · 7 comments

Comments

@adarob
Copy link
Contributor

adarob commented Sep 15, 2020

No description provided.

@studioph
Copy link

studioph commented Oct 3, 2020

I second this, I'm working on a ML project right now using NoteSequences, but having to manually inspect the source code is killing me

@deathrc
Copy link

deathrc commented Oct 22, 2020

Me too, looking forward to the official documentation.

@wtong98
Copy link

wtong98 commented Jul 18, 2021

Any updates on this issue? Would love to contribute if help is needed!

@adarob
Copy link
Contributor Author

adarob commented Jul 21, 2021

I'm not sure any of us on the Google side will have time to do this any time soon, but if someone would like to take it on, please do!

@wtong98
Copy link

wtong98 commented Jul 22, 2021

Sounds good, I threw together some super quick, autogenerated docs parsed from the docstrings. It's definitely not a long-term fix, but I hope some of you might find it useful until proper documentation is assembled.

For easy browsing, I've also uploaded the html files here: https://wlt.coffee/cream/docs/note_seq/

@kaosbeat
Copy link

kaosbeat commented Jul 30, 2021 via email

@adarob
Copy link
Contributor Author

adarob commented Jul 30, 2021

There is plenty happening on Magenta at Google, but we're heads down in research right now and don't have much time to devote to improving the library documentation.

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

5 participants