1 reporting.config
reporting.config
Validated TOML recipe for immutable scientific reports.
Recipes select code-owned report sections and presentation settings. They do not contain Python import paths, callables, equations, Plotly traces, or Typst markup. Runtime sources and clients are injected when the builder is created.
1.1 Classes
| Name | Description |
|---|---|
| MeasurementReportSectionConfig | Freeze one diagnostic endpoint-preparation sensitivity audit. |
| MeasurementSourceConfig | Select one frozen endpoint-preparation sensitivity audit. |
| QhDiagnosticReportSectionConfig | Freeze complete QH cell accounting and original-label diagnostics. |
| QhDiagnosticSourceConfig | Select one frozen finite-horizon diagnostic assignment directory. |
| RecipeReportSectionConfig | Freeze one declared recipe pair and its complete attempt accounting. |
| RecipeSourceConfig | Select one frozen Oracle recipe-experiment plan. |
| ReportExportConfig | Static-asset and bundle publication settings. |
| ReportSourcesConfig | Optional source families available to configured report sections. |
| ReportThemeConfig | Shared Plotly styling for interactive preview and static export. |
| RolloutReportSectionConfig | Wrap canonical rollout report-v1 frames without changing reductions. |
| RolloutSourceConfig | Select immutable rollout stores for report sections. |
| S2RolloutReportSectionConfig | Materialize target-frame spherical evidence from immutable rollouts. |
| ScientificReportConfig | Build one immutable, provenance-closed scientific report snapshot. |
| ScorerStudyReportSectionConfig | Publish admitted scorer dispositions and paired development-scene results. |
| ScorerStudySourceConfig | Select externally authenticated first-model or continuing study evidence. |
| WandbReportSectionConfig | Materialize one exact W&B metric curve and dynamics summary. |
| WandbSourceConfig | Select exact W&B runs and history fields for report sections. |
1.1.1 MeasurementReportSectionConfig
reporting.config.MeasurementReportSectionConfig()Freeze one diagnostic endpoint-preparation sensitivity audit.
1.1.1.1 Attributes
| Name | Description |
|---|---|
| kind | Closed discriminator for Oracle-owned measurement evidence. |
| id | Stable section identifier used as the result-ID prefix. |
1.1.2 MeasurementSourceConfig
reporting.config.MeasurementSourceConfig()Select one frozen endpoint-preparation sensitivity audit.
1.1.2.1 Attributes
| Name | Description |
|---|---|
| summary_path | Path to the summary admitted by the Oracle-owned transactional reader. |
1.1.3 QhDiagnosticReportSectionConfig
reporting.config.QhDiagnosticReportSectionConfig()Freeze complete QH cell accounting and original-label diagnostics.
1.1.3.1 Attributes
| Name | Description |
|---|---|
| kind | Closed discriminator for Lightning-owned diagnostic evidence. |
| id | Stable section identifier used as the result-ID prefix. |
1.1.4 QhDiagnosticSourceConfig
reporting.config.QhDiagnosticSourceConfig()Select one frozen finite-horizon diagnostic assignment directory.
1.1.4.1 Attributes
| Name | Description |
|---|---|
| root | Directory admitted by the Lightning-owned diagnostic evidence reader. |
1.1.5 RecipeReportSectionConfig
reporting.config.RecipeReportSectionConfig()Freeze one declared recipe pair and its complete attempt accounting.
1.1.5.1 Attributes
| Name | Description |
|---|---|
| kind | Closed discriminator for Oracle-owned recipe evidence. |
| id | Stable section identifier used as the result-ID prefix. |
| baseline | Declared baseline profile in the Oracle plan. |
| challenger | Declared challenger profile compared with baseline. |
1.1.6 RecipeSourceConfig
reporting.config.RecipeSourceConfig()Select one frozen Oracle recipe-experiment plan.
1.1.6.1 Attributes
| Name | Description |
|---|---|
| plan_path | Path to the immutable plan consumed by the Oracle-owned typed reader. |
1.1.7 ReportExportConfig
reporting.config.ReportExportConfig()Static-asset and bundle publication settings.
1.1.7.1 Attributes
| Name | Description |
|---|---|
| width | Static figure width in pixels. |
| height | Static figure height in pixels. |
| scale | Static raster/vector renderer scale factor. |
| two_dimensional_format | Default static format for non-WebGL Plotly figures. |
| webgl_format | Static format for WebGL or 3D figures. |
1.1.8 ReportSourcesConfig
reporting.config.ReportSourcesConfig()Optional source families available to configured report sections.
1.1.8.1 Attributes
| Name | Description |
|---|---|
| rollout | Rollout-store selection, when rollout sections are configured. |
| wandb | W&B run selection, when W&B sections are configured. |
| recipe | Oracle recipe-experiment selection, when a recipe section is configured. |
| measurement | Oracle measurement audit selection, when a measurement section is configured. |
| scorer_study | Externally pinned scorer publication, preserving historical execution identities. |
| qh_diagnostic | Finite-horizon diagnostic assignment, when its section is configured. |
1.1.9 ReportThemeConfig
reporting.config.ReportThemeConfig()Shared Plotly styling for interactive preview and static export.
1.1.9.1 Attributes
| Name | Description |
|---|---|
| template | Plotly template name applied by code-owned figure builders. |
| font_family | Font family recorded in figures and renderer provenance. |
| colorway | Ordered, high-contrast categorical palette shared by report figures. |
| s2_surface_colorscale | Sequential Plotly scale for complete target-frame S2 cell counts. |
| s2_rollout_colorscale | Continuous Plotly scale for rollout-chain incidence heritage. |
1.1.10 RolloutReportSectionConfig
reporting.config.RolloutReportSectionConfig()Wrap canonical rollout report-v1 frames without changing reductions.
1.1.10.1 Attributes
| Name | Description |
|---|---|
| kind | Closed discriminator for the rollout report producer. |
| id | Stable section identifier used as the result-ID prefix. |
| include_tables | Canonical rollout report-v1 tables to materialize in the snapshot. |
| quantity_fact_key | Fact key promoted as the section’s named quantity. |
| quantity_symbol_id | Canonical symbol ID, or None only for an operational quantity. |
| figure_fact_keys | Fact keys shown by the section’s deterministic Plotly bar figure. |
| distribution_figures | Optional complete-population plots over canonical rollout report tables. |
1.1.11 RolloutSourceConfig
reporting.config.RolloutSourceConfig()Select immutable rollout stores for report sections.
1.1.11.1 Attributes
| Name | Description |
|---|---|
| store_paths | Rollout Zarr store paths, resolved by the rollout reader at build time. |
| sidecar_paths | Optional immutable JSON/JSONL sidecars admitted by rollout reporting. |
1.1.12 S2RolloutReportSectionConfig
reporting.config.S2RolloutReportSectionConfig()Materialize target-frame spherical evidence from immutable rollouts.
The section invokes the rollout-owned complete-population reducer once per selected store. It emits movement, optical-axis, and calibrated proxy- surface figures from the same canonical Plotly builder used by Streamlit. The bounded projection limit affects incidence overlays only; complete equal-solid-angle counts are never subsampled.
1.1.12.1 Attributes
| Name | Description |
|---|---|
| kind | Closed discriminator for target-frame spherical rollout evidence. |
| id | Stable section identifier used as the result-ID prefix. |
| analysis | Rollout-owned binning and bounded incidence-reservoir configuration. |
| channels | Ordered figure channels to freeze into the report snapshot. |
1.1.13 ScientificReportConfig
reporting.config.ScientificReportConfig()Build one immutable, provenance-closed scientific report snapshot.
The config is the durable recipe shared by CLI and Streamlit. Calling :meth:setup_target injects external clients and canonical-notation root; parsing or describing the config performs no W&B or rollout payload reads.
1.1.13.1 Attributes
| Name | Description |
|---|---|
| schema_version | Closed recipe schema version. |
| evidence_status | Scientific evidence class enforced by source and export gates. |
| sources | Existing evidence-store selections; credentials and clients are excluded. |
| sections | Closed, code-owned report products in author-selected order. |
| theme | Shared interactive/static Plotly presentation settings. |
| export | Static renderer settings recorded in the exported manifest. |
1.1.13.2 Methods
| Name | Description |
|---|---|
| setup_target | Construct a builder with late-bound external adapters. |
| bind_rollout_stores | Return a validated recipe bound to an explicit rollout population. |
| rollout_s2_section | Return one configured S2 section or fail before evidence acquisition. |
| validate_build_readiness | Fail before client construction when selected source selectors are incomplete. |
1.1.13.2.1 setup_target
reporting.config.ScientificReportConfig.setup_target(wandb_api=None, root=None)Construct a builder with late-bound external adapters.
1.1.13.2.2 bind_rollout_stores
reporting.config.ScientificReportConfig.bind_rollout_stores(
store_paths,
*,
sidecar_paths=(),
)Return a validated recipe bound to an explicit rollout population.
This immutable composition helper is shared by interactive previews and report automation. It replaces only the rollout source selection; section analysis, Plotly theme, evidence status, export policy, and any configured W&B source remain unchanged.
1.1.13.2.3 rollout_s2_section
reporting.config.ScientificReportConfig.rollout_s2_section(section_id)Return one configured S2 section or fail before evidence acquisition.
1.1.13.2.4 validate_build_readiness
reporting.config.ScientificReportConfig.validate_build_readiness(section_ids=())Fail before client construction when selected source selectors are incomplete.
1.1.14 ScorerStudyReportSectionConfig
reporting.config.ScorerStudyReportSectionConfig()Publish admitted scorer dispositions and paired development-scene results.
1.1.14.1 Attributes
| Name | Description |
|---|---|
| kind | Closed discriminator, separate from historical learning-cycle diagnostics. |
| id | Stable prefix for quantities, observations, interval tables and figures. |
| continuing_diagnostics | Opt into sparse training telemetry and moving-target horizon diagnostics. |
| continuing_cloud_diagnostics | Bind complete W&B diagnostic coordinates to retained QH execution receipts. |
1.1.15 ScorerStudySourceConfig
reporting.config.ScorerStudySourceConfig()Select externally authenticated first-model or continuing study evidence.
1.1.15.1 Attributes
| Name | Description |
|---|---|
| archive_root | Portable archive directory, resolved relative to the report root. |
| manifest_sha256 | Manifest digest pinned by independent publication provenance. |
| kind | Explicit scientific reader; formats are never guessed from directory names. |
| study_prefix | Canonical logical archive prefix containing the requested study. |
| base_prefix | Original Q1 population study required by continuing-QH admission. |
1.1.16 WandbReportSectionConfig
reporting.config.WandbReportSectionConfig()Materialize one exact W&B metric curve and dynamics summary.
1.1.16.1 Attributes
| Name | Description |
|---|---|
| kind | Closed discriminator for the W&B report producer. |
| id | Stable section identifier used as the result-ID prefix. |
| metric | Exact W&B history key plotted across selected runs. |
| symbol_id | Canonical symbol ID, or None when the metric is operational. |
| ema_alpha | Exponential-moving-average factor; zero disables the smoothed trace. |
| show_raw | Whether the canonical figure includes raw metric traces. |
| segment_fraction | Fraction used by the existing W&B early/mid/late dynamics reducer. |
1.1.17 WandbSourceConfig
reporting.config.WandbSourceConfig()Select exact W&B runs and history fields for report sections.
1.1.17.1 Attributes
| Name | Description |
|---|---|
| entity | W&B entity that owns every selected run. |
| project | W&B project that owns every selected run. |
| run_ids | Exact W&B run IDs; confirmatory reports prohibit dynamic filtering. |
| history_keys | History columns fetched for code-owned report products. |
| history_mode | Whether acquisition uses sampled history or exhaustive scan_history. |
| max_rows | Maximum sampled rows; ignored for complete history acquisition. |