watchme icon indicating copy to clipboard operation
watchme copied to clipboard

Published 20 hours ago • verified publisher icon vsoch

Metrics should have better descriptions

Open vsoch opened this issue 5 years ago • 4 comments

vsoch avatar Jun 17 '19 14:06 vsoch

i would like to help in this issue.

preetijangra15 avatar Oct 08 '21 05:10 preetijangra15

Sure that would be great!

vsoch avatar Oct 08 '21 05:10 vsoch

can you please describe this issue?

preetijangra15 avatar Oct 08 '21 07:10 preetijangra15

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:

  • https://github.com/vsoch/watchme/blob/master/watchme/watchers/gpu/tasks.py
  • https://github.com/vsoch/watchme/blob/master/watchme/watchers/psutils/tasks.py

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.

vsoch avatar Oct 08 '21 13:10 vsoch