OCDocker.Workbench.Report module

Composed Workbench analysis reports for GUI and publication workflows.

OCDocker.Workbench.Report.build_analysis_report(root, *, leaderboards=(), pareto_objectives=(), max_depth=6, recent_limit=20, top_n=5)[source]

Build a composed read-only analysis report from Workbench manifests.

Parameters:

  • root (str or pathlib.Path) – Workspace root or manifest file to inspect.

  • leaderboards (tuple[ParetoObjective, ...]) – Metric selections used to build leaderboards. When empty, numeric metrics are inferred.

  • pareto_objectives (tuple[ParetoObjective, ...]) – Optional objectives used to build a Pareto front.

  • max_depth (int) – Maximum directory depth below root to scan.

  • recent_limit (int) – Maximum recent runs included in the overview.

  • top_n (int) – Maximum entries surfaced in repeated report sections.

Returns:

Composed analysis report.

Return type:

WorkbenchAnalysisReport

OCDocker.Workbench.Report.parse_report_metric(value)[source]

Parse a report metric selection.

Parameters:

value (str) – Metric selection in metric or metric:min|max form.

Returns:

Parsed metric selection.

Return type:

ParetoObjective

OCDocker.Workbench.Report.render_analysis_report_markdown(report)[source]

Render a Workbench analysis report as Markdown.

Parameters:

report (WorkbenchAnalysisReport) – Analysis report.

Returns:

Markdown report text.

Return type:

str