Reproducible research artifacts
Package claims, exact inputs, execution environments, raw results, and analysis so an independent reader can verify the evidence.
On this page
The question for today
What you’ll understand
- Map each research claim to an executable verification path.
- Design a compact artifact manifest and staged reproduction workflow.
- Distinguish availability, successful execution, and independent result validation.
A repository link is a starting point for reproducibility, not the finished artifact. The reader needs to know which revision produced a figure, which data were used, what resources the experiment requires, and how raw observations became the reported result. A strong artifact makes a research claim inspectable without requiring private conversations with its authors. It should also make failure informative: an unavailable dataset or unsupported accelerator must produce a clear explanation rather than a silently different experiment.
Build a dependency chain from claim to evidence
Start with a claim inventory. For each table, figure, or numerical assertion, name the inputs, execution command, raw outputs, analysis command, and expected result range. Use immutable identifiers for code, containers, datasets, and model checkpoints. A tag can move, while a digest identifies content under its hashing assumptions. Preserve configuration and dependency resolution, not merely a list of top-level libraries with unconstrained versions.
A manifest should also state hardware assumptions, peak memory, storage, approximate runtime, seeds, environment variables that change semantics, and licenses or access restrictions. Do not package credentials or private data into a public archive. If restricted inputs cannot be redistributed, document a legitimate access process and provide a synthetic smoke test with an explicit limit: it checks execution wiring, not reproduction of a sensitive-data result.
Offer a ladder from smoke test to full result
Provide a cheap installation check, a small correctness run, a reduced experiment, and the full reproduction path. State which claims each stage supports. A two-minute smoke test can verify imports and output schema but cannot validate a week-long convergence claim. Include expected logs and meaningful tolerances, especially when hardware changes affect numerical results. Separate setup failures from scientific disagreement so reviewers can tell whether the method ran as intended.
Keep raw observations and analysis scripts sufficient to regenerate reported summaries. If a figure uses medians across runs, publish the run identities and aggregation rule, including excluded failures and their reasons. Avoid manually edited spreadsheets as the only bridge from logs to a paper. Preserve units and missing-value handling in machine-readable outputs. A reproducible calculation on selectively reported data can still be misleading, so completeness of the evidence matters.
Make independent use a design requirement
Ask someone outside the implementation team to run the documented path from a clean environment. Record unclear instructions and missing assumptions as artifact defects. Public availability, successful execution, and independent validation of the main result are separate accomplishments. ACM's artifact policy distinguishes related badges, while conference checklists ask authors to document experimental details and limitations. State precisely what review occurred instead of implying a stronger endorsement.
Archive a versioned release in a repository intended for durable access, with checksums and a citation identifier where available. Document how future readers can verify the archive and what may expire, such as model-hosting endpoints. Maintain an issue log for known deviations and corrected results. An artifact is most useful when it supports both reproduction and extension: modular experiments, documented interfaces, and clear boundaries let others test the next hypothesis without rebuilding the entire environment.
Work it through
Plan an affordable verification ladder
An artifact has twelve declared claims. A smoke test costs 2 minutes; a reduced experiment costs 18 minutes and verifies four claims; a full suite costs 20 accelerator-hours and verifies all twelve. A reviewer has a one-hour initial budget.
Run the smoke test first: 60 − 2 = 58 minutes remain, but no scientific claim is established by installation alone.
Run the 18-minute reduced experiment, leaving 40 minutes and four verified claim paths.
Initial verified-path coverage is 4/12 = 1/3, or approximately 33.3%, under the declared inventory.
Do not label the entire result reproduced. Preserve the raw reduced outputs, record the unverified eight claims, and schedule the full suite only with its stated resources.
A staged artifact supports useful partial verification while keeping the limits of the review explicit.
The living notebook
Explore the model
Interactive lab · reliability
Separate accessible components from verified claims
Inspect n replicas, k unavailable, up=n−k, and the required majority floor(n/2)+1. This small availability model can prompt a discussion of missing artifact dependencies; it does not verify research claims, model archive durability, or make majority access a reproducibility rule.
- Available replicas
- 4 of 5
- Majority needed
- 3
- Majority available?
- Yes
A replica count and a majority threshold, without a consensus protocol. Playback highlights fixed replica states. Having a majority alone does not establish linearizability, durability or failure independence. Parameter changes pause playback and recompute the model at the current elapsed time. Reset restores both parameters and returns time to zero. Playback starts paused. Adjust either parameter, then choose Play or Step.
Look forAccessible components are necessary evidence infrastructure, but successful independent verification needs the full relevant path.
Pause & reason
Check your understanding
Your turn
Try it yourself
A published mean latency is 20 ms over five runs. Four archived runs have means 18, 19, 20, and 21 ms. What fifth run would yield the reported unweighted mean? Why does recovering this value not complete an audit?
Take a moment to make a prediction or work it out on paper. Open a hint when you need one.
Give me a hint
The sum of five run means must be five times 20, assuming the stated aggregation rule.
Compare with the solution
The required total is 100 ms and the four recorded means sum to 78 ms, so the missing mean would be 22 ms. That inference does not recover raw samples, validate equal weighting, reveal exclusions, or show that the missing run happened. Request the actual evidence rather than substituting an inferred value.
Keep the idea
Take it with you
- Map each claim to versioned inputs, execution, raw outputs, and analysis.
- Use staged reproduction with explicit resource requirements and scope.
- Availability and successful execution are distinct from independent result validation.
Read further
Original sources and deeper explanations to follow at your own pace.
Optional progress, saved in this browser when available. Revisit any lesson at any time.
Lesson not marked complete.