coco_pipe.report.decoding_comparison
====================================

.. py:module:: coco_pipe.report.decoding_comparison

.. autoapi-nested-parse::

   Cross-result collection and comparison helpers for decoding reports.



Classes
-------

.. autoapisummary::

   coco_pipe.report.decoding_comparison.ResultCollection


Functions
---------

.. autoapisummary::

   coco_pipe.report.decoding_comparison.collect_results
   coco_pipe.report.decoding_comparison.build_comparison_section
   coco_pipe.report.decoding_comparison.build_result_tabs
   coco_pipe.report.decoding_comparison.make_experiment_results_report


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

.. py:class:: ResultCollection

   A labelled collection of decoding results and their tidy summaries.


   .. py:attribute:: by
      :type:  tuple[str, Ellipsis]


   .. py:attribute:: results
      :type:  dict[tuple[Any, Ellipsis], Any]


   .. py:attribute:: contexts
      :type:  dict[tuple[Any, Ellipsis], dict[str, Any]]


   .. py:attribute:: summary
      :type:  pandas.DataFrame


   .. py:method:: filter(**criteria)

      Return a collection restricted to exact context matches.



   .. py:property:: successful_summary
      :type: pandas.DataFrame


      Return only successfully loaded result summaries.


.. py:function:: collect_results(items, *, by, metrics = None)

   Load labelled results and concatenate their scalar summaries.


.. py:function:: build_comparison_section(collection, *, kind, axis = None, row = None, column = 'Model', value = 'accuracy_mean', group_by = (), center = None, info = None, coords = None, title = None, include_table = False, on_error = 'warn')

   Build one reusable cross-result comparison section.

   .. rubric:: Notes

   Unlike :func:`build_decoding_sections`, ``on_error`` here accepts only
   ``"raise"`` or ``"warn"`` (not ``"placeholder"``). A comparison renders many
   per-group figures into one section, so a single group's failure is warned and
   skipped rather than replaced with a placeholder card.


.. py:function:: build_result_tabs(collection, *, sections = 'compact', feature_metadata = None, info = None, coords = None, interactive = False, on_error = 'warn')

   Build nested compact per-result sections from a collection.


.. py:function:: make_experiment_results_report(items, *, by, comparisons = 'default', per_result = 'compact', nest = True, feature_metadata = None, info = None, coords = None, interactive = False, title = 'Decoding Comparison', config = None, asset_urls = None, qc_result = None, output_path = None, on_error = 'warn')

   Build a comparison report over many labelled decoding results.

   :param comparisons: ``"default"`` (a single model-comparison view), ``"showcase"`` (model
                       comparison plus per-axis heatmap, score spread, and metric matrix keyed
                       on the first ``by`` axis), a single comparison ``kind`` string, or an
                       explicit sequence of comparison specs.
   :param interactive: If True, per-result diagnostic sections render interactive Plotly figures
                       (cross-result comparison figures remain static Matplotlib images).