OCDocker.Workbench.Plots module

Plot-ready Workbench payloads for GUI and notebook integrations.

OCDocker.Workbench.Plots.build_leaderboard_plot(root, *, metric_name, mode='max', max_depth=6, top_n=20)[source]

Build a Plotly-compatible bar plot from a metric leaderboard.

Parameters:

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

  • metric_name (str) – Metric name or dotted metric path to rank.

  • mode (MetricSortMode) – Ranking mode, either max or min.

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

  • top_n (int) – Maximum ranked entries to include in the plotted trace.

Returns:

Plot-ready leaderboard bar payload.

Return type:

WorkbenchPlot

OCDocker.Workbench.Plots.build_metric_scatter_plot(root, *, x_metric, y_metric, color_metric=None, max_depth=6)[source]

Build a Plotly-compatible metric scatter plot from result manifests.

Parameters:

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

  • x_metric (str) – Metric plotted on the x axis.

  • y_metric (str) – Metric plotted on the y axis.

  • color_metric (str or None) – Optional numeric metric used for marker color.

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

Returns:

Plot-ready scatter payload.

Return type:

WorkbenchPlot

OCDocker.Workbench.Plots.build_parallel_coordinates_plot(root, *, metric_names, max_depth=6)[source]

Build a Plotly-compatible parallel-coordinate metric plot.

Parameters:

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

  • metric_names (tuple[str, ...] or list[str]) – Metrics used as parallel-coordinate dimensions.

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

Returns:

Plot-ready parallel-coordinate payload.

Return type:

WorkbenchPlot

OCDocker.Workbench.Plots.build_pareto_scatter_plot(root, *, objectives, max_depth=6)[source]

Build a Plotly-compatible two-objective Pareto scatter plot.

Parameters:

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

  • objectives (tuple[ParetoObjective, ...]) – Exactly two Pareto objectives.

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

Returns:

Plot-ready Pareto scatter payload.

Return type:

WorkbenchPlot