xai4tsc.xai
===========

.. py:module:: xai4tsc.xai

.. autoapi-nested-parse::

   Explainer base classes, built-in Captum methods, and the ``EXPLAINERS`` registry.

   Submodules:

   - :mod:`~xai4tsc.xai.explain` — the :func:`generate_explanation` entry point and
     the ``EXPLAINERS`` registry.
   - :mod:`~xai4tsc.xai.feature_attribution` — Captum gradient / perturbation
     methods and TSHAP.
   - :mod:`~xai4tsc.xai.freqrise`, :mod:`~xai4tsc.xai.explanation_domains`,
     :mod:`~xai4tsc.xai.random_baseline` — frequency and time-frequency explainers.
   - :mod:`~xai4tsc.xai.wrappers` — the SIGN wrapper.
   - :mod:`~xai4tsc.xai._types` — the :class:`Explanation` dataclass and the
     :class:`Domain` / :class:`DataType` enums.
   - :mod:`~xai4tsc.xai.base` — the explainer base classes.

   Use :func:`generate_explanation` as the main entry point. Subclass
   :class:`~xai4tsc.xai.base.ExplainerBase` (or one of its mid-level
   specialisations) to add a custom method.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/xai4tsc/xai/base/index
   /autoapi/xai4tsc/xai/explain/index
   /autoapi/xai4tsc/xai/explanation_domains/index
   /autoapi/xai4tsc/xai/feature_attribution/index
   /autoapi/xai4tsc/xai/freqrise/index
   /autoapi/xai4tsc/xai/random_baseline/index
   /autoapi/xai4tsc/xai/wrappers/index