Sequence#
- class braintools.cogtask.Sequence(*phases, name='Sequence')[source]#
Sequential composition of phases.
Created via: -
Sequence(phase1, phase2, phase3)-phase1 >> phase2 >> phase3-concat([phase1, phase2, phase3])Examples
>>> import brainstate >>> import brainunit as u >>> from braintools.cogtask import Context, Fixation, Sequence, Stimulus >>> seq = Sequence(Fixation(100 * u.ms), Stimulus(500 * u.ms)) >>> seq Sequence(Fixation >> Stimulus) >>> # Equivalent to: >>> Fixation(100 * u.ms) >> Stimulus(500 * u.ms) Sequence(Fixation >> Stimulus) >>> len(seq) 2 >>> with brainstate.environ.context(dt=1.0 * u.ms): ... seq.get_duration(Context()) 600
- children()[source]#
Return the immediate child phases of a compound phase.
Leaf phases return
[]. Subclasses likeSequence,Repeat,Parallel,If,Switch,Whileoverride this so that theTaskcan traverse the whole tree to bind features.
- encode_inputs(ctx)[source]#
Fill ctx.inputs[phase_start:phase_end] with input encoding.
Called once per phase after duration is determined. Must modify ctx.inputs in-place.
- encode_outputs(ctx)[source]#
Fill ctx.outputs[phase_start:phase_end] with target encoding.
Called once per phase after duration is determined. Must modify ctx.outputs in-place.
- max_steps(ctx)[source]#
Static upper bound on this phase’s length in timesteps.
Must return a Python int with no dependence on traced values. Used by
Taskin variable-length mode to size shape-stable buffers. The default delegates toget_durationwhich is correct for fixed-duration phases. Variable-duration phases (e.g. those wrappingTruncExp/UniformDuration) override this to return the truncation upper bound divided byctx.dt.
- step_count(ctx)[source]#
Traced actual length of this phase in timesteps.
Returns a
jax.Arrayint32scalar. May depend onctx[...]values populated bytrial_init. Must satisfy0 <= step_count(ctx) <= max_steps(ctx)for every trial.The default returns a static value equal to
get_duration; that is correct for any phase whose actual length matches its upper bound. Variable-duration phases override this to compute the traced length fromctxstate without anyint(...)cast.- Return type:
Array