coco_pipe.report.from_reductions#

coco_pipe.report.from_reductions(reductions, container=None, embeddings=None, labels=None, metadata=None, times=None, title='DimReduction Comparison', config=None, sections='default', theme='paper', raw_preview=False, asset_urls=None, qc_result=None, output_path=None)#

Create a comparative report from multiple dimensionality reduction results.

Parameters:

  • reductions (List[Any]) – List of scored reduction objects implementing get_summary().

  • container (DataContainer, optional) – Original data container to include in “Data Overview”.

  • embeddings (list of np.ndarray, optional) – Explicit embedding payloads aligned with reductions.

  • labels (np.ndarray, optional) – Optional labels aligned with each embedding.

  • metadata (dict, optional) – Optional column-oriented metadata aligned with 2D embeddings.

  • times (np.ndarray, optional) – Optional time axis aligned with 3D trajectory embeddings.

  • title (str) – Report title.

  • config (dict, optional) – Extra configuration metadata stored in the report header.

  • sections (list of str or "default") – Ordered list of reduction sections to include.

  • theme (str) – Report theme preset.

  • raw_preview (bool) – If True and container is provided, add an interactive raw data scroller.

  • asset_urls (dict, optional) – Override JavaScript asset URLs used by the report shell.

  • qc_result (QCResult, optional) – Structured QC drop log rendered as a standard report section.

  • output_path (path-like, optional) – If given, save the rendered report to this path.

Returns:

Report with Data Overview (if valid) and one section per reduction.

Return type:

Report

Notes

Reduction summaries no longer carry cached embedding payloads. Pass embeddings explicitly when the report should render embedding or trajectory plots.

Examples

>>> report = from_reductions([pca, tsne], embeddings=[pca_emb, tsne_emb])
>>> report.save("report.html")