Skip to content
Development documentation. The PyPI package predates these APIs. Install from GitHub instead: pip install 'increment @ git+https://github.com/kylejcaron/increment.git' Keep any extras requested by the guide, such as increment[dashboard].

Assignment and study contracts

Assignment

No docstring.

ParallelAssignment

No docstring.

IndependentBernoulliOrder

One independent Bernoulli CT/TC order draw per unit-cycle.

Every unit draws its own order independently of every other unit, which is what makes the unit the independent replicate: cross-unit replication exists for a unit-level reference distribution.

SharedScheduleOrder

One independent Bernoulli CT/TC order draw per two-period block, shared by every unit in a fixed, complete unit roster.

Unlike :class:IndependentBernoulliOrder, no unit draws its own order: the whole roster follows one realized order per block, so the independent replicate is the block, not the unit. A common roster duplicated uniformly adds no independent blocks and therefore cannot change the mean-unit retained-window effect scale or inferential sample size. The switchback panel path reduces the roster within each block and uses switchback_block_t with a block_t reference. At least two independent blocks are required; a one-unit roster is supported.

SwitchbackWindow

A washout/observation window with a declared residual-carryover order.

carryover_order names additional observation steps, immediately after the declared washout, still assumed contaminated by the prior period and therefore discarded before the retained window used for inference. Retained steps satisfy step >= washout_steps + carryover_order; the retained window’s length is observation_steps - carryover_order. carryover_order=0 is the plain no-residual-carryover-after-washout case. Declaring an order is an assumption, not something a balance diagnostic can prove true.

SwitchbackAssignment

No docstring.

ParallelStudyEnvelope

No docstring.

SwitchbackStudyEnvelope

No docstring.

StudyEnvelope

No docstring.

ProspectiveAssumptionProvenance

No docstring.