Skip to main content

RecurrentPassSpec

Struct RecurrentPassSpec 

Source
pub struct RecurrentPassSpec {
    pub loop_start: usize,
    pub loop_end: usize,
    pub feedback: Vec<RecurrentFeedbackEntry>,
    pub sustained: bool,
    pub depth: usize,
}
Expand description

Specification for a recurrent multi-pass forward through a layer block.

The recurrence re-runs layers loop_start..=loop_end a total of depth times, with optional feedback injected into the hidden state between passes.

§Without feedback

Each subsequent pass receives the previous pass’s output (true recurrence — extra depth).

§With feedback

Each subsequent pass resets to the saved pre-loop hidden state plus feedback vectors: hidden[position] += strength * vector. This means every recurrent pass sees the same clean input with the nudge applied — the layers process H₀ + nudge rather than iterating on their own output, which would cause degeneration.

Fields§

§loop_start: usize

First layer of the recurrent block (inclusive).

§loop_end: usize

Last layer of the recurrent block (inclusive).

§feedback: Vec<RecurrentFeedbackEntry>

Feedback vectors to inject between passes.

When present, each recurrent pass resets to the saved pre-loop state and injects these vectors before re-running the loop layers. If empty, each pass receives the previous pass’s output unmodified (pure depth increase).

§sustained: bool

If true, also inject feedback at the current last token position during each autoregressive generation step (sustained recurrence).

If false, feedback is only injected at the original prompt positions (prefill-only recurrence).

§depth: usize

Number of times to run the recurrent layer block.

Must be at least 1 (a single pass, no recurrence). The default is 2 (one initial pass plus one recurrent pass with feedback injection).

Implementations§

Source§

impl RecurrentPassSpec

Source

pub const fn no_feedback(loop_start: usize, loop_end: usize) -> Self

Create a spec with no feedback (pure double-pass, depth 2).

Source

pub const fn with_sustained(self, sustained: bool) -> Self

Set the sustained flag (builder pattern).

Source

pub const fn with_depth(self, depth: usize) -> Self

Set the recurrence depth (builder pattern).

depth is the total number of times the recurrent layer block is executed. The default is 2 (one initial pass plus one recurrent pass). A depth of 1 means no recurrence (single pass).

Source

pub fn add_feedback(&mut self, position: usize, vector: Tensor, strength: f32)

Add a feedback entry.

Source

pub fn validate( &self, n_layers: usize, seq_len: usize, d_model: usize, ) -> Result<()>

Validate the spec against model dimensions.

§Errors

Returns MIError::Intervention if the layer range is invalid, feedback positions exceed sequence length, or feedback vectors have the wrong dimension.

Trait Implementations§

Source§

impl Clone for RecurrentPassSpec

Source§

fn clone(&self) -> RecurrentPassSpec

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for RecurrentPassSpec

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,