xai4tsc.evaluation
==================

.. py:module:: xai4tsc.evaluation

.. autoapi-nested-parse::

   XAI evaluation metrics wrapping the Quantus library.

   Submodules:

   - :mod:`~xai4tsc.evaluation.evaluate` — the :func:`evaluate` entry point and the
     ``METRICS`` registry.
   - :mod:`~xai4tsc.evaluation.base` — the :class:`EvaluatorBase` /
     :class:`QuantusEvaluator` wrappers.
   - :mod:`~xai4tsc.evaluation.frequency_evaluate`,
     :mod:`~xai4tsc.evaluation.timefrequency_perturbation`,
     :mod:`~xai4tsc.evaluation.timefrequency_auc` — native frequency and
     time-frequency metrics.

   Use :func:`evaluate` as the main entry point. The ``METRICS`` registry maps metric names
   to callables that produce an :class:`EvaluatorBase` (native subclasses, or the single
   :class:`QuantusEvaluator` bound to a name from ``QUANTUS_METRICS``); use
   :func:`register_metric` to add custom ones.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/xai4tsc/evaluation/base/index
   /autoapi/xai4tsc/evaluation/evaluate/index
   /autoapi/xai4tsc/evaluation/frequency_evaluate/index
   /autoapi/xai4tsc/evaluation/timefrequency_auc/index
   /autoapi/xai4tsc/evaluation/timefrequency_perturbation/index