Report

Report is an abstract base for custom result exporters. Subclass it to turn a list of OutputBatches into whatever artifact your analysis needs (a CSV, an HTML page, a notebook), implementing save and dump_data.

report

Report 

Report(output: list[OutputBatch[DataT, SolutionT]])

Bases: ABC

Abstract base for custom result exporters. Subclass it to turn a run's output into whatever artifact your analysis needs — a CSV, an HTML page, a notebook — by implementing save and dump_data.

The output batches (one per data item) are passed to the constructor and stored for the subclass to format.

Store the run output to export.

Parameters:
  • output (list[OutputBatch[DataT, SolutionT]]) –

    The output batches to turn into a report, one per data item.

save abstractmethod 

save(path: Path) -> None

Write the report artifact (the human-facing rendering) to path.

dump_data abstractmethod 

dump_data(path: Path) -> None

Write the report's underlying structured data to path for further analysis (e.g. a CSV or JSON export).