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

Simplify to have single reference for configs in docs + templatize where possible #152

Open
ejm714 opened this issue Oct 25, 2021 · 0 comments

Comments

@ejm714
Copy link
Collaborator

ejm714 commented Oct 25, 2021

We should have one canonical place for configurations in the docs. Currently, configuration params are documented multiple times and this means it can be easy for the docs to conflict or get out of date.

For example, configurations are specified twice in configurations.md (help text + paragraph form) in addition to the API reference zamba.models.config.

Relatedly, we should consider templatizing the cli help in quickstart.md as well as in the DensePose models page so this always uses the latest and does not require manual updates.

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

No branches or pull requests

1 participant