Document the make() reproducibility contract (#197)#198
Open
dimitri-yatsenko wants to merge 1 commit into
Open
Document the make() reproducibility contract (#197)#198dimitri-yatsenko wants to merge 1 commit into
dimitri-yatsenko wants to merge 1 commit into
Conversation
Add the make() reproducibility contract (the five rules) to the docs, framed in the relational workflow model's own vocabulary — computed results, reproducibility, the FK DAG, table tiers, and the read/write boundary. - reference/specs/autopopulate.md: new §4.3 "The make() reproducibility contract" listing the five rules with the "read from self.upstream, write to self" frame and an honest enforcement note (2.3 provides the self.upstream / Diagram.trace read surface; the framework does not enforce the contract at runtime). Reconcile the existing upstream-only and make_kwargs notes to cross-reference the contract; fix the stale "a future release may enforce" wording. Renumber §4.4–4.6. - explanation/computation-model.md: conceptual note on why the read/write boundary yields self-contained, reproducible results, tied to the Computed vs. Imported tier distinction. Closes #197.
This was referenced Jul 13, 2026
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.
Closes #197.
Documents the make() reproducibility contract — the five rules that make a computed row's derivation self-contained and reproducible — in the relational workflow model's own vocabulary (computed results, reproducibility, the FK DAG, table tiers, the read/write boundary).
Changes
reference/specs/autopopulate.md— new §4.3 "The make() reproducibility contract" stating all five rules (populate-only; one entity per call in isolation; read only the key-restricted upstream cone; write toself/Parts with fan-out writes carrying their source; no result-affectingmake_kwargs), plus the one-line read fromself.upstream, write toselfframe and an honest enforcement note (2.3 provides theself.upstream/Diagram.traceread surface that makes the contract easy to follow and inspect; the framework does not enforce it at runtime). Reconciles the existing "Upstream-only convention" andmake_kwargsanti-pattern notes to cross-reference the contract, fixes the stale "a future release may programmatically enforce…" wording, and renumbers §4.4–4.6.explanation/computation-model.md— a "Why the contract matters" note under "Themake()Contract": the read/write boundary as the organizing idea, tied to the Computed (reproducible from within the pipeline) vs. Imported (reads untracked sources, records source identity) tier distinction.Notes
strict_provenanceframing is handled in its own PR, matching datajoint-python's strict_provenance removal.)strict_provenanceis not referenced.