Skip to content

Capstone Tour

Guide Maps

graph LR
  family["Reproducible Research"]
  program["Deep Dive DVC"]
  guide["Capstone docs"]
  section["TOUR"]
  page["Capstone Tour"]
  proof["Proof route"]

  family --> program --> guide --> section --> page
  page -.checks against.-> proof
flowchart LR
  orient["Read the guide boundary"] --> inspect["Inspect the named files, targets, or artifacts"]
  inspect --> run["Run the confirm, demo, selftest, or proof command"]
  run --> compare["Compare output with the stated contract"]
  compare --> review["Return to the course claim with evidence"]

This tour is the executed proof route for the DVC capstone. It builds a bundle that captures the repository state the course asks you to reason about: declared pipeline shape, recorded execution state, tracked metrics, promoted artifacts, and the stable publish boundary.

If you want a lighter first step, run make walkthrough first. That bundle contains the repository contract, pipeline declaration, recorded lock state, params surface, and a suggested reading route without executing the workflow.

Read BUNDLE_MANIFEST_GUIDE.md when the next question is not which proof route to use, but exactly what a saved bundle captured.

Read SOURCE_GUIDE.md when the bundle and stage routes are clear but you need the exact owning file for one behavior.

Read REVIEW_ROUTE_GUIDE.md when the main question is whether the tour is the right route at all or whether a smaller summary or saved bundle would be cleaner.

What the tour produces

  • status.txt: DVC's current view of whether the repository is up to date
  • pipeline.dot: the declared stage graph in Graphviz DOT format
  • dvc.yaml: the declared pipeline contract
  • dvc.lock: the recorded state transition after execution
  • params.yaml: the declared control surface for the run
  • metrics.json: the tracked evaluation result
  • state-summary.json: the combined declaration, execution, and release summary
  • release-summary.json: the promoted release summary
  • review-queue.json: the structured prediction review queue
  • publish-v1/: the promoted artifact bundle that downstream consumers should trust

How to run it

From the capstone directory:

make walkthrough
make tour

From the repository root:

make PROGRAM=reproducible-research/deep-dive-dvc capstone-walkthrough
make PROGRAM=reproducible-research/deep-dive-dvc capstone-tour
make PROGRAM=reproducible-research/deep-dive-dvc capstone-confirm

What to inspect first

  1. README.md
  2. DOMAIN_GUIDE.md
  3. STAGE_CONTRACT_GUIDE.md
  4. dvc.yaml
  5. dvc.lock
  6. params.yaml
  7. metrics.json
  8. state-summary.json
  9. release-summary.json
  10. review-queue.json
  11. publish-v1/manifest.json
  12. publish-v1/report.md

That order mirrors the course: repository contract, declared graph, recorded execution, declared inputs, measured outcome, promoted interface, and human-readable report.

What this tour does not replace

The tour is corroboration, not first-contact teaching. If state identity, promotion, or recovery still feels abstract, return to the course module first and then come back.