Module Promise Map¶
Page Maps¶
graph LR
family["Reproducible Research"]
program["Deep Dive DVC"]
section["Guides"]
page["Module Promise Map"]
capstone["Capstone evidence"]
family --> program --> section --> page
page -.applies in.-> capstone
flowchart LR
orient["Orient on the page map"] --> read["Read the main claim and examples"]
read --> inspect["Inspect the related code, proof, or capstone surface"]
inspect --> verify["Run or review the verification path"]
verify --> apply["Apply the idea back to the module and capstone"]
Use this page when a module title sounds right but still too compressed. A strong module title should tell you what kind of judgment you will leave with, not just which tool or topic bucket the chapter occupies.
How to read this map¶
Each row answers four practical questions:
- what the module is trying to change in your mental model
- what boundary that promise is really about
- what you should be able to do afterward
- what capstone route first corroborates the lesson
If a module drifts away from that contract, the drift should be visible here.
Module contracts¶
| Module | The promise | The boundary | You should leave able to... | First corroboration route |
|---|---|---|---|---|
| 01 Reproducibility Failures | make weak reproducibility stories look obviously insufficient | failure modes, trust questions, state layers | explain why reruns and saved files are weaker than explicit state contracts | Capstone Guide |
| 02 Data Identity | teach durable state identity rather than path-based intuition | workspace, cache, remote, lockfile, content addressing | distinguish location from durable identity and say which layer is authoritative | Command Guide |
| 03 Environments and Execution Context | make runtime context part of reproducibility truth instead of invisible setup | environment, code, validation, execution assumptions | explain why environment boundaries belong in the state model | Capstone File Guide |
| 04 Truthful Pipelines | treat dvc.yaml and dvc.lock as one explicit execution contract |
stages, deps, outs, params, recorded execution state | review whether a pipeline edge is truly declared | Capstone File Guide |
| 05 Metrics and Parameters | teach semantic comparability instead of metric folklore | params, metrics, reports, comparison boundaries | say what a metric comparison is allowed to mean and why | Capstone Proof Guide |
| 06 Experiments | show how to vary the control surface without mutating baseline truth | experiment runs, baselines, declared controls, comparison routes | explain how changed runs stay comparable to the baseline | Capstone Proof Guide |
| 07 Collaboration and CI | teach what another maintainer should be able to rerun and review | reviewability, CI gates, handoff trust, repo policy | explain what must stay legible without oral explanation | Capstone Review Worksheet |
| 08 Recovery and Scale | make durability and restoration boundaries reviewable under pressure | cache loss, remote-backed restore, recovery evidence | explain what survives local loss and what only looked durable | Capstone Proof Guide |
| 09 Promotion and Auditability | teach promotion as a smaller trusted boundary instead of a repository dump | publish surfaces, manifests, release review, promotion evidence | review what downstream users may trust from the promoted bundle | Capstone Proof Guide |
| 10 Migration and Governance | teach stewardship, migration order, and honest DVC limits | governance, anti-patterns, tool boundaries, migration review | decide whether DVC should keep owning the concern | Capstone Review Worksheet |
What this page prevents¶
This map exists to prevent four common course failures:
- a module promises judgment but only delivers commands
- a module promises operations but never reaches executable proof
- a module promises promotion or recovery but leaves the review route blurry
- a module promises governance but never turns into review behavior
If you notice one of those failures while reading, come back here and name the missing piece directly.
Best companion pages¶
- Module Checkpoints when you need the exit bar after the promise
- Proof Ladder when the corroboration route feels too heavy
- Capstone Map when the promise is clear but the repository route is not