coco_pipe.report.decoding_comparison#

Cross-result collection and comparison helpers for decoding reports.

Classes#

ResultCollection

A labelled collection of decoding results and their tidy summaries.

Functions#

`collect_results`(items, *, by[, metrics])	Load labelled results and concatenate their scalar summaries.
`build_comparison_section`(collection, *, kind[, axis, ...])	Build one reusable cross-result comparison section.
`build_result_tabs`(collection, *[, sections, ...])	Build nested compact per-result sections from a collection.
`make_experiment_results_report`(items, *, by[, ...])	Build a comparison report over many labelled decoding results.

Module Contents#

class coco_pipe.report.decoding_comparison.ResultCollection#

A labelled collection of decoding results and their tidy summaries.

by: tuple[str, Ellipsis]#

results: dict[tuple[Any, Ellipsis], Any]#

contexts: dict[tuple[Any, Ellipsis], dict[str, Any]]#

summary: pandas.DataFrame#

filter(**criteria)#

Return a collection restricted to exact context matches.

Parameters:: criteria (Any)
Return type:: ResultCollection

property successful_summary: pandas.DataFrame#

Return only successfully loaded result summaries.

Return type:: pandas.DataFrame

coco_pipe.report.decoding_comparison.collect_results(items, *, by, metrics=None)#

Load labelled results and concatenate their scalar summaries.

Parameters:

items (collections.abc.Iterable[tuple[collections.abc.Mapping[str, Any], Any]])
by (collections.abc.Sequence[str])
metrics (collections.abc.Sequence[str] | None)

Return type:

ResultCollection

coco_pipe.report.decoding_comparison.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.

Notes

Unlike 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.

Parameters:

collection (ResultCollection)
kind (str)
axis (str | None)
row (str | None)
column (str)
value (str)
group_by (collections.abc.Sequence[str])
center (float | None)
info (Any)
coords (Any)
title (str | None)
include_table (bool)
on_error (str)

Return type:

coco_pipe.report.core.Section | None

coco_pipe.report.decoding_comparison.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.

Parameters:

collection (ResultCollection)
sections (str | collections.abc.Sequence[str])
feature_metadata (pandas.DataFrame | None)
info (Any)
coords (Any)
interactive (bool)
on_error (str)

Return type:

coco_pipe.report.elements.TabsElement | coco_pipe.report.elements.AccordionElement | None

coco_pipe.report.decoding_comparison.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.

Parameters:

comparisons (str | collections.abc.Sequence[collections.abc.Mapping[str, Any]]) – "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.
interactive (bool) – If True, per-result diagnostic sections render interactive Plotly figures (cross-result comparison figures remain static Matplotlib images).
items (collections.abc.Iterable[tuple[collections.abc.Mapping[str, Any], Any]])
by (collections.abc.Sequence[str])
per_result (str | collections.abc.Sequence[str] | None)
nest (bool)
feature_metadata (pandas.DataFrame | None)
info (Any)
coords (Any)
title (str)
config (collections.abc.Mapping[str, Any] | None)
asset_urls (collections.abc.Mapping[str, str] | str | None)
qc_result (Any)
output_path (str | pathlib.Path | None)
on_error (str)

Return type:

coco_pipe.report.core.Report