Repository navigation
README cleanup - #806
Merged
Merged
README cleanup#806
Conversation
Closed
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #806 +/- ##
========================================
Coverage 86.08% 86.08%
========================================
Files 115 115
Lines 11825 11825
Branches 2158 2158
========================================
Hits 10180 10180
Misses 1009 1009
Partials 636 636 🚀 New features to boost your workflow:
|
guerinclement
approved these changes
Oct 21, 2026
| <a href="https://shapash.readthedocs.io/en/latest/"> | ||
| <img src="https://readthedocs.org/projects/shapash/badge/?version=latest" alt="doc"> | ||
| </a> | ||
| <a href="https://shapash.readthedocs.io/en/stable/"><img src="https://readthedocs.org/projects/shapash/badge/?version=stable" alt="doc"></a> |
Collaborator
There was a problem hiding this comment.
Not sure why but this badge does not render well on your branch:
https://github.com/MAIF/shapash/tree/feature/update-readme
Can you try to use the target link: https://app.readthedocs.org/projects/shapash/badge/?version=stable
Collaborator
There was a problem hiding this comment.
Forget it, everything's fine.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
README cleanup: fix rendering glitches and broken links, bring "What's new" up to date, and list all current tutorials.
Closes #730
Badges
<a>was rendered as underlined link text, the same issue Add P16 and INRIA logo #797 fixed for the contributor logos.LICENSE(license). Before, they linked to their own badge images.stableinstead oflatest, which is hidden on RTD.What's new
local_plot), 2.8 (Global–Local importance and clusters in the webapp), 2.7 (feature importance by subpopulation), 2.4 (any SHAP-supported model), 2.1 (correlation matrix clustering).develop.Broken links and content fixes
feature/nlp-refactotodevelop.pip install "shapash[report]") so they also work in zsh.Tutorials
tutorial/is now listed. Added: plot07, ShapIQ, debugging and what-if (3), production (FastAPI, batch scoring), domain examples (6), NLP (2).Polish
raw.githubusercontent.com.