continuity_descriptor_validation.py

Go to the documentation of this file.

#!/usr/bin/env python3
"""Continuity partition-descriptor validation.

Builds the required 4, 6, 8, and 10 qubit Phase 2 continuity-anchor workloads
and verifies that each one emits a conforming partition-descriptor set through
the continuity entry route.

Run with:
    python benchmarks/density_matrix/planner_surface/continuity_descriptor_validation.py
"""

from __future__ import annotations

import argparse
import json
import sys
from pathlib import Path

REPO_ROOT = Path(__file__).resolve().parents[3]
if str(REPO_ROOT) not in sys.path:
    sys.path.insert(0, str(REPO_ROOT))

from benchmarks.density_matrix.planner_surface.common import (
    build_case_metadata,
    build_phase2_continuity_vqe,
    build_software_metadata,
)
from squander.partitioning.noisy_planner import (
    DEFAULT_PARTITION_DESCRIPTOR_MAX_QUBITS,
    build_phase3_continuity_partition_descriptor_set,
)

SUITE_NAME = "phase3_planner_surface_continuity_descriptors"
ARTIFACT_FILENAME = "continuity_descriptor_bundle.json"
DEFAULT_OUTPUT_DIR = (
    REPO_ROOT
    / "benchmarks"
    / "density_matrix"
    / "artifacts"
    / "planner_surface"
    / "continuity_descriptor"
)
REQUIRED_QUBITS = (4, 6, 8, 10)
ARTIFACT_CORE_FIELDS = (
    "suite_name",
    "status",
    "requested_mode",
    "software",
    "summary",
    "cases",
)


def build_case_result(qbit_num: int) -> dict:
    vqe, _, topology = build_phase2_continuity_vqe(qbit_num)
    descriptor_set = build_phase3_continuity_partition_descriptor_set(vqe)
    payload = descriptor_set.to_dict()

    case = build_case_metadata(
        qbit_num=qbit_num,
        topology=topology,
        density_noise=[dict(item) for item in vqe.density_noise],
    )
    case.update(
        {
            "case_name": f"phase2_xxz_hea_q{qbit_num}_continuity",
            "case_kind": "phase3_planner_surface_continuity_descriptors",
            "status": "pass",
            "requested_mode": payload["requested_mode"],
            "source_type": payload["source_type"],
            "workload_id": payload["workload_id"],
            "parameter_count": payload["parameter_count"],
            "partition_count": payload["partition_count"],
            "descriptor_member_count": payload["descriptor_member_count"],
            "gate_count": payload["gate_count"],
            "noise_count": payload["noise_count"],
            "max_partition_qubits": payload["max_partition_qubits"],
            "max_partition_span": payload["max_partition_span"],
            "partition_member_counts": payload["partition_member_counts"],
            "continuity_descriptor_pass": (
                payload["partition_count"] > 0
                and payload["descriptor_member_count"]
                == payload["gate_count"] + payload["noise_count"]
                and payload["max_partition_qubits"]
                == DEFAULT_PARTITION_DESCRIPTOR_MAX_QUBITS
            ),
            "descriptor_partitions": payload["partitions"],
        }
    )
    return case


def build_artifact_bundle(cases: list[dict]) -> dict:
    passed_cases = sum(case["status"] == "pass" for case in cases)
    descriptor_passes = sum(case["continuity_descriptor_pass"] for case in cases)
    bundle = {
        "suite_name": SUITE_NAME,
        "status": "pass"
        if passed_cases == len(cases) and descriptor_passes == len(cases)
        else "fail",
        "requested_mode": "partitioned_density",
        "software": build_software_metadata(),
        "summary": {
            "total_cases": len(cases),
            "passed_cases": passed_cases,
            "continuity_descriptor_passes": descriptor_passes,
            "required_qubits": list(REQUIRED_QUBITS),
            "required_pass_rate": 1.0,
            "actual_pass_rate": passed_cases / len(cases) if cases else 0.0,
        },
        "cases": cases,
    }
    missing = [field for field in ARTIFACT_CORE_FIELDS if field not in bundle]
    if missing:
        raise ValueError(
            "Continuity descriptor bundle missing required fields: {}".format(
                ", ".join(missing)
            )
        )
    return bundle


def write_artifact_bundle(bundle: dict, output_dir: Path = DEFAULT_OUTPUT_DIR) -> Path:
    output_dir.mkdir(parents=True, exist_ok=True)
    output_path = output_dir / ARTIFACT_FILENAME
    output_path.write_text(json.dumps(bundle, indent=2, sort_keys=True) + "\n")
    return output_path


def run_validation(verbose: bool = True) -> list[dict]:
    results = [build_case_result(qbit_num) for qbit_num in REQUIRED_QUBITS]
    if verbose:
        print("Continuity partition descriptors:")
        for case in results:
            print(
                "  q={qbit_num}: partitions={partition_count}, members={descriptor_member_count}, span={max_partition_span}, continuity_pass={continuity_descriptor_pass}".format(
                    **case
                )
            )
    return results


def main(argv: list[str] | None = None) -> int:
    parser = argparse.ArgumentParser(description=__doc__)
    parser.add_argument(
        "--output-dir",
        type=Path,
        default=DEFAULT_OUTPUT_DIR,
        help="Directory to write the continuity descriptor bundle into.",
    )
    parser.add_argument(
        "--quiet",
        action="store_true",
        help="Suppress per-case console output.",
    )
    args = parser.parse_args(argv)

    results = run_validation(verbose=not args.quiet)
    bundle = build_artifact_bundle(results)
    output_path = write_artifact_bundle(bundle, output_dir=args.output_dir)

    if not args.quiet:
        print("Wrote {}".format(output_path))

    return 0 if bundle["status"] == "pass" else 1


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