Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme improvements #465

Merged
merged 14 commits into from
Dec 11, 2023
Merged

Readme improvements #465

merged 14 commits into from
Dec 11, 2023

Conversation

AnesBenmerzoug
Copy link
Collaborator

@AnesBenmerzoug AnesBenmerzoug commented Dec 9, 2023

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)
  • Updated Changelog
  • If notebooks were added/changed, added boilerplate cells are tagged with "tags": ["hide"] or "tags": ["hide-input"]

@AnesBenmerzoug AnesBenmerzoug self-assigned this Dec 9, 2023
Copy link
Collaborator

@mdbenito mdbenito left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a comment. Plus what we discussed in the meeting

README.md Outdated Show resolved Hide resolved
@mdbenito mdbenito merged commit 2f0262a into develop Dec 11, 2023
18 checks passed
@mdbenito mdbenito deleted the doc/461-readme-improvements branch December 13, 2023 07:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add plots and images to README
2 participants