Skip to content

docs: add ARCHITECTURE.md and sharpen README positioning for review#96

Merged
Gavin-Borges merged 1 commit into
mainfrom
docs/grant-review-architecture
Jun 30, 2026
Merged

docs: add ARCHITECTURE.md and sharpen README positioning for review#96
Gavin-Borges merged 1 commit into
mainfrom
docs/grant-review-architecture

Conversation

@Gavin-Borges

Copy link
Copy Markdown
Owner

Summary

Documentation pass to present the current v2.0 architecture accurately for an expert/grant review.

ARCHITECTURE.md (new, root)

Authoritative current-state reference (supersedes the stale course-era note in docs/architecture/):

  • Two-track model architecture, honestly gated: the validated RF/XGBoost production scorer (mode_31) vs the GINEConv + ESM-2 GNN research track, with the 5-gate promotion table and current v4 status (4 of 5 pass; AUC-PR >= 0.85 gate open).
  • Six-stage Snakemake pipeline, feature representation (21/30/31/33/50/166), data governance (quarantine, freeze mode, SHA-256 manifests), reproducibility, security/OpenSSF posture, and a repository map.
  • Notes that 3D structural GNN edges are in-development, not active in v2.3.

README.md

  • Positioning block: dry-lab pipeline, two-track design, HPV/EBV focus, links to ARCHITECTURE.md.
  • OpenSSF Passing/Silver/Gold tier table with the remaining second-maintainer gap.
  • Aligned stale GNN references (v2.1/t6 -> v2.3 GINEConv + ESM-2 t12, 480-dim).

Notes

  • Performance numbers kept at the committed v4 figures, consistent with the paper and claims register (v5 reconciliation is a separate gated milestone).
  • All authored text is ASCII (0 em-dashes); encoding rule respected.
  • Full local test suite green (1097 passed / 2 skipped); ruff/mypy/bandit clean on tracked code; pip-audit clean except the known/mitigated torch CVE.

Add a root ARCHITECTURE.md documenting the current v2.0 design: the
two-track model architecture (validated RF/XGBoost production scorer and
the gated GINEConv + ESM-2 GNN research track), the six-stage Snakemake
pipeline, feature representation, data governance, reproducibility, and
the OpenSSF posture. Supersedes the stale course-era architecture note.

README: add a positioning block (dry-lab pipeline, two-track design,
HPV/EBV focus), an OpenSSF Passing/Silver/Gold tier table with the
remaining second-maintainer gap, and align stale GNN references to the
v2.3 GINEConv + ESM-2 reality (4 of 5 promotion gates).

Signed-off-by: Gavin Borges <gavinmborges1104@gmail.com>
@Gavin-Borges
Gavin-Borges force-pushed the docs/grant-review-architecture branch from 83842ec to e997001 Compare June 30, 2026 00:14
@Gavin-Borges
Gavin-Borges merged commit dd64299 into main Jun 30, 2026
17 checks passed
@Gavin-Borges
Gavin-Borges deleted the docs/grant-review-architecture branch June 30, 2026 00:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant