Configuration¶

This page describes how to configure the reporting module that generates reports from pipeline outputs.

Options¶

Name	Allowed	Default	Description
`_target_`	`"HTMLReporter", "PDFReporter", null`	`null`	Hydra target for the reporting backend implementation. Set to null to disable reporting. The default `reporting=html` config selects `HTMLReporter`; use `reporting=pdf` for the PDF renderer.
`filename`	`string`	`"report"`	Configured report basename. RAITAP adds the extension for the selected reporter, so `HTMLReporter` writes `.html` and `PDFReporter` writes `.pdf`.
`sample_selection`	`list of sample IDs, filenames, or zero-based indices; null`	`null`	Optional explicit local-explanation samples to show in the report. Strings are matched against dataset sample IDs and filename stems, so `ISIC_0024306.jpg` can match `ISIC_0024306`. Integers select zero-based batch indices. Invalid, ambiguous, duplicate, or out-of-range entries fail the run with a clear error. This affects report rendering only and does not subset the data sent through metrics, explainers, visualisers, or tracking.
`multirun_report`	`boolean`	`true`	Whether Hydra multiruns should create one merged parent report at the sweep directory level. Set to false to keep per-run reports only.
`show_original_per_explainer`	`boolean`	`false`	Whether local explanation figures should keep their per-explainer original input panels. The default compact layout groups local explanations by selected sample, renders one sample thumbnail when possible, and suppresses repeated originals when a visualiser supports attribution-only rendering.
`show_redundant_robustness_panels`	`boolean`	`false`	Whether empirical robustness report figures should keep duplicate clean-input and perturbation-map panels across visualisers. The default compact robustness layout renders one figure per selected report sample and keeps one canonical owner per facet in the report only; persisted robustness PNGs stay self-contained.
`include_config`	`boolean`	`true`	Whether to include configuration details in the report.
`include_metadata`	`boolean`	`true`	Whether to include metadata (timestamps, versions) in the report.
`call.formatting.max_image_width_pt`	`integer, null`	`null`	PDFReporter-only maximum layout width in PDF points for embedded raster figures. When null, the usable single-column width on A4 (after margins) is used.
`call.formatting.max_image_height_pt`	`integer, null`	`null`	PDFReporter-only maximum layout height in PDF points for embedded raster figures. When null, roughly 82% of the inner column height is used to leave room for headings.
`call.formatting.figures_max_pages`	`integer, null`	`null`	PDFReporter-only soft cap on how many pages embedded figure sections are allowed to need. When set to a positive integer, if a simple estimate exceeds it, width and height limits are scaled down so figures take less space per page.
`call.formatting.image_raster_multiplier`	`float, null`	`null (effective default 3.0)`	PDFReporter-only pixels per layout point when rasterizing figures (higher = sharper in viewers). If set, values below 1.0 are clamped to 1.0.
`call.formatting.image_raster_max_edge_px`	`integer, null`	`null (effective default 2400)`	PDFReporter-only maximum longest edge in pixels of the rasterized bitmap after scaling. If set, values below 400 are clamped to 400.

Examples¶

YAML

reporting:
  _target_: "HTMLReporter"
  filename: "experiment_report"
  sample_selection:
    - "ISIC_0024306.jpg"
    - "ISIC_0024372.jpg"
    - 4
  multirun_report: true
  show_original_per_explainer: false
  show_redundant_robustness_panels: false

Python

from raitap.reporting import html

reporting = html(
    filename="experiment_report",
    sample_selection=["ISIC_0024306.jpg", "ISIC_0024372.jpg", 4],
    multirun_report=True,
    show_original_per_explainer=False,
    show_redundant_robustness_panels=False,
)

CLI

uv run raitap reporting=pdf reporting.filename="my_report" reporting.multirun_report=false reporting.show_original_per_explainer=true reporting.show_redundant_robustness_panels=true reporting.call.formatting.figures_max_pages=12

pip

raitap reporting=pdf reporting.filename="my_report" reporting.multirun_report=false reporting.show_original_per_explainer=true reporting.show_redundant_robustness_panels=true reporting.call.formatting.figures_max_pages=12