Skip to main content

Layer

Struct Layer 

Source
pub struct Layer<M: Module> {
    pub norm: RmsNorm,
    pub mamba_block: M,
    pub class_latents: Vec<ClassLatent>,
    pub class_latents_emb: Option<Param<Tensor<2>>>,
}
Expand description

A single Pre-LN block wrapper computing M(RMSNorm(x)) — the residual is not applied here. The enclosing Layers owns that decision (add the input back, suppress it on the first/last layer, or thread it through Multi-Gate streams), so no input clone / zero-add is wasted when no residual is wanted.

May carry its own ClassLatents. In step they are spliced via the index cursor; in forward the caller splices them first (via Self::insert_latents) so the residual it adds sees the same lengthened sequence. They are independent of any class latents on the enclosing Layers.

Fields§

§norm: RmsNorm

Pre-norm applied before the inner block.

§mamba_block: M

The inner Mamba-x SSM block.

§class_latents: Vec<ClassLatent>

Positions of this layer’s class latents (empty ⇒ none).

§class_latents_emb: Option<Param<Tensor<2>>>

The class-latent embeddings, [num_class_latents, d_model] (None ⇒ none).

Implementations§

Source§

impl<M: MambaBlock> Layer<M>

Source

pub(crate) fn insert_latents(&self, x: Tensor<3>) -> Tensor<3>

Splice this layer’s class latents into x (no-op when there are none). Public to the crate so Layers can lengthen the sequence itself (and add the matching residual) before calling Self::forward.

Source

pub fn forward( &self, x: Tensor<3>, cache: Option<M::Cache>, ssd_path: M::SsdPath, ) -> (Tensor<3>, M::Cache)

Full-sequence Pre-LN block without the residual: M(RMSNorm(x)).

The caller owns any class-latent insertion (Self::insert_latents) and the residual.

Source

pub fn step( &self, x: Tensor<2>, cache: Option<M::Cache>, index: Option<&mut usize>, ) -> (Tensor<2>, M::Cache)

Single-token Pre-LN block step without the residual.

index is the running cursor into this layer’s output sequence. With Some, whenever it lands on one of this layer’s class-latent positions those latents are stepped first (each advancing index, recursing with None); only the user token’s output and cache are returned. With None no class latents are injected — and Middle/End latents panic (their positions need the full sequence; use forward). The residual is the caller’s responsibility.

Source

pub fn step_infinite(&self, x: Tensor<2>) -> Tensor<2>

Stationary fixed point of the Pre-LN block under a constant token, without the residual: the step counterpart of infinitely many identical tokens (closed form, no cache — see MambaBlock::block_step_infinite). Cursorless: class latents are not injected (Middle/End latents panic, as in a None-cursor step).

Source

pub fn step_n_approx( &self, x: Tensor<2>, n: usize, cache: Option<M::Cache>, ) -> (Tensor<2>, M::Cache)

Closed-form jump equivalent to n cursorless Self::step calls on the same constant token, without the residual (see MambaBlock::block_step_n_approx).

Trait Implementations§

Source§

impl<M> AutodiffModule for Layer<M>
where M: AutodiffModule + ModuleDisplay + Module,

Source§

fn valid(&self) -> Self

Returns the same module, but on the inner backend without auto-differentiation.
Source§

fn from_inner(module: Self) -> Self

Wraps an inner module back into an auto-diff module.
Source§

impl<M> Clone for Layer<M>
where M: Module + ModuleDisplay + Module,

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<M: Debug + Module> Debug for Layer<M>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<M> Display for Layer<M>
where M: Module + ModuleDisplay + Module,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<M> Module for Layer<M>
where M: Module + ModuleDisplay + Module,

Source§

type Record = LayerRecord<M>

Type to save and load the module.
Source§

fn load_record(self, record: Self::Record) -> Self

Load the module state from a record.
Source§

fn into_record(self) -> Self::Record

Convert the module into a record containing the state.
Source§

fn num_params(&self) -> usize

Get the number of parameters the module has, including all of its sub-modules.
Source§

fn visit<Visitor: ModuleVisitor>(&self, visitor: &mut Visitor)

Visit each tensor parameter in the module with a visitor.
Source§

fn map<Mapper: ModuleMapper>(self, mapper: &mut Mapper) -> Self

Map each tensor parameter in the module with a mapper.
Source§

fn collect_devices(&self, devices: Devices) -> Devices

Return all the devices found in the underneath module tree added to the given vector without duplicates.
Source§

fn to_device(self, device: &Device) -> Self

Move the module and all of its sub-modules to the given device. Read more
Source§

fn fork(self, device: &Device) -> Self

Fork the module and all of its sub-modules to the given device. Read more
§

fn devices(&self) -> Vec<Device>

Return all the devices found in the underneath module tree without duplicates.
§

fn no_grad(self) -> Self

Each tensor in the module tree will not require grad. Read more
§

fn train(self) -> Self
where Self: AutodiffModule,

Move the module and all of its sub-modules to the autodiff backend. Read more
§

fn quantize_weights(self, quantizer: &mut Quantizer) -> Self

Quantize the weights of the module.
Source§

impl<M> ModuleDisplay for Layer<M>
where M: Module + ModuleDisplay + Module,

§

fn format(&self, passed_settings: DisplaySettings) -> String

Formats the module with provided display settings. Read more
§

fn custom_settings(&self) -> Option<DisplaySettings>

Custom display settings for the module. Read more
§

fn custom_content(&self, _content: Content) -> Option<Content>

Custom attributes for the module. Read more
Source§

impl<M> ModuleDisplayDefault for Layer<M>
where M: Module + ModuleDisplay + Module,

Source§

fn content(&self, content: Content) -> Option<Content>

Attributes of the module used for display purposes. Read more
Source§

fn num_params(&self) -> usize

Gets the number of the parameters of the module.

Auto Trait Implementations§

§

impl<M> !Freeze for Layer<M>

§

impl<M> !RefUnwindSafe for Layer<M>

§

impl<M> !UnwindSafe for Layer<M>

§

impl<M> Send for Layer<M>

§

impl<M> Sync for Layer<M>
where M: Sync,

§

impl<M> Unpin for Layer<M>
where M: Unpin,

§

impl<M> UnsafeUnpin for Layer<M>
where M: UnsafeUnpin,

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, 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> 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.