Configuration¶

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

Options¶

Name	Allowed	Default	Description
`_target_`	`"PDFReporter", null`	`null`	Hydra target for the reporting backend implementation. Set to null to disable reporting.
`filename`	`string`	`"report.pdf"`	Name of the generated PDF report file.
`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.
`formatting.max_image_width_pt`	`integer, null`	`null`	Maximum layout width in PDF points for embedded raster figures (e.g. PNGs). When null, the usable single-column width on A4 (after margins) is used.
`formatting.max_image_height_pt`	`integer, null`	`null`	Maximum layout height in PDF points for embedded raster figures (e.g. PNGs). When null, roughly 82% of the inner column height is used to leave room for headings.
`formatting.figures_max_pages`	`integer, null`	`null`	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.
`formatting.image_raster_multiplier`	`float, null`	`null (effective default 3.0)`	Pixels per layout point when rasterizing figures for borb (higher = sharper in viewers). If set, values below 1.0 are clamped to 1.0.
`formatting.image_raster_max_edge_px`	`integer, null`	`null (effective default 2400)`	Maximum longest edge in pixels of the rasterized bitmap after scaling. If set, values below 400 are clamped to 400.

reporting:
  _target_: "PDFReporter"
  filename: "experiment_report.pdf"
  formatting:
    figures_max_pages: 10

uv run raitap reporting=pdf reporting.filename="my_report.pdf" reporting.formatting.figures_max_pages=10

pip

raitap reporting=pdf reporting.filename="my_report.pdf" reporting.formatting.figures_max_pages=10