Skip to content
Open
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ repos:
exclude: LICENSE

- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.14.14
rev: v0.15.8
hooks:
- id: ruff-format
- id: ruff
Expand Down
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,9 @@ Thanks to this generalization encompassing all concept-based methods and our hig

To evaluate attribution methods faithfulness, there are the [`Insertion`](https://for-sight-ai.github.io/interpreto/api/attributions/metrics/insertion/) and [`Deletion`](https://for-sight-ai.github.io/interpreto/api/attributions/metrics/deletion/) metrics.

Attribution methods can also be evaluated globally via [`Automated Simulatability`](https://for-sight-ai.github.io/interpreto/api/attributions/metrics/attrsim/).

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

If you modify the README.md, do not forget the docs/index.md

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

it's already done :)



**Evaluation Metrics for Concepts**

Concept-based methods have several steps that can be evaluated together via [`ConSim`](https://for-sight-ai.github.io/interpreto/api/concepts/metrics/consim/).
Expand Down
3 changes: 3 additions & 0 deletions docs/api/attributions/metrics/attrsim.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Automated Simulatability Metric for Attribution Methods

::: interpreto.concepts.metrics.simulatability.attrsim.AttrSim
2 changes: 2 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,8 @@ The following list will **soon be available**:

To evaluate attribution methods faithfulness, there are the [`Insertion`](https://for-sight-ai.github.io/interpreto/api/attributions/metrics/insertion/) and [`Deletion`](https://for-sight-ai.github.io/interpreto/api/attributions/metrics/deletion/) metrics.

Attribution methods can also be evaluated globally via [`Automated Simulatability`](https://for-sight-ai.github.io/interpreto/api/attributions/metrics/attrsim/).

**Evaluation Metrics for Concepts**

Concept-based methods have several steps that can be evaluated together via [`ConSim`](https://for-sight-ai.github.io/interpreto/api/concepts/metrics/consim/).
Expand Down
3 changes: 2 additions & 1 deletion interpreto/concepts/metrics/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,12 @@
ReconstructionError,
ReconstructionSpaces,
)
from .simulatability import ConSim
from .simulatability import AttrSim, ConSim
from .sparsity_metrics import Sparsity, SparsityRatio

__all__ = [
"ConceptMatchingAlgorithm",
"AttrSim",
"ConSim",
"Stability",
"ReconstructionError",
Expand Down
1 change: 1 addition & 0 deletions interpreto/concepts/metrics/simulatability/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,5 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

from .attrsim import AttrSim
from .consim import ConSim
Loading
Loading