Standardize modular documentation #1365
Labels
documentation
Improvements or additions to documentation
good first issue
Good for newcomers
help wanted
Extra attention is needed
Milestone
📚 Documentation
Similar to the work done in this PR:
#1360
We want to standardize the way documentation is organised for modular metrics. This includes:
update
andcompute
are excluded from docs as the docstrings are often not meaningful to begin with. Instead information about input/output tensors should be included in the class docstringlinks.rst
fileSome of the points also apply to the functional backend, but the modular backend is of most importance because it has the largest variance in how information is organised currently.
Following domains needs to be taken care of
Any contributions are welcome :]
The text was updated successfully, but these errors were encountered: