Changelog

The full release history, taken from the project CHANGELOG.md.

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

examples-lite extra: the example notebooks’ model libraries (xgboost, lightgbm, ruptures) plus ipykernel, without Jupyter Notebook/Lab. Works around a Windows install failure where Jupyter’s bundled JS assets exceed the default 260-character path limit; run the notebooks in VS Code’s Jupyter extension instead.

Documented the examples-lite fallback and the Windows long-path failure it works around.

Package scaffolding and CI (via bootstrap-package-repo.sh).
breaks: resolve regime specifications (per-row labels, date-range tuples, or a label-to-range mapping) into per-row labels, with optional ruptures-based break detection.
compare: per-regime SHAP feature importance and rankings, with per-regime sample sizes and a small-sample flag.
stability: pairwise Spearman rank-correlation matrix, the Akoglu (2018) stability bands, and bootstrap confidence intervals for small regimes.
plots: global importance bar, per-regime importance heatmap, and the Akoglu-banded stability heatmap with small-regime flags.
report: self-contained HTML report plus dict and CSV export of the result tables.
RegimeSHAPAnalyzer: the one-call entry point that ties the modules together, exported from the package top level.
examples: two worked example notebooks (finance market regimes, energy demand regimes) on public non-GDP datasets.

Documented the supported-model boundary: the package is tree-only via TreeExplainer, the stability methodology is model-agnostic, and pluggable explainers for other models are a possible future extension (tracked in issue #8).
Sphinx documentation site, published on GitHub Pages.