Skip to content

Study lifecycle

Create or load a durable study, then run, inspect, summarize, resume, or retry it through the Study object.

Stable public API. The 1.x compatibility policy defines the supported surface; import from the public facade shown below.

from vamos import create_study, load_study, Study

Durable studies guide · Specification and planning · Limits and reports

Creation performs no optimization; loading is data-only. Study mutation is single-owner and sequential in VAMOS 1.0.0: do not run concurrent run, resume, or retry operations against the same study. There is no cross-process cancellation command.

create_study(spec, *, output, limits=None)

Resolve and atomically publish a study without executing any task.

load_study(path, *, limits=None)

Load and fully verify one canonical study without executing code.

Study dataclass

Immutable, data-only handle for a verified persisted study.

cancel()

Cancel this study or request cancellation from its local runner.

inspect()

Reload and project current durable state without modifying it.

resume(*, retry_failed=False)

Reconcile this study and execute its eligible unfinished tasks.

retry(*, failed_only=True)

Explicitly retry eligible terminal attempts without changing the plan.

run()

Execute this newly created durable study sequentially.

summarize()

Return a deterministic in-memory summary without writing files.