experiment_runner.main
======================

.. py:module:: experiment_runner.main

.. autoapi-nested-parse::

   Entry point for the xai4tsc experiment runner.

   Run from the repository root as a module::

       python -m experiment_runner.main --conf path/to/config.yaml

   Orchestrates the full evaluation pipeline as a nested loop over datasets,
   models, explainers, and metrics. Results are saved as ``metrics.csv`` files
   at three granularity levels (global, per-dataset, per-model) under
   ``results_rel_path``.



Attributes
----------

.. autoapisummary::

   experiment_runner.main.logger
   experiment_runner.main.MASTER_CONFIG
   experiment_runner.main.parser


Functions
---------

.. autoapisummary::

   experiment_runner.main.expand_datasets
   experiment_runner.main.main
   experiment_runner.main.initial_setup


Module Contents
---------------

.. py:data:: logger

.. py:data:: MASTER_CONFIG

.. py:function:: expand_datasets(datasets: list[dict]) -> list[dict]

   Expand archive wildcards and resolve per-member ``overrides``.

   Each entry is either a concrete dataset or an archive keyword
   (``UCR`` / ``UEA``) that expands to all its member datasets. An entry's
   inline settings apply to every member it produces; an optional
   ``overrides`` map (``{dataset_name: {setting: value}}``) sets per-member
   exceptions that take precedence over the entry's inline settings.

   :param datasets: Raw ``data_config["datasets"]`` entries.
   :type datasets: list[dict]

   :returns: Concrete dataset entries with ``overrides`` resolved and stripped.
   :rtype: list[dict]


.. py:function:: main(config_path: str, debug: bool = False) -> None

   Run a complete XAI evaluation experiment from a YAML configuration file.

   Orchestrates the full pipeline as a nested loop over datasets → models →
   explainers → metrics. Results are saved as ``metrics.csv`` at three
   granularity levels (global, per-dataset, per-model) under
   ``results_rel_path``.


.. py:function:: initial_setup(config_path: str, debug: bool = False) -> dict

   Set up experiment as described in the given configuration file.

   :param config_path: Path to the experiment configuration.
   :type config_path: str
   :param debug: Enable debug-level logging.
   :type debug: bool

   :returns: The extracted configuration.
   :rtype: dict


.. py:data:: parser