Skip to content

Prepare the repository for going public - #1

Merged
smishra3 merged 6 commits into
mainfrom
chore/public-release-prep
Nov 8, 2026
Merged

smishra3 merged 6 commits into
mainfrom
chore/public-release-prep

Conversation

@smishra3

@smishra3 smishra3 commented Nov 8, 2026

Copy link
Copy Markdown
Collaborator

What changed

  • Benchmarks section in the README (fresh-install time, GPU/CPU timing, memory, dice on three variance images) and the scripts behind it in tools/benchmark/.
  • ruff formatting and linting (pycodestyle, pyflakes, isort, pyupgrade, bugbear) applied once; config in pyproject.toml. No behaviour change.
  • Quickstart notebook stripped of outputs (1.3 MB to a few kB).
  • Community files: CONTRIBUTING.md, CODE_OF_CONDUCT.md (Contributor Covenant 2.1), SECURITY.md, CITATION.cff, CHANGELOG.md.
  • Templates: three issue forms (bug, segmentation looks wrong, feature), blank issues off, questions routed to Discussions; PR template.
  • pre-commit: ruff, nbstripout, 500 kB large-file guard.
  • CI: lint job, all checks passed aggregate job (the one required by branch protection), weekly scheduled run, on-demand notebook execution job.
  • README: CI and license badges, link to CONTRIBUTING.

Why

Make the repo presentable and set the working rules before it goes public. Details of the rules are in CONTRIBUTING.md.

How it was tested

  • pytest: 10/10 on Linux (A100 node) after the formatting commit.
  • uvx pre-commit run --all-files passes.
  • CI on this PR exercises the new lint and aggregate jobs.

Before merging

Two RELEASE TODO markers need a monitored contact address: SECURITY.md and CODE_OF_CONDUCT.md. CITATION.cff needs the author list and paper DOI when available.

🤖 Generated with Claude Code

smishra3 and others added 6 commits November 8, 2026 17:22
Fresh-install time, GPU and CPU timing, peak GPU memory and dice against
SEG_STRUCT for three public variance images, measured on an A100 node.
tools/benchmark/ holds the timing runner and the ground-truth comparison.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Adds a [tool.ruff] section (pycodestyle, pyflakes, isort, pyupgrade,
bugbear; line length 100) and applies ruff format and the autofixes.
No behaviour change.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
The embedded figures made the notebook 1.3 MB and every re-run a large
diff. Outputs are regenerated when the notebook runs; nbstripout in
pre-commit keeps them out from now on.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
- CONTRIBUTING.md: dev setup, branch/commit/PR rules, release process
- CODE_OF_CONDUCT.md (Contributor Covenant 2.1), SECURITY.md, CITATION.cff,
  CHANGELOG.md
- Issue templates (bug, segmentation quality, feature) with blank issues
  off and questions routed to Discussions; PR template
- pre-commit: ruff, nbstripout, large-file guard
- CI: lint job, aggregate 'all checks passed' job for branch protection,
  weekly scheduled run, on-demand notebook execution job
- README: CI and license badges, link to CONTRIBUTING

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@smishra3
smishra3 merged commit 1db8709 into main Nov 8, 2026
7 checks passed
@smishra3
smishra3 deleted the chore/public-release-prep branch November 8, 2026 17:41
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