Reference¶
This section defines the supported user commands, versioned inputs, and durable result contracts. Use it when exact names, paths, or compatibility rules matter. Tutorials and model interpretation remain in the workflow and engineering-model sections.
Current Contract Versions¶
| Surface | Version |
|---|---|
| Core input | runspec_v8 |
| Campaign request | campaign_plan_request_v1 |
| Campaign result | campaign_plan_result_v5 |
| Core run manifest | run_manifest_v2 |
| Core metrics summary | metrics_summary_v3 |
| Core environment summary | environment_summary_v2 |
| Batch manifest, plan, attempts, results, summary | *_v1 |
| Sweep plan and attempts | *_v1 |
| Sweep results and summary | *_v2 |
The schema version is part of the artifact. Do not infer compatibility from a filename alone, and do not remove or edit a schema version to make an older artifact appear current.
Reference Map¶
| Page | Use it for |
|---|---|
| CLI Reference | Supported installed commands, flags, and default paths |
| RunSpec Reference | runspec_v8 structure and composition rules |
| Campaign Request Reference | Deployment-campaign input contract |
| Artifact Contract | Core, sweep, batch, state-timeline, and filesystem contracts |
| Campaign Result Contract | Campaign outcome, summary, and optional mission-bundle contract |
| Product Boundaries And Support | Platforms, known limits, compatibility and upgrade policy, licensing, and support evidence |
Scientific Validation defines which model claims have independent or published evidence. Schema validation establishes structural acceptability; scientific applicability depends on the documented claim envelope and the intended study.
Contract Rules¶
- YAML and JSON authoring inputs resolve to canonical JSON inside the result bundle.
- Required files and schema versions are stable review boundaries; optional artifact families depend on the executed stages and requested detail.
- Paths stored inside grouped bundles are relative to the bundle and use forward slashes.
- A result should be reviewed with the product version and canonical input recorded in its manifest.
- CLI, RunSpec, campaign request, and documented artifacts are product contracts. Direct Python imports are implementation details unless a page explicitly states otherwise.
- Additional subcommands visible in raw
--helpoutput may be internal or transitional. The supported user command set is the one documented in the CLI Reference.
Use the closest bundled example as the authoring baseline, then validate it with the installed CLI.