docs: condense AGENTS.md and refresh AUDIT.md to current state - #11
Merged
Conversation
- AGENTS.md (303 -> 93 lines): a shorter, more general guide. Keeps the load-bearing parts -- the three design pillars, the extension model (subclass + classpath), the do-not-break invariants, and the coding/commit/ agent conventions -- and drops the verbose config-key catalogues, per-subsystem deep-dives, env-var/optional-dep tables, and the end-to-end run trace, which belong in docs/ and examples/. - AUDIT.md (206 -> 64 lines): rewritten to the current state after PR #10. It records concisely what is fixed (modernization #6-#9 + audit follow-up #1, #2, #10, #14-#19, DICOM hardening, os.environ device fix) versus what remains -- the audit does NOT claim everything is resolved: ~9 confirmed bugs are still a clearly-listed backlog (#3 VAE noise, #4 EMA early-stop score, #5 explicit Standardize, #6 Rotate deg->rad, #7 CLI tensorboard, #8 Unsqueeze, #9 ResampleToShape, #12 Select, #13 ITK) plus the deferred cross-cutting refactors.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
A docs-only refresh, no code changes.
AGENTS.md— condensed (303 → 93 lines)More general and succinct. Keeps the load-bearing parts — the three design pillars, the extension model (subclass + classpath), the do-not-break invariants, and the coding/commit/agent conventions — and drops the verbose config-key catalogues, per-subsystem deep-dives, env-var/optional-dep tables, and the end-to-end run trace (those belong in
docs/andexamples/).AUDIT.md— refreshed to current state (206 → 64 lines)Rewritten to reflect reality after PR #10, as a concise fixed vs remaining record.
os.environdevice-control-flow removal — each with a regression test.rand_likeinstead ofrandn_like, feat: add declarative YAML model builder #4 early-stop/BEST scores the EMA model, docs: add configuration and dataset-architecture guides and audit #5 explicitStandardizecrash, chore: add dev tooling/CI and modernize the core (perf, guards, config, fixes) #6Rotatedeg→rad, feat: add OME-Zarr (ngff-zarr) and DICOM dataset backends #7 CLI--tensorboarddropped for predict/eval, feat: add declarative YAML model builder #8Unsqueezeon a tensor, docs: add configuration/dataset guides and audit report #9ResampleToShapeconfig aliasing, refactor: dead-code removal and perf/elegance fixes across the core #12Selectsqueeze-by-index, feat: add ONNX model export #13ITKdouble-append — plus the deferred cross-cutting refactors (typedAttribute, perceptual-loss dedup).These remaining items are small, well-scoped, test-backable fixes — a natural next bug-fix PR.