Skip to content

Commit ae35bd6

Browse files
committed
updated README.md and doc
1 parent 84c0b43 commit ae35bd6

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,11 @@
1919
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.
2020

2121
## 🛠️ Install
22-
`shapiq` is intended to work with **Python 3.10 and above**. Installation can be done via `pip`:
22+
`shapiq` is intended to work with **Python 3.10 and above**. Installation can be done via `uv` and `pip`:
23+
24+
```sh
25+
uv add shapiq
26+
```
2327

2428
```sh
2529
pip install shapiq

examples/api_examples/si_graph.ipynb

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"id": "58b9498051a5294b",
66
"metadata": {},
77
"source": [
8-
"# SI Graph Plot\n",
8+
"# API Example: SI Graph Plot\n",
99
"\n",
1010
"This notebook is designed to demonstrate (and to document) how to use the `shapiq.si_graph` plot.\n",
1111
"The SI-graph-plot visualizes all interactions of computed Shapley Interactions, including those of higher order, as a network.\n",
@@ -49,7 +49,6 @@
4949
"id": "b857f08efa0c61d4",
5050
"metadata": {},
5151
"source": [
52-
"\n",
5352
"## General Use\n",
5453
"The easiest use is simply calling interaction_values.si_graph_plot() on the interaction values you want to visualize. \n",
5554
"But first, we import the needed modules and train a model we want to explain.\n",
@@ -215,7 +214,7 @@
215214
"id": "11e70372add8e9a",
216215
"metadata": {},
217216
"source": [
218-
"# Adjusting the positions\n",
217+
"## Adjusting the positions\n",
219218
"The positions of the nodes are determined automatically.\n",
220219
"The base case is a circular layout, we can change it to a spring layout by setting ``circular_layout = False``.\n",
221220
"It is also possible to set the positions manually, with a dict mapping the players to their respective positions.\n",
@@ -228,7 +227,7 @@
228227
"id": "83927d1f7f4f63e6",
229228
"metadata": {},
230229
"source": [
231-
"# Focusing on specific interactions\n",
230+
"## Focusing on specific interactions\n",
232231
"When plotting interaction values of higher orders, the number of edges can make it difficult to read.\n",
233232
"If we want to simplify our graph, we can filter and visualize only a subset of interactions that are most relevant.\n",
234233
"For example, we can focus on interactions above a certain threshold, select the 10 strongest interactions (by absolute value), or limit our view to only positive or negative interactions.\n",

0 commit comments

Comments
 (0)