Skip to content

Commit ada19d0

Browse files
authored
add citation (#241)
1 parent 3cb29d2 commit ada19d0

File tree

2 files changed

+24
-1
lines changed

2 files changed

+24
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,4 +94,14 @@ The documentation of ``shapiq`` can be found at https://shapiq.readthedocs.io
9494

9595
## 💬 Citation
9696

97-
If you **enjoy** `shapiq` consider starring ⭐ the repository.
97+
If you use the `shapiq` package, please cite our [NeurIPS paper](https://arxiv.org/abs/2410.01649):
98+
99+
```html
100+
@inproceedings{muschalik2024shapiq,
101+
title = {shapiq: Shapley Interactions for Machine Learning},
102+
author = {Maximilian Muschalik and Hubert Baniecki and Fabian Fumagalli and
103+
Patrick Kolpaczki and Barbara Hammer and Eyke H\"{u}llermeier},
104+
booktitle = {NeurIPS},
105+
year = {2024}
106+
}
107+
```

docs/source/index.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,19 @@ The ``shapiq`` Python package
33

44
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.
55

6+
If you use the ``shapiq`` package, please cite our `NeurIPS paper <https://arxiv.org/abs/2410.01649>`_:
7+
8+
.. code::
9+
10+
@inproceedings{muschalik2024shapiq,
11+
title = {shapiq: Shapley Interactions for Machine Learning},
12+
author = {Maximilian Muschalik and Hubert Baniecki and Fabian Fumagalli and
13+
Patrick Kolpaczki and Barbara Hammer and Eyke H\"{u}llermeier},
14+
booktitle = {NeurIPS},
15+
year = {2024}
16+
}
17+
18+
619
Contents
720
~~~~~~~~
821

0 commit comments

Comments
 (0)