OCDocker.Workbench.Comparison module

Read-only run comparison helpers for Workbench result manifests.

OCDocker.Workbench.Comparison.build_run_comparison(root, *, baseline_run_id, candidates=None, metrics=None, max_depth=6)[source]

Compare result manifests against a selected baseline run.

Parameters:
  • root (str or pathlib.Path) – Workspace root or result manifest file to scan.

  • baseline_run_id (str) – Run id used as comparison baseline.

  • candidates (tuple[str, ...] or list[str] or None) – Optional candidate run ids. If omitted, every non-baseline run is compared.

  • metrics (tuple[ParetoObjective, ...] or list[ParetoObjective] or None) – Optional comparison metrics. If omitted, numeric metrics are inferred.

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

Returns:

Read-only comparison payload for GUI, CLI, and automation consumers.

Return type:

WorkbenchComparison

OCDocker.Workbench.Comparison.parse_comparison_metric(value)[source]

Parse a comparison metric specification.

Parameters:

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

Returns:

Parsed metric objective.

Return type:

ParetoObjective