Installation

Install the latest release from PyPI:

pip install regime-shap

Optional extras

The core install covers the analysis. The optional extras add features you may not need:

detection: the ruptures change-point library, needed only for detect_breaks.
examples: the tools to run the example notebooks (Jupyter, XGBoost, and others).
examples-lite: the same model libraries as examples, without Jupyter. Use this if pip install "regime-shap[examples]" fails on Windows with an error mentioning Long Path support, then open the notebook in VS Code’s own Jupyter extension instead of Jupyter Notebook/Lab. Jupyter’s own packages bundle built JS assets with very long generated filenames, which can exceed Windows’ default 260-character path limit; examples-lite needs only ipykernel to let VS Code run the same notebooks.
docs: the toolchain to build this documentation.
dev: the test and linting toolchain.

Install an extra with, for example:

pip install "regime-shap[detection]"

For development or the latest unreleased changes, install from the repository:

git clone https://github.com/faithcodes-lab/regime-shap.git
cd regime-shap
pip install -e ".[dev]"

Python 3.10 or newer. The core dependencies (numpy, pandas, scipy, shap, matplotlib) are installed automatically.

regime-shap follows Semantic Versioning; during the 0.x series the public API may change between releases. It is released under the MIT licence.