search

drivendataorg / zamba

A Python package for identifying 42 kinds of animals, training custom models, and estimating distance from camera trap videos
https://zamba.drivendata.org/docs/stable/
MIT License
118 stars 27 forks source link

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

Open ejm714 opened 3 years ago

ejm714 commented 3 years ago

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.