search

delve-team / delve

PyTorch model training and layer saturation monitor
https://delve-docs.readthedocs.io
MIT License
79 stars 13 forks source link

Provide examples of usage #40

Closed JustinShenk closed 3 years ago

JustinShenk commented 3 years ago

Examples of usage will make the configuration options easier to understand. The proposed documentation index is at https://github.com/delve-team/delve/blob/feature/sphinx/docs/source/index.rst. This divides examples, gallery, and usage into separate RST files.

Request: please provide some examples of logging and plotting examples in

https://github.com/delve-team/delve/blob/feature/sphinx/docs/source/examples.rst

and/or

https://github.com/delve-team/delve/blob/feature/sphinx/docs/source/gallery.rst

JustinShenk commented 3 years ago

plot_stat in writers.py is lacking documentation for usage. df is an argument, please describe input size, etc, preferably in the method doc string. @WolfByttner can maybe help with this, since he added sample-wise plotting in PR #26.