search

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

The glossary makes the methods page redundant? #547

Open mdbenito opened 6 months ago

mdbenito commented 6 months ago

The new Glossary page makes the Methods page a bit redundant because it contains descriptions of some of the methods as well as links to the implementations. Perhaps we can keep method descriptions in Methods and only put other terms in the Glossary.

Originally posted by @AnesBenmerzoug in https://github.com/aai-institute/pyDVL/issues/537#issuecomment-2016601355

mdbenito commented 6 months ago

Reply

The methods page is a quick list with links for reference for newcomers ("is my algorithm here?"). Whereas the glossary is for quick definitions that can be linked from anywhere. I would imagine that in time, if we really want the glossary to be useful, we'd cross-ref to it from all over the docs, possibly adding a little tooltip with the definition (using e.g. the couple of js+css files suggested here).