Skip to content

Commit

Permalink
Merge branch 'main' into 191-add-example-notebook-for-the-core
Browse files Browse the repository at this point in the history
  • Loading branch information
Advueu963 committed Oct 4, 2024
2 parents ed569bd + 65daf5b commit e2ea747
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,4 +94,14 @@ The documentation of ``shapiq`` can be found at https://shapiq.readthedocs.io

## 💬 Citation

If you **enjoy** `shapiq` consider starring ⭐ the repository.
If you use the `shapiq` package, please cite our [NeurIPS paper](https://arxiv.org/abs/2410.01649):

```html
@inproceedings{muschalik2024shapiq,
title = {shapiq: Shapley Interactions for Machine Learning},
author = {Maximilian Muschalik and Hubert Baniecki and Fabian Fumagalli and
Patrick Kolpaczki and Barbara Hammer and Eyke H\"{u}llermeier},
booktitle = {NeurIPS},
year = {2024}
}
```
13 changes: 13 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,19 @@ The ``shapiq`` Python package

Shapley Interaction Quantification (``shapiq``) is a Python package for (1) approximating any-order Shapley interactions, (2) benchmarking game-theoretical algorithms for machine learning, (3) explaining feature interactions of model predictions. ``shapiq`` extends the well-known `shap <https://github.com/shap/shap>`_ package for both researchers working on game theory in machine learning, as well as the end-users explaining models. SHAP-IQ extends individual Shapley values by quantifying the **synergy** effect between entities (aka **players** in the jargon of game theory) like explanatory features, data points, or weak learners in ensemble models. Synergies between players give a more comprehensive view of machine learning models.

If you use the ``shapiq`` package, please cite our `NeurIPS paper <https://arxiv.org/abs/2410.01649>`_:

.. code::
@inproceedings{muschalik2024shapiq,
title = {shapiq: Shapley Interactions for Machine Learning},
author = {Maximilian Muschalik and Hubert Baniecki and Fabian Fumagalli and
Patrick Kolpaczki and Barbara Hammer and Eyke H\"{u}llermeier},
booktitle = {NeurIPS},
year = {2024}
}
Contents
~~~~~~~~

Expand Down

0 comments on commit e2ea747

Please sign in to comment.