aai-institute / pyDVL

pyDVL is a library of stable implementations of algorithms for data valuation and influence function computation
https://pydvl.org
GNU Lesser General Public License v3.0
100 stars 8 forks source link

Add tests' documentation to rendered docs #386

Closed kosmitive closed 1 year ago

kosmitive commented 1 year ago

We added complex derivations to the tests. It would be beneficial to add docstrings of tests to the API reference inside of the documentation. Without it it is very hard to read the latex in code. Or we add the derivation inside of the documentation itself and not the docstring of the test. Thoughts?

mdbenito commented 1 year ago

Rendering docs for all tests would severely pollute the documentation. Do you have any specific examples in mind?

mdbenito commented 1 year ago

After giving this some thought I think the complex derivations could / should be moved to the main documentation if they belong there, or be left in the tests. Either they pertain to the use of the library or they don't... => closing