54-Reproducibility Checklist Template v1.0 | Chapter 0 — Preface & User Guide

Home ／ Docs-Technical WhitePaper ／ 54-Reproducibility Checklist Template v1.0

Chapter 0 — Preface & User Guide

I. Purpose & Scope

• Define the criteria, composition, and acceptance rules of the Minimal Reproducible Bundle, covering environment lock, data snapshot & lineage, weights & parameters, freshness policy, scripts & commands, metrics & intervals, gate mapping, and release manifests.
• For path quantities (arrival time/phase), explicitly show gamma(ell) and the measure d ell in text; record delta_form ∈ {general, factored} on the data side. Parenthesize all expressions; publication requires p_dim = 1.0 with check_dim_report.json attached.

II. Reproducibility Criteria

• Artifact equivalence: files/directories listed in the manifest match provided checksum/signature.
• Metric equivalence: primary/secondary metrics with intervals match within tolerance (choose exactly one coverage mode: k/alpha/quantile).
• Process equivalence: a single run of reproduce.sh/Makefile in the controlled environment completes end-to-end and yields artifacts identical to the manifest.
• Dimensional closure: all computations consistent in units/targets (I70-dim_check passed, p_dim = 1.0).

III. Audience & Prerequisites

• Audience: R&D and evaluation engineers, platform/ops, compliance and audit teams.
• Prereqs: container/driver/framework and hardware ready; credentials to access data and weights configured; clock_state="locked", |ts_start − calib.timestamp| ≤ τ_calib.

IV. Bundle & Layout

• Root: PTN_EXPORT/.
• Required subdirs: model/, inference/, uq/, eval/, monitoring/, reports/, figs/, plus SIGNATURE.asc and report_manifest.yaml.
• All files provide sha256 checksums and are registered in the manifest.

V. Gates & Stops

• G1 Schema completeness | G2 Citation compliance (anchor coverage ≥ 90%) | G3 Path conventions (gamma/measure/delta_form present) | G4 Dimensional closure (p_dim = 1.0) | G5 Freshness | G6 Coverage consistency (k/alpha/quantile) | G7 Covariance consistency (Σ PD) | G8 Uniqueness & acyclicity.
• Trigger S1–S5 (dimension/freshness/path/covariance/citation) → reject acceptance; if needed tag [Restricted] and publish qualitative results only.

VI. Cross-References

• Dataset Card Template v1.0: Ch. 3/4/6/7/8/10/11/12 (Provenance/Schema/Splits/QC/UQ/API/Bench).
• Model Card Template v1.0: Ch. 6/7/8/10/11/12 (Training/UQ/Bench/Deployment/Performance/Monitoring).
• Error Budget Card Template v1.0: Ch. 5/6/8/9 (Covariance/Propagation/Intervals/Thresholds).
• Pipeline Card Template v1.0: Ch. 3/4/6/9/12 (DAG/Contracts/Stages/Gates/Release).
• Parameter Registration Card Template v1.0: Ch. 4/6/8/9/10/11 (Units/Freshness/Cov Groups/Interfaces).

VII. Deliverables & Manifests

• Index: repro_manifest.yaml (versions, dependencies, entry points, checksums, signatures).
• Environment lock: env_lock.json, container_spec.yaml.
• Data lineage: data_refs.yaml, split_manifest.json.
• Weights & params: weights_manifest.yaml, param_lock.yaml.
• Scripts: reproduce.sh, Makefile.
• Evaluation & scoring: bench_plan.yaml, scorecard.json, eval_report.md.
• UQ & error: model_uq.yaml, uq_summary.json, budget_breakdown.csv.
• Monitoring & rollback: monitoring_rules.yaml, rollback_fsm.yaml, alerts.jsonl.
• Reports: check_dim_report.json, validate_report.json, audit.jsonl.

VIII. Normative Path Forms

• Arrival (two equivalent):
  T_arr = ( 1 / c_ref ) * ( ( ∫ n_eff d ell ) )
  T_arr = ( ( ∫ ( n_eff / c_ref ) d ell ) )
• Phase accumulation:
  Phi = ( ( 2π / λ_ref ) * ( ∫ n_eff d ell ) )

Align in order time → path → phase before reproduction & verification; arrays satisfy len(gamma_ell)=len(d_ell)=len(n_eff)≥2; record delta_form on the data side.

IX. Execution Modes

• Local: bash reproduce.sh.
• Container: docker compose up / podman run (image/tag in container_spec.yaml).
• Cloud: provide Terraform/Helm manifests with minimal quotas.
• All modes must log input hashes, timestamps, and run summary to audit.jsonl.

X. Checklist

• repro_manifest.yaml and report_manifest.yaml ready; all artifacts have checksum/signature.
• Environment lock files generated and one-click start works; clock_state="locked", τ_calib compliant.
• Data snapshot & splits consistent; path block explicit gamma/measure/delta_form; I70-dim_check passed, p_dim = 1.0.
• Coverage mode unified across Data/Model/Error/Pipeline (k/alpha/quantile); Σ PD.
• reproduce.sh/Makefile reproduces experiments with equivalent curves, intervals, and scores; /validate passed G1–G8; non-compliances tagged [Restricted] and handled.