Skip to main content

Mamba2SsdPath

Enum Mamba2SsdPath 

Source
pub enum Mamba2SsdPath {
    Minimal(Option<usize>),
    Serial(Option<usize>),
    SerialRecalculated(Option<usize>),
}
Expand description

Ssd algorithm selection.

Each variant carries the chunk length Q for the SSD algorithm.
Larger values increase the intra-chunk GEMM work and reduce the inter-chunk scan length.
Optimal value is approximately √(state_rank · per_head_dim).

Variants§

§

Minimal(Option<usize>)

Minimal SSD.

This algorithm mostly uses batched matmuls. For the backward operation, this relies on autodiff.
See [chunked_selective_scan] for more info.

For training, you may prefer using SerialRecalculated instead.

Based on /mamba_ssm/modules/ssd_minimal.py from the state-spaces/mamba github reference.

§

Serial(Option<usize>)

(Hybrid) Serial SSD.

This algorithm uses a serial loop over the nchunks, besides batched matmuls. For the backward operation, this relies on autodiff.
For a custom backwards that saves memory, see SerialRecalculated.

Based on 5 kernels on /mamba_ssm/ops/triton/ from the state-spaces/mamba github reference:

  • ssd_chunk_state.py (K1, K3).
  • ssd_bmm.py (K2).
  • ssd_state_passing.py (K4).
  • ssd_chunk_scan.py (K5).
§

SerialRecalculated(Option<usize>)

(Hybrid) Serial SSD that triggers recalculations for the backward pass.

This algorithm uses a serial loop over the nchunks, besides batched matmuls. Contains a custom backward operation that saves memory.
For an autodiff backwards, see Serial.

Based on the combined kernel /mamba_ssm/ops/triton/ssd_combined.py from the state-spaces/mamba github reference.

Implementations§

Source§

impl Mamba2SsdPath

Source

pub fn optimal_default(state_rank: usize, per_head_dim: usize) -> usize

Optimal chunk length is approximately √(state_rank · per_head_dim).

Source

pub fn core_optimal(state_rank: usize, per_head_dim: usize) -> Self

Optimal Minimal variant.

See optimal_default for more info.

Source

pub fn core_optimal_from_block<B: Backend>(block: &Mamba2<B>) -> Self

Optimal Minimal variant.

See optimal_default for more info.

Source

pub fn chunked_optimal(state_rank: usize, per_head_dim: usize) -> Self

Optimal Serial variant.

See optimal_default for more info.

Source

pub fn chunked_optimal_from_block<B: Backend>(block: &Mamba2<B>) -> Self

Optimal Serial variant.

See optimal_default for more info.

Source

pub fn chunked_recalculated_optimal( state_rank: usize, per_head_dim: usize, ) -> Self

Optimal Serial variant.

See optimal_default for more info.

Source

pub fn chunked_recalculated_optimal_from_block<B: Backend>( block: &Mamba2<B>, ) -> Self

Optimal Serial Recalculated variant.

See optimal_default for more info.

Source

pub fn chunk_len(&self) -> Option<usize>

Source

pub fn chunk_len_or_optimal( &self, state_rank: usize, per_head_dim: usize, ) -> usize

Source

pub fn run<B: Backend + Mamba2BackendExt>( &self, input: Mamba2SsdInput<B>, ) -> (Tensor<B, 5>, Tensor<B, 4>)

Run the SSD algorithm on the given input.

Dispatches to ssd_minimal, ssd_serial, or ssd_serial_recalculated based on the variant.

§Returns
  • y_bnlhp: [batch, nchunks, chunk_len, nheads, per_head_dim]
  • final_state_bhpr: [batch, nheads, per_head_dim, state_rank]

Trait Implementations§

Source§

impl Clone for Mamba2SsdPath

Source§

fn clone(&self) -> Mamba2SsdPath

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 Debug for Mamba2SsdPath

Source§

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

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

impl Default for Mamba2SsdPath

Source§

fn default() -> Mamba2SsdPath

Returns the “default value” for a type. 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, 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, 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.