Reports

A Report defines and organizes the structure of experiment results. It holds a list of Run objects and a sequence of content blocks.

Reports are composed of individual blocks such as headings, tables, text sections, or figures. These blocks define the structure of the report, while exporters define how the report is rendered and saved.

Tip

By default, all blocks in a report use the global list of runs unless a block is initialized with a specific list of runs via its runs attribute.

Report

class ablate.Report(runs)

Report mapping a list of runs to a list of blocks.

Parameters:

runs (List[Run]) – List of runs to be associated with the report.

add(*blocks)

Add one or more blocks to the report.

Parameters:

blocks (AbstractBlock) – One or more blocks to be added to the report.

Return type:

Self

Returns:

The updated report with the added blocks.