phase31_external_correctness_validation.py

Go to the documentation of this file.

#!/usr/bin/env python3
"""Stage-A Phase 3.1 external slice (five Aer rows: four microcases + q4 continuity).

Run with:
    python benchmarks/density_matrix/correctness_evidence/phase31_external_correctness_validation.py
"""

from __future__ import annotations

from benchmarks.density_matrix.correctness_evidence.case_selection import (
    CORRECTNESS_EVIDENCE_CASE_KIND_CONTINUITY,
    CORRECTNESS_EVIDENCE_CASE_KIND_MICROCASE,
)
from benchmarks.density_matrix.correctness_evidence.common import (
    CORRECTNESS_EVIDENCE_PHASE31_CASE_SCHEMA_VERSION,
    phase31_correctness_evidence_output_dir,
)
from benchmarks.density_matrix.correctness_evidence.records import (
    build_phase31_correctness_evidence_positive_records,
)
from benchmarks.density_matrix.correctness_evidence.validation_support import (
    assemble_positive_case_bundle,
)
from benchmarks.density_matrix.validation_scaffold import (
    require_bundle_fields,
    run_case_slice_cli,
)

SUITE_NAME = "correctness_evidence_phase31_external_correctness"
ARTIFACT_FILENAME = "phase31_external_correctness_bundle.json"
DEFAULT_OUTPUT_DIR = phase31_correctness_evidence_output_dir("external_correctness")
ARTIFACT_CORE_FIELDS = (
    "suite_name",
    "status",
    "record_schema_version",
    "software",
    "selected_candidate",
    "summary",
    "cases",
)


def build_cases() -> list[dict]:
    return [
        case
        for case in build_phase31_correctness_evidence_positive_records()
        if case["external_reference_required"]
    ]


def build_artifact_bundle(cases: list[dict]) -> dict:
    external_passes = sum(case["external_reference_pass"] for case in cases)
    microcases = sum(case["case_kind"] == CORRECTNESS_EVIDENCE_CASE_KIND_MICROCASE for case in cases)
    continuity_cases = sum(
        case["case_kind"] == CORRECTNESS_EVIDENCE_CASE_KIND_CONTINUITY for case in cases
    )
    status = (
        "pass"
        if len(cases) == 5
        and external_passes == len(cases)
        and microcases == 4
        and continuity_cases == 1
        else "fail"
    )
    summary = {
        "package_kind": "phase31_stage_a_bounded",
        "total_cases": len(cases),
        "external_reference_passes": external_passes,
        "microcases": microcases,
        "continuity_cases": continuity_cases,
    }
    bundle = assemble_positive_case_bundle(
        SUITE_NAME,
        status,
        summary,
        cases,
        record_schema_version=CORRECTNESS_EVIDENCE_PHASE31_CASE_SCHEMA_VERSION,
    )
    require_bundle_fields(bundle, ARTIFACT_CORE_FIELDS, "Phase 3.1 external correctness bundle")
    return bundle


def main(argv: list[str] | None = None) -> int:
    return run_case_slice_cli(
        argv,
        build_cases=build_cases,
        build_artifact_bundle=build_artifact_bundle,
        artifact_filename=ARTIFACT_FILENAME,
        default_output_dir=DEFAULT_OUTPUT_DIR,
        description=__doc__ or "",
        output_dir_help="Directory to write the Phase 3.1 external correctness bundle into.",
        quiet_report=lambda b: print(
            "external_reference_passes={external_reference_passes}, total_cases={total_cases}".format(
                **b["summary"]
            )
        ),
    )


if __name__ == "__main__":
    raise SystemExit(main())