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 model accuracies to docstrings #125

Closed
jneeven opened this issue Mar 5, 2020 · 0 comments · Fixed by #145
Closed

Add model accuracies to docstrings #125

jneeven opened this issue Mar 5, 2020 · 0 comments · Fixed by #145
Labels
documentation Issues related to documentation good first issue Good for newcomers

Comments

@jneeven
Copy link
Contributor

jneeven commented Mar 5, 2020

Feature motivation

Since the docs are maintained separately from the repo, it would be good to state the imagenet accuracy of each model (and potentially other stats such as number of params and model size) to the model docstring. This mitigates the risk of confusion and/or bugs should the docs ever become out of sync.

Feature description

Assuming the stats on https://docs.larq.dev/zoo/ are currently correct, we can just copy those into the relevant docstrings.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues related to documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants