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

DOCS: Remove boston dataset from the README #3200

Merged
merged 7 commits into from Sep 13, 2023
Merged

DOCS: Remove boston dataset from the README #3200

merged 7 commits into from Sep 13, 2023

Conversation

dsgibbons
Copy link
Collaborator

@dsgibbons dsgibbons commented Aug 21, 2023

Overview

Closes dsgibbons#8 and resolves the issues noted in dsgibbons#8 (comment)

Related to #2322

Updating the README required the following additional changes:

  • Use relative paths for README images instead of URLs tied to master.
  • HTML plots generated inside a notebook, rendered in Chrome, and then screenshotted. There is no obvious way to convert the HTML straight to an image, as it requires JS - unless @connortann or @thatlittleboy know of a better way to convert shap HTML to PNG? I've tried several different HTML to PNG converters, but I keep getting a shap error saying JS needs initialising.

Checklist

  • All pre-commit checks pass. - no, dependabot is not happy?
  • Unit tests added (if fixing a bug or adding a new feature)

@dsgibbons
Copy link
Collaborator Author

dsgibbons commented Aug 21, 2023

Tests are failing due to calls to shap.summary_plot. Something about constrained mode is breaking shap.summary_plot. I think shap.summary_plot is an outdated API that used to be a catchall term for the various plot types (beeswarm, violin, etc.). Is it worth me fixing the test, or should we remove shap.summary_plot as it probably shouldn't be used any more? The new plots in constrained mode all look fine in mpl.

@dsgibbons
Copy link
Collaborator Author

dsgibbons commented Aug 21, 2023

Never mind, I think I've fixed shap.summary_plot. It may still be worth removing shap.summary_plot any way to reduce the size of the codebase.

@dsgibbons
Copy link
Collaborator Author

Never mind, I think I've fixed shap.summary_plot. It may still be worth removing shap.summary_plot any way to reduce the size of the codebase.

Looks like this is a duplicate of #3156

@dsgibbons
Copy link
Collaborator Author

I've added a commit to update the mpl image baselines. We can revert this if references to the legacy summary_plot are removed.

@dsgibbons dsgibbons changed the title Remove boston dataset from the README DOCS: Remove boston dataset from the README Aug 22, 2023
@dsgibbons
Copy link
Collaborator Author

dsgibbons commented Aug 22, 2023

There's a discrepancy between how my setup generates the baselines and GitHub Actions. I'll need to alter my setup so that I produce the same outputs as GitHub Actions.

@dsgibbons dsgibbons marked this pull request as ready for review August 22, 2023 00:34
@dsgibbons dsgibbons marked this pull request as draft August 22, 2023 01:44
shap/plots/_bar.py Outdated Show resolved Hide resolved
@dsgibbons dsgibbons marked this pull request as ready for review September 1, 2023 04:00
@dsgibbons
Copy link
Collaborator Author

I've removed the changes to SHAP's plotting functionality. I think these changes should be postponed pending the wider plotting API change proposed for 0.44 by #2363.

Copy link
Collaborator

@thatlittleboy thatlittleboy left a comment

Choose a reason for hiding this comment

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

LGTM, @dsgibbons one minor comment, any reason why we're not removing the boston_xxx.png files from docs/artwork?



recursive-thumbsup-in-video-recording

@dsgibbons
Copy link
Collaborator Author

dsgibbons commented Sep 13, 2023

LGTM, @dsgibbons one minor comment, any reason why we're not removing the boston_xxx.png files from docs/artwork?

Good point, removed!

@dsgibbons dsgibbons merged commit e8a176e into master Sep 13, 2023
1 of 2 checks passed
@connortann connortann deleted the update-readme branch September 13, 2023 19:28
@connortann connortann added the documentation Relating to readthedocs, notebooks, and exposition in docstrings label Oct 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Relating to readthedocs, notebooks, and exposition in docstrings
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Replace Boston dataset in examples
3 participants