OCDocker.CLI.workbench module¶
Workbench CLI commands for validating specs and planning commands.
- OCDocker.CLI.workbench.cmd_ablations(args)[source]¶
Build a read-only ablation comparison against a reference run.
- Parameters:
args (argparse.Namespace) – Parsed command-line arguments.
- Returns:
Process-style exit code.
- Return type:
int
- OCDocker.CLI.workbench.cmd_adopt(args)[source]¶
Write Workbench manifests for existing output directories.
- Parameters:
args (argparse.Namespace) – Parsed command-line arguments.
- Returns:
Process-style exit code.
- Return type:
int
- OCDocker.CLI.workbench.cmd_adopt_plan(args)[source]¶
Build a dry-run adoption plan for existing output directories.
- Parameters:
args (argparse.Namespace) – Parsed command-line arguments.
- Returns:
Process-style exit code.
- Return type:
int
- OCDocker.CLI.workbench.cmd_artifacts(args)[source]¶
Build a read-only cross-run artifact index.
- Parameters:
args (argparse.Namespace) – Parsed command-line arguments.
- Returns:
Process-style exit code.
- Return type:
int
- OCDocker.CLI.workbench.cmd_build(args)[source]¶
Build a Workbench run bundle without executing it.
- Parameters:
args (argparse.Namespace) – Parsed command-line arguments.
- Returns:
Process-style exit code.
- Return type:
int
- OCDocker.CLI.workbench.cmd_check(args)[source]¶
Build a read-only preflight report for a Workbench spec.
- Parameters:
args (argparse.Namespace) – Parsed command-line arguments.
- Returns:
Process-style exit code.
- Return type:
int
- OCDocker.CLI.workbench.cmd_compare(args)[source]¶
Build a read-only run comparison against a baseline result manifest.
- Parameters:
args (argparse.Namespace) – Parsed command-line arguments.
- Returns:
Process-style exit code.
- Return type:
int
- OCDocker.CLI.workbench.cmd_evidence(args)[source]¶
Build a read-only OCScore evidence index from adopted sources.
- Parameters:
args (argparse.Namespace) – Parsed command-line arguments.
- Returns:
Process-style exit code.
- Return type:
int
- OCDocker.CLI.workbench.cmd_export(args)[source]¶
Build a publishable export scaffold from a Workbench manifest.
- Parameters:
args (argparse.Namespace) – Parsed command-line arguments.
- Returns:
Process-style exit code.
- Return type:
int
- OCDocker.CLI.workbench.cmd_inventory(args)[source]¶
Build a read-only inventory for a Workbench root.
- Parameters:
args (argparse.Namespace) – Parsed command-line arguments.
- Returns:
Process-style exit code.
- Return type:
int
- OCDocker.CLI.workbench.cmd_launch_plan(args)[source]¶
Build a non-executing launch plan for a prepared Workbench run.
- Parameters:
args (argparse.Namespace) – Parsed command-line arguments.
- Returns:
Process-style exit code.
- Return type:
int
- OCDocker.CLI.workbench.cmd_leaderboard(args)[source]¶
Build a read-only metric leaderboard from result manifests.
- Parameters:
args (argparse.Namespace) – Parsed command-line arguments.
- Returns:
Process-style exit code.
- Return type:
int
- OCDocker.CLI.workbench.cmd_metrics_matrix(args)[source]¶
Build a read-only metric matrix from result manifests.
- Parameters:
args (argparse.Namespace) – Parsed command-line arguments.
- Returns:
Process-style exit code.
- Return type:
int
- OCDocker.CLI.workbench.cmd_pareto(args)[source]¶
Build a read-only Pareto front from result manifests.
- Parameters:
args (argparse.Namespace) – Parsed command-line arguments.
- Returns:
Process-style exit code.
- Return type:
int
- OCDocker.CLI.workbench.cmd_metrics_catalog(args)[source]¶
Build a read-only metric coverage catalog from result manifests.
- Parameters:
args (argparse.Namespace) – Parsed command-line arguments.
- Returns:
Process-style exit code.
- Return type:
int
- OCDocker.CLI.workbench.cmd_logs(args)[source]¶
Build a bounded read-only log preview for one Workbench run.
- Parameters:
args (argparse.Namespace) – Parsed command-line arguments.
- Returns:
Process-style exit code.
- Return type:
int
- OCDocker.CLI.workbench.cmd_overview(args)[source]¶
Build a read-only workspace overview for dashboard consumers.
- Parameters:
args (argparse.Namespace) – Parsed command-line arguments.
- Returns:
Process-style exit code.
- Return type:
int
- OCDocker.CLI.workbench.cmd_plan(args)[source]¶
Plan a command from a Workbench spec file without executing it.
- Parameters:
args (argparse.Namespace) – Parsed command-line arguments.
- Returns:
Process-style exit code.
- Return type:
int
- OCDocker.CLI.workbench.cmd_plot(args)[source]¶
Build a Plotly-compatible Workbench plot payload.
- Parameters:
args (argparse.Namespace) – Parsed command-line arguments.
- Returns:
Process-style exit code.
- Return type:
int
- OCDocker.CLI.workbench.cmd_report(args)[source]¶
Build a composed read-only analysis report for a workspace.
- Parameters:
args (argparse.Namespace) – Parsed command-line arguments.
- Returns:
Process-style exit code.
- Return type:
int
- OCDocker.CLI.workbench.cmd_results(args)[source]¶
Build a read-only result summary for a Workbench manifest.
- Parameters:
args (argparse.Namespace) – Parsed command-line arguments.
- Returns:
Process-style exit code.
- Return type:
int
- OCDocker.CLI.workbench.cmd_schema(args)[source]¶
Build JSON Schema payloads for Workbench models.
- Parameters:
args (argparse.Namespace) – Parsed command-line arguments.
- Returns:
Process-style exit code.
- Return type:
int
- OCDocker.CLI.workbench.cmd_serve(args)[source]¶
Serve the local Workbench API.
Inspection endpoints are read-only and unauthenticated. Job-execute endpoints (
/api/jobs*) require a bearer token; seeOCDocker.Workbench.Auth.resolve_workbench_job_token().- Parameters:
args (argparse.Namespace) – Parsed command-line arguments.
- Returns:
Process-style exit code.
- Return type:
int
- OCDocker.CLI.workbench.cmd_status(args)[source]¶
Build a read-only status report for one Workbench run.
- Parameters:
args (argparse.Namespace) – Parsed command-line arguments.
- Returns:
Process-style exit code.
- Return type:
int
- OCDocker.CLI.workbench.cmd_template(args)[source]¶
Build a starter Workbench spec template.
- Parameters:
args (argparse.Namespace) – Parsed command-line arguments.
- Returns:
Process-style exit code.
- Return type:
int
- OCDocker.CLI.workbench.cmd_validate(args)[source]¶
Validate a Workbench spec file.
- Parameters:
args (argparse.Namespace) – Parsed command-line arguments.
- Returns:
Process-style exit code.
- Return type:
int