Skip to content

Study specification and planning

Describe the problem–algorithm–seed matrix and inspect the resolved plan before creating or executing a durable study.

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

from vamos import StudySpec, plan_study

Durable studies guide · Study lifecycle · Study reports

StudySpec dataclass

Validated, immutable user intent for a deterministic study plan.

Seeds are explicit. All defaults selected during creation are frozen into each task's resolved run specification before publication.

as_intent_dict()

Return a detached JSON representation without document identity.

plan_study(spec, *, output=None)

Resolve and explain spec without creating a study or running a task.

StudyPlanReport dataclass

Immutable explanation of a resolved study with no published state.

as_dict()

Return a detached semantic payload for Python and CLI consumers.