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: add cross referencing to several plots functions #3005

Merged
merged 11 commits into from Jun 26, 2023

Conversation

thatlittleboy
Copy link
Collaborator

@thatlittleboy thatlittleboy commented Jun 17, 2023

Overview

Description of the changes proposed in this pull request:

  • Documentation improvements to shap.plots functions, mostly to add in cross-references, fix typos, add links to API example notebooks etc.

Waiting on #3003 to be merged first, since this PR logically builds upon the changes from that PR. (DONE)

Checklist

  • Closes #xxxx
  • All pre-commit checks pass.
  • Unit tests added (if fixing a bug or adding a new feature)
  • Added entry to CHANGELOG.md (if changes will affect users)

@thatlittleboy thatlittleboy added the documentation Relating to readthedocs, notebooks, and exposition in docstrings label Jun 17, 2023
@codecov
Copy link

codecov bot commented Jun 17, 2023

Codecov Report

Merging #3005 (19bb92c) into master (2797db5) will not change coverage.
The diff coverage is 0.00%.

@@          Coverage Diff           @@
##           master   #3005   +/-   ##
======================================
  Coverage    0.00%   0.00%           
======================================
  Files          90      90           
  Lines       12850   12850           
======================================
  Misses      12850   12850           
Impacted Files Coverage Δ
shap/plots/_bar.py 0.00% <ø> (ø)
shap/plots/_beeswarm.py 0.00% <ø> (ø)
shap/plots/_decision.py 0.00% <ø> (ø)
shap/plots/_force.py 0.00% <0.00%> (ø)
shap/plots/_heatmap.py 0.00% <ø> (ø)
shap/plots/_image.py 0.00% <0.00%> (ø)
shap/plots/_scatter.py 0.00% <ø> (ø)
shap/plots/_text.py 0.00% <ø> (ø)
shap/plots/_violin.py 0.00% <ø> (ø)
shap/plots/_waterfall.py 0.00% <ø> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@thatlittleboy thatlittleboy force-pushed the docs/cross-referencing branch 2 times, most recently from d1d839c to 153ecc1 Compare June 24, 2023 08:44
@thatlittleboy thatlittleboy marked this pull request as ready for review June 24, 2023 09:19
@thatlittleboy thatlittleboy force-pushed the docs/cross-referencing branch 2 times, most recently from c64e78a to eb457ec Compare June 25, 2023 13:28
Copy link
Collaborator

@connortann connortann left a comment

Choose a reason for hiding this comment

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

LGTM!

@connortann connortann merged commit 9d72ec7 into master Jun 26, 2023
15 checks passed
@connortann connortann deleted the docs/cross-referencing branch June 26, 2023 12:30
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.

None yet

2 participants