Skip to content

Report Rendering API Reference

The kreview.report module is the CLI-facing entry point for rendering: it locates a pipeline output directory, delegates to the data layer, and writes the page plus its manifest. A partial report is always loud — evaluators that appear in the scoreboard but lack model results are recorded in missing_detail rather than quietly omitted.

For conceptual explanations, see:


kreview.report

generate_report(outdir, output_dir, *, run_label='', trace_path=None)

Render the single-page evaluation report from a pipeline output directory.

Thin library wrapper over :func:kreview.report_data.render_report for API users; the CLI equivalent is kreview report. Returns the path of the written HTML, or None (with an error log) when the output directory does not look like a pipeline outdir — the guard mirrors the CLI's fail-loud behaviour without raising through library callers.