axondeepseg icon indicating copy to clipboard operation
axondeepseg copied to clipboard

Documentation: Add instructions regarding the usage of ADS CLI's

Open vasudev-sharma opened this issue 4 years ago • 2 comments

Currently, the documentations only lists out detailed instructions on how to use axondeepseg and axondeepseg_test CLI.

The documentation seems to be lacking the instructions about the remaining CLI's that we do use in the project :-

  1. download_models
  2. download_tests

It would be nice to have information about the remaining ADS CLI's in the RTD for the developers, contributors or even users.

PS: Perhaps we could touch on this issue after ivadomed integration

vasudev-sharma avatar Jan 04 '21 14:01 vasudev-sharma

download_tests shouldn't really have a public API documentation, as it's only intended to be called during installation. We could clarify that internally for developers.

mathieuboudreau avatar Jan 04 '21 14:01 mathieuboudreau

download_tests shouldn't really have a public API documentation, as it's only intended to be called during installation. We could clarify that internally for developers.

yeah, I agree that download_tests CLI doesn't need to added in RTD. For this CLI, we could perhaps add instructions on WIKI .

vasudev-sharma avatar Jan 04 '21 15:01 vasudev-sharma