Documentation fix and cleanup - Githubissues

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

89 stars 9 forks source link

Documentation fix and cleanup #521

Closed AnesBenmerzoug closed 3 months ago

AnesBenmerzoug commented 3 months ago

Description

This PR closes #515 #514 #482 and part of #462

Changes

Changed fetch depth in CI to 0 for jobs that build documentation.
Used absolute URLs for images in readme.
Moved list of papers from readme to a new page in documentation.
Added new abbreviations.
Added missing data banzhaf reference to bibliography.
Improved mkdocs hook for modifying binder links in rendered notebooks.
Added beautifulsoup4 as a docs dependency.
Bumped version of some docs requirements.

Checklist

[ ] ~Wrote Unit tests (if necessary)~
[X] Updated Documentation (if necessary)
[ ] Updated Changelog
[ ] ~If notebooks were added/changed, added boilerplate cells are tagged with "tags": ["hide"] or "tags": ["hide-input"]~

AnesBenmerzoug commented 3 months ago

@schroedk should I also add specific instructions for installing the influences extra requirements in this PR or will you take care of it?

schroedk commented 3 months ago

@schroedk should I also add specific instructions for installing the influences extra requirements in this PR or will you take care of it?

@AnesBenmerzoug, I will take care of it