Skip to contents

Workflow packs request reviews based on diagnostic summaries and project context. Blocking obligations hold downstream computation until resolved. See vignette("concepts") for the review flow and glossary.

Details

ConceptWho produces itWhat it does
NodeThe userA computation and its dependencies.
SummaryAn executor (built-in or user-registered)Typed evidence (HMC, ppc, loo_pit, sbc, ...).
ObligationA workflow packWork the analysis needs, such as reviewing divergences.
ActionA workflow packA suggested step, such as recording a decision or adding a check.
DecisionThe userThe recorded answer (choice + rationale).
HoldThe enginePrevents a node from running.
GateThe userA pre-planned checkpoint on an edge.

Use a gate when you know in advance that a step needs sign-off. Workflow packs raise obligations as the analysis develops. A decision can resolve a review; other obligations need new evidence. Advisory obligations do not hold execution.

Scopes

Decisions and obligations carry a scope: project (whole project) or branch:<id> (one branch). A decision recorded on a branch does not satisfy a project-scope obligation, and vice versa. Use bg_next_actions() to see what is outstanding at the relevant scope.

Evidence freshness

A summary is fresh when its fingerprint matches the node's current configuration, stale when the node's params, upstream inputs, or environment changed since it was written. Packs consume fresh summaries by default; a stale summary produces no obligation until the node is rerun.