Rework information (#499)

* updated some little inconsistencies across the codebase

* updated github actions to cancel in progress

* updated some little inconsistencies across the codebase

* updated github actions to cancel in progress

Author: mmschlk

.github/CONTRIBUTING.md

@@ -68,7 +68,7 @@ to stay up-to-date with the latest Python versions. With `uv`, you can set up yo
 environment with the following command:
 
 ```sh
-uv sync --all-extras --dev
+uv sync
 ```
 
 Now you are all set up and ready to go.
@@ -117,7 +117,7 @@ uv sync --group docs
 Then, you can build the documentation from the root of the repository with:
 
 ```sh
-uv run sphinx-build docs/source docs/build
+uv run sphinx-build -b html docs/source docs/build/html
 ```
 
 This will render the documentation in the `docs/build` directory. You can open the `index.html` file
@@ -152,8 +152,15 @@ uv run pytest --cov=shapiq
 
 #### Static Type Checking and Code Quality
 
-Currently, we do not have static type checking in place. We use `pre-commit` to run some code quality
-checks. These checks **absolutely need to pass**. You can run the checks with the following command:
+We use [`ty`](https://github.com/astral-sh/ty) for static type checking on the `src/shapiq/` package.
+You can run the type checker with:
+
+```sh
+uv run ty check src/shapiq
+```
+
+We also use `pre-commit` to run code quality checks. These checks **absolutely need to pass**. You
+can run the checks with the following command:
 
 ```sh
 uv run pre-commit run --all-files

.github/workflows/ci.yml

@@ -5,7 +5,9 @@ on:
     push:
         branches: [main]
     workflow_dispatch:
-
+concurrency:
+    group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+    cancel-in-progress: true
 jobs:
     # ----------------------------------------------------------------------------------------------
     # Code Quality Checks and Linting

.gitignore

@@ -184,3 +184,5 @@ game_storage/*
 src/shapiq/_version.py
 docs/source/auto_examples/
 docs/source/sg_execution_times.rst
+
+.claude

AGENTS.md

@@ -1,4 +1,4 @@
-# CLAUDE.md
+# AGENTS.md
 
 Guidance for Claude Code when working in this repository.
 

README.md

@@ -19,7 +19,7 @@
 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.
 
 ## 🛠️ Install
-`shapiq` is intended to work with **Python 3.10 and above**.
+`shapiq` is intended to work with **Python 3.12 and above**.
 Installation can be done via `uv` :
 ```sh
 uv add shapiq

pyproject.toml

@@ -257,10 +257,7 @@ docs = [
     "nbconvert",                # notebook support for sphinx
     "nbsphinx",                 # notebook support for sphinx
     "commonmark",               # Markdown parser and renderer
-    # TODO(mmschlk): remove the pin in ipython when we drop python 3.10 support and pin to
-    # ipython>=9.0.0, since ipython==8.7.0 introduces a bug with parsing notebooks also discussed
-    # here: https://github.com/spatialaudio/nbsphinx/issues/24
-    "ipython<8.39.0",           # for code execution in notebooks
+    "ipython>=9.0.0",           # for code execution in notebooks
     "sphinx-gallery",           # gallery of examples from Python scripts
     "matplotlib",               # required for sphinx-gallery thumbnails
 ]