svgap 0.3.0a1__tar.gz

svgap-0.3.0a1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!) The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 SV-Gap contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

svgap-0.3.0a1/NOTICE

@@ -0,0 +1,5 @@
+SV-Gap
+Copyright 2026 Shraddha S and SV-Gap contributors
+
+This product is licensed under the Apache License, Version 2.0.
+External EDA tools and datasets are not included and retain their own licenses.

svgap-0.3.0a1/PKG-INFO

@@ -0,0 +1,265 @@
+Metadata-Version: 2.4
+Name: svgap
+Version: 0.3.0a1
+Summary: Production-readiness evaluation for AI-generated RTL
+Author-email: Shraddha Sridhar <shsridhar@nvidia.com>
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/shsridhar-beep/svgap
+Project-URL: Documentation, https://shsridhar-beep.github.io/svgap/
+Project-URL: Issues, https://github.com/shsridhar-beep/svgap/issues
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Provides-Extra: dev
+Requires-Dist: jsonschema<5,>=4.23; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs-material<10,>=9.6; extra == "docs"
+Dynamic: license-file
+
+# SV-Gap
+
+[![CI](https://github.com/shsridhar-beep/svgap/actions/workflows/ci.yml/badge.svg)](https://github.com/shsridhar-beep/svgap/actions/workflows/ci.yml)
+[![Documentation](https://github.com/shsridhar-beep/svgap/actions/workflows/docs.yml/badge.svg)](https://shsridhar-beep.github.io/svgap/)
+[![PyPI](https://img.shields.io/pypi/v/svgap.svg)](https://pypi.org/project/svgap/)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.21198938.svg)](https://doi.org/10.5281/zenodo.21198938)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](LICENSE)
+
+**Make the gap between “passes the benchmark” and “reviewable by a chip-design
+team” explicit.**
+
+SV-Gap is an open evaluation layer for AI-generated digital RTL. It preserves
+the functional result produced by a research workflow, adds declared clock and
+reset intent plus structural evidence, and reports which configured production
+questions are answered, failed, or still unknown.
+
+> Supply RTL and evaluation evidence. SV-Gap tells you what that evidence
+> establishes, what it contradicts, what remains unresolved, and what evidence
+> would reduce the uncertainty.
+
+SV-Gap begins with clock-domain crossing (CDC) and reset-domain crossing (RDC).
+It is early research software, not a replacement for commercial signoff.
+
+![SV-Gap turns an offline pass into an evidence profile](docs/assets/svgap-demo.svg)
+
+## Who this is for
+
+| You are… | Use SV-Gap to… | Opportunities to build |
+|---|---|---|
+| A frontier-model researcher | Test whether models produce evidence-complete RTL, diagnose missing evidence, and repair structural findings without regression | Model baselines, agent policies, diagnosis methods, repair methods |
+| An RTL benchmark maintainer | Learn whether tasks carry enough clock/reset intent to evaluate production-oriented properties | Benchmark adapters, intent-bearing contracts, result submissions |
+| A chip-design AI builder | Add a structural evidence gate after generation and functional testing | Pipeline integrations, CI adapters, evidence dashboards |
+| An RTL or verification engineer | Make the reason a functionally passing candidate is blocked explicit | Minimal counterexamples, disputed findings, independent evidence |
+| An EDA researcher or tool author | Compare structural backends under a shared evidence contract | Open checker backends, differential studies, digital RTL taskpacks |
+| An evaluation researcher | Study when offline success does not identify deployment validity | Abstention semantics, construct-validity studies, cross-domain methods |
+
+## See the gap in two minutes
+
+Install Python 3.11+, Yosys, and Icarus Verilog. On macOS:
+
+```bash
+brew install yosys icarus-verilog
+python3 -m venv .venv
+.venv/bin/python -m pip install svgap==0.3.0a1
+.venv/bin/svgap demo
+```
+
+The demo produces one functional result and two different structural outcomes:
+
+```text
+candidate  functional  structural  findings
+safe       pass        pass        none
+unsafe     pass        fail        REF-RDC-001
+```
+
+Both implementations satisfy the supplied functional test. Declared
+reset-release intent separates them structurally. Preserve the complete
+reproducer with `svgap demo --output demo-output`.
+
+The same workflow is available in the open-tool container after the v0.3
+release:
+
+```bash
+docker run --rm ghcr.io/shsridhar-beep/svgap:v0.3.0-alpha.1 demo
+```
+
+## Use SV-Gap on your own RTL
+
+```bash
+svgap init path/to/design.sv \
+  --top top \
+  --candidate-id experiment-001 \
+  --output path/to/manifest.toml
+
+svgap validate path/to/manifest.toml
+svgap check path/to/manifest.toml
+svgap explain path/to/build/report.json
+```
+
+`init` deliberately does not guess intent. `validate` exposes missing functional,
+clock, reset, and relationship evidence before execution. `explain` translates
+the resulting report into answered, failed, and unanswered questions.
+
+Follow the complete [bring-your-own-RTL tutorial](docs/bring-your-own-rtl.md),
+including an executable manifest and imported-result path.
+
+## Research with SV-Gap
+
+### Generation
+
+Ask whether a model can produce RTL with passing and determinate functional and
+structural evidence—not merely code that passes a testbench.
+
+### Diagnosis
+
+Ask whether a model distinguishes evidence that establishes a property,
+evidence that contradicts it, and a question that remains unresolved.
+
+### Repair
+
+Ask whether a model removes a structural finding while preserving functional
+acceptance, checker coverage, candidate identity, and freedom from new rule
+regressions.
+
+The public [`challenges/v0.1`](challenges/v0.1/) contract defines all three
+tracks. Profiles remain multidimensional rather than hiding failure modes in a
+single score. See the [baseline registry](results/README.md) to reproduce or
+submit a result.
+
+## Current evidence
+
+- Four controlled safe/unsafe CDC/RDC witness pairs pass the same functional
+  tests and are separated by declared structural rules.
+- A frozen 72-call reset-release study contains 57 functional passes; at least
+  14 contain the declared raw-reset pattern.
+- A heuristic inventory covers 508 public RTL-generation tasks across
+  VerilogEval, RTLLM, and CVDP.
+- A small exploratory frontier-model baseline exposes a crossed failure mode:
+  one configuration preserves epistemic uncertainty but misses the repair;
+  another repairs the configured finding but overstates what the diagnosis
+  evidence establishes.
+
+These are an executable existence result, a taskpack-conditional demonstration,
+and a heuristic inventory. They are not a population defect estimate or a model
+ranking.
+
+[Controlled result](docs/controlled-result.md) ·
+[Reset result](docs/reset-replication-result.md) ·
+[Benchmark audit](docs/benchmark-audit.md) ·
+[Compact research note](docs/compact-research-note.md)
+
+## Build with us
+
+SV-Gap is shared research infrastructure. You do not need to agree with the
+reference checker to contribute.
+
+### Add a taskpack
+
+Create public digital RTL tasks with explicit clock/reset intent, executable
+functional evidence, and calibrated references.
+
+### Add a checker backend
+
+Implement one operation:
+
+```python
+check(manifest) -> CheckResult
+```
+
+Backends preserve `pass`, `fail`, `unknown`, and `tool_error`. Missing intent or
+unsupported syntax must never become a pass. See the
+[backend SDK](docs/backend-sdk.md).
+
+### Add a benchmark adapter
+
+Import an existing benchmark’s functional result while binding it
+cryptographically to the evaluated RTL.
+
+### Contribute model evidence
+
+Submit generation, diagnosis, or repair results using the public registry
+contract. Negative results, abstentions, and disagreements are welcome.
+
+### Challenge the oracle
+
+Contribute a minimal false positive, false negative, competing backend result,
+or expert adjudication. Disagreement is evidence, not a project failure.
+
+[Good first issues](https://github.com/shsridhar-beep/svgap/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) ·
+[Contribution guide](CONTRIBUTING.md) ·
+[Discussions](https://github.com/shsridhar-beep/svgap/discussions) ·
+[Roadmap](ROADMAP.md)
+
+## High-value open research problems
+
+1. Which production-oriented properties are absent from current RTL benchmarks?
+2. Can models recognize missing intent instead of inventing it?
+3. Does structural feedback improve repair without creating functional regressions?
+4. How stable are results across independent open checker backends?
+5. What evidence package makes generated RTL reviewable downstream?
+6. How should multidimensional evidence be compared without hiding unknown states?
+
+## Scope and limitations
+
+SV-Gap covers digital RTL and digital verification. See the explicit
+[scope boundary](docs/scope-boundary.md).
+
+The built-in Yosys backend is deliberately narrow and is not signoff-grade. A
+structural pass means only that the configured backend emitted no failing
+finding within its declared coverage. It is not proof of silicon safety.
+
+The generic trace-adjudication scaffold uses prerecorded fixtures. The real
+reset-release perturbation instrumenter remains unimplemented pending patent
+and employer review.
+
+See [methodology](docs/methodology.md), [architecture](docs/architecture.md), and
+[limitations](docs/limitations.md) before interpreting claim-bearing results.
+
+## Install and integrate
+
+### From PyPI
+
+```bash
+python3 -m pip install svgap==0.3.0a1
+svgap doctor
+```
+
+### From source
+
+```bash
+git clone https://github.com/shsridhar-beep/svgap
+cd svgap
+python3 -m venv .venv
+.venv/bin/python -m pip install -e .
+.venv/bin/svgap doctor
+```
+
+### GitHub Actions
+
+Use the reusable action in [`.github/actions/svgap`](.github/actions/svgap) to
+attach normalized structural evidence to an existing RTL pipeline.
+
+### Requirements
+
+- Python 3.11–3.13
+- Yosys and Icarus Verilog for the built-in backend
+- Only open-source tools are assumed by default
+
+## Community and citation
+
+Ask integration questions and propose research directions in
+[GitHub Discussions](https://github.com/shsridhar-beep/svgap/discussions). Use
+the issue templates for reproducible bugs, taskpacks, backends, and false
+results. See [GOVERNANCE.md](GOVERNANCE.md), [SECURITY.md](SECURITY.md), and
+[SUPPORT.md](SUPPORT.md).
+
+Cite the exact archived version used. The
+[v0.2.0-alpha.1 DOI](https://doi.org/10.5281/zenodo.21198939) identifies the
+current archived research release; the
+[concept DOI](https://doi.org/10.5281/zenodo.21198938) resolves to the latest
+GitHub-integrated version.
+
+Apache-2.0. External tools and imported datasets retain their own licenses.