# API reference

The public API is the `RegimeSHAPAnalyzer` class plus the module-level functions it builds on.

## RegimeSHAPAnalyzer

```{eval-rst}
.. autoclass:: regime_shap.core.RegimeSHAPAnalyzer
   :members:
   :member-order: bysource
```

## regime_shap.breaks

```{eval-rst}
.. automodule:: regime_shap.breaks
   :members:
```

## regime_shap.compare

```{eval-rst}
.. automodule:: regime_shap.compare
   :members:
```

## regime_shap.stability

```{eval-rst}
.. automodule:: regime_shap.stability
   :members:
```

## regime_shap.plots

```{eval-rst}
.. automodule:: regime_shap.plots
   :members:
```

## regime_shap.report

```{eval-rst}
.. automodule:: regime_shap.report
   :members:
```