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

API reference in documentation missing #28

Closed
jonnor opened this issue Jul 8, 2019 · 4 comments
Closed

API reference in documentation missing #28

jonnor opened this issue Jul 8, 2019 · 4 comments

Comments

@jonnor
Copy link
Contributor

jonnor commented Jul 8, 2019

When going to https://openl3.readthedocs.io/en/latest/api.html I only see the headers

Core functionality
Models functionality

with nothing under each header. Expected would be a list of classes and functions and the associated documentation. At least those APIs that are mentioned in the tutorial.

@auroracramer
Copy link
Collaborator

Hi, thanks for opening the issue. We still have yet to address this, but in the mean time you can view the stable build of the docs here:

https://openl3.readthedocs.io/en/stable/api.html

@jonnor
Copy link
Contributor Author

jonnor commented Jul 9, 2019

Thanks, that helps a lot!

As a minor thing, it would be nice to state the length of the analysis window in the reference documentation. I believe this is 1 second, but I had to go to the paper to check this.

@jonnor
Copy link
Contributor Author

jonnor commented Jul 9, 2019

Btw, I'm presenting Audio Classification using Machine Learning at EuroPython in a couple of days, and plan to include using OpenL3 audio embeddings there. https://ep2019.europython.eu/talks/ZUomjjw-audio-classification-with-machine-learning/
If by chance you are around, or know others that are, feel free to get in touch (email on Github profile)

@auroracramer
Copy link
Collaborator

The API documentation should be fixed. The issue was that we forgot to add sklearn.decomposition into the mocked modules in the Sphinx configuration which was causing the API docs to not build (albeit silently). Thanks for the feedback on the docs, we'll be sure to include that in our upcoming release.

Thanks for the heads up about your talk, and thanks for using our library! I don't believe anyone on our team will be at EuroPython but we'll let you know if that isn't the case. Cheers!

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