Readme improvements - 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

Readme improvements #465

Closed AnesBenmerzoug closed 6 months ago

AnesBenmerzoug commented 6 months ago

Description

This PR closes #336 and addresses parts of #461

Changes

Moved list of implemented papers to end of readme.
Split examples into steps to make it easier to understand each step.
Renamed Shapley Values section to Data Values.
Created plot_influence_distribution function.
Plot results of examples and add plots to readme.
Passed progress argument to permutation_montecarlo_shapley inside compute_shapley_values.

Checklist

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