Skip to content

Add intent, specs, ADRs and the critical examination - #112

Merged
ravenoak merged 2 commits into
mainfrom
docs/intent-and-specs
Oct 10, 2026
Merged

ravenoak merged 2 commits into
mainfrom
docs/intent-and-specs

Conversation

@ravenoak

@ravenoak ravenoak commented Oct 10, 2026 •

Copy link
Copy Markdown
Owner

The generator fails on every image, the card API and the training tool the project uses are gone or going, and the trainer, label catalog, subset selection, evaluation and inference are neither specified nor built. DESIGN.md covered only the generator.

This adds the documents that define the work, and the backlog that does it. The package code does not change. DESIGN.md is removed, and README.md, CLAUDE.md and AGENTS.md point to the new docs.

Documents (docs/)

  • intent.md replaces DESIGN.md: purpose, users, outcomes, proposed success measures, non-goals, constraints, glossary.
  • principles.md, architecture.md.
  • specs/: catalog, generation, selection, training, evaluation, inference, and cross-cutting. 83 EARS requirements with FR-/NFR- ids, each with a check. Each spec ends with its current state and the issue that closes each gap.
  • adr/: 0001 to 0004 Accepted (record decisions, PyTorch + timm, retrieval first, TCGdex source; 0002 to 0004 follow your answers to the planning questions). 0005 (plain-file formats) and 0006 (offline plus online augmentation) are Proposed.
  • rtm.md: every requirement with its issue, implementation and test refs.
  • examinations/2026-10-09-critical-examination.md: the 37 finding records, the verification, the commands behind each count, the limits, and the corrections from a second review.

Backlog: issues #75 to #111, in four milestones (M1 Pipeline runs, M2 Catalog and selection, M3 Trainer v1, M4 Evaluation and inference). Each cites its ReqIDs and acceptance criteria. Links from issues to docs/ resolve once this merges.

Needs the owner

Checked

  • uv run prek run --all-files passes: ruff, pyright, and pytest (42 passed, 1 skipped).
  • A local script (not in the repo) confirmed that all 83 requirements appear in docs/rtm.md, that relative links resolve, and that no unknown ReqID is cited. Add a check that links tests to requirements #99 adds a repo check.
  • A second reviewer found defects in the first version. They are fixed and listed in the examination.
  • Not verified: TCGdex rate limits, image rights, and the official Standard rotation date.

The project documents only the dataset generator (DESIGN.md), and the
generator fails on every image. The trainer, label catalog, subset
selection, evaluation and inference are not specified or built. Both
the card API and the training tool the project relies on are gone or
going.

This adds docs/ with the intent, principles, architecture, six
component specs (82 EARS requirements with FR/NFR ids), six ADRs, a
requirements matrix and the examination record. DESIGN.md moves into
docs/intent.md. The 37 issues #75 to #111 carry the work, each citing
the requirements it implements. README, CLAUDE.md and AGENTS.md point
to the new docs, and the issue forms ask for ReqIDs.

ADRs 0005 and 0006 are Proposed and need the owner's decision. The
success measures in docs/intent.md are proposals.
A second reviewer found that 4,056 of 23,736 TCGdex card ids broke the
id rule, most of them from the 15 TCG Pocket sets, and that several
requirement checks and issue links contradicted each other.

Keep ids as the source writes them, derive file names with
file_name(id), and leave TCG Pocket out (FR-117). Move variants to a
pool keyed by config hash and seed. Split the two export commands.
Replace checks that a hash split or a read-only run could not meet.
Correct the API outage claim (HTTP 200 at 06:39) and the count
comparison (set totals, physical sets only).
@ravenoak
ravenoak merged commit c52dd26 into main Oct 10, 2026
2 checks passed
@ravenoak
ravenoak deleted the docs/intent-and-specs branch October 10, 2026 14:55
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