Venn

Release checklist#

The repository remains private; the published model head is separate. Keep deployment and package publishing disabled until launch.

Prepared#

  • [x] Owner confirmed the published venn-1 head can be redistributed; the model card and license page record that permission.
  • [x] Refresh the published Hugging Face bundle and pin its immutable revision in the runtime, model card and reproduction guide.
  • [x] Attach the latest landscape and vertical comparison videos to the private media-v1 release. Posters, captions and manifests accompany the source.
  • [x] Embed the comparison video on the project page and comparison guide.
  • [x] Set the planned repository homepage to https://markrussinovich.github.io/venn-vdm/.
  • [x] Keep DEPLOY_PAGES=false and PUBLISH_PYPI=false; workflows also check repository visibility before publishing.
  • [x] Prepare publish.yml for PyPI Trusted Publishing and document its account setup in the PyPI guide.
  • [x] Exclude local MP4s, model files, caches and downloaded ticket data from the source distribution.

Before changing visibility#

  • [ ] Finish the reviewed source snapshot and pass CI on that exact revision.
  • [ ] Build fresh distributions and pass the base-dependency wheel smoke test outside the source checkout. Do not reuse older files from dist/.
  • [ ] Squash/reset to the intended clean public history, as planned by the owner. Inspect branches, tags and retained PR refs after that operation. A force push alone does not purge objects retained by GitHub; resolve any remaining private history before making the repository public.
  • [ ] Review which maintainer notes, artifacts and release assets should ship. Keep private launch planning in the separate research workspace.
  • [ ] Confirm the distribution/import naming decision: venn-vdm / venn.
  • [ ] Complete the remaining checks in the private publish-todo.md.

At public launch#

  • [ ] Make the prepared head public and verify anonymous access to its pinned revision if not already public.
  • [ ] Make the cleared GitHub repository public.
  • [ ] Enable Pages using GitHub Actions, set DEPLOY_PAGES=true and dispatch the documentation workflow. The current account plan rejects Pages for this repository while it is private; has_pages reflects actual configuration.
  • [ ] Verify the live homepage, guide, videos, captions, downloads and first decision without owner credentials. See website setup.
  • [ ] Tag the verified version and optionally enable PyPI publishing after configuring its Trusted Publisher. See PyPI setup.
  • [ ] Configure branch protections, private vulnerability reporting and protected PyPI environment deployments before enabling publication.

Follow-up improvements#

  • [ ] Headless HTTP mode for outcome-only serving.
  • [ ] Better no-match behavior and task-specific thresholds.
  • [ ] A quantized reader backend and broader generic-head reader selection.
  • [ ] A matched comparison with selected OSS decision models.

View this page on GitHub

On this page