search

vsoch / watchme

Reproducible watchers for research
https://vsoch.github.io/watchme/
Mozilla Public License 2.0
851 stars 32 forks source link

Metrics should have better descriptions #58

Open vsoch opened 5 years ago

preetijangra15 commented 2 years ago

i would like to help in this issue.

vsoch commented 2 years ago

Sure that would be great!

preetijangra15 commented 2 years ago

can you please describe this issue?

vsoch commented 2 years ago

Sure. I think what I had in mind is better documentation for the various return values for each metric described in this page: https://vsoch.github.io/watchme/watchers/psutils/ and this page https://vsoch.github.io/watchme/watchers/gpu/. E.g., for each of the gpu and psutils watchers:

Have a table of values with enjoy entries to describe each attribute that can be returned. There can be a section on those pages for the table.