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

Compacity metric #242

Conversation

Francesco-Marini
Copy link
Contributor

Description

This PR creates a new plot that allows users to determine if a small subset of features that is able to well explain the model exists.

Fixes #241

Type of change

  • New feature (non-breaking change which adds functionality or feature that would cause existing functionality to not work as expected)

How Has This Been Tested?

Methods used to calculate the metrics have been tested via the pytest module. Those tests are located in tests/unit_tests/utils/test_explanation_metrics.py, tests/unit_tests/explainer/test_smart_explainer.py, tests/unit_tests/explainer/test_smart_plotter.py. In addition, a visualization through the existing tutorial plot has been done.

Test Configuration:

  • OS: macOS
  • Python version: 3.7
  • Shapash version: 1.4.4

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Copy link
Contributor

@yg79 yg79 left a comment

Choose a reason for hiding this comment

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

Good job Francesco !
I suggest you some minor modifications

shapash/explainer/smart_plotter.py Outdated Show resolved Hide resolved
shapash/explainer/smart_plotter.py Outdated Show resolved Hide resolved
shapash/explainer/smart_plotter.py Outdated Show resolved Hide resolved
shapash/explainer/smart_plotter.py Outdated Show resolved Hide resolved
@yg79 yg79 merged commit 42bff35 into MAIF:feature/explanation_metrics Sep 14, 2021
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.

None yet

2 participants