Skip to main content

KvLayout

Enum KvLayout 

Source
pub enum KvLayout {
    Gqa {
        n_kv_heads: usize,
        head_dim: usize,
    },
    MlaLatent {
        kv_lora_rank: usize,
        qk_rope_head_dim: usize,
    },
    MlaExpanded {
        n_heads: usize,
        k_head_dim: usize,
        v_head_dim: usize,
    },
}
Expand description

How one layer’s KV cache is shaped. Which variant applies is a property of the decoder that will run, not of the architecture name – see KvLayout::MlaLatent’s doc comment for the one place that distinction bites.

Variants§

§

Gqa

Multi-head / grouped-query attention: one K vector and one V vector of n_kv_heads * head_dim per token, per layer. MHA is just the n_kv_heads == n_heads case – there is no separate variant for it, and the halving GQA buys shows up entirely in n_kv_heads.

Fields

§n_kv_heads: usize
§head_dim: usize
§

MlaLatent

MLA in its absorbed form: the cache holds only the compressed latent plus the decoupled RoPE slice, kv_lora_rank + rope_dim scalars per token per layer, and K/V are reconstructed from it on the fly. One vector, not two – there is no * 2 here.

ferrox does not run this form today. mla::mla_forward_token (and therefore kimi_decoder, glm_dsa, glm52_decoder) caches the expanded per-head K and V, so a real ferrox MLA run costs KvLayout::MlaExpanded. This variant is what the absorbed form would cost, and is the right number to plan against only once a decoder actually caches the latent.

Fields

§kv_lora_rank: usize
§qk_rope_head_dim: usize
§

MlaExpanded

MLA as ferrox actually caches it: per-head K of qk_nope_head_dim + qk_rope_head_dim and per-head V of v_head_dim, both materialised (mla::mla_forward_token’s k_cache/v_cache). K and V head dims differ, which is exactly why this cannot reuse the Gqa arm.

Fields

§n_heads: usize
§k_head_dim: usize
§v_head_dim: usize

Implementations§

Source§

impl KvLayout

Source

pub fn elems_per_token_per_layer(self) -> u64

Cached scalars one token contributes to one layer.

Source

pub fn describe(self) -> String

One-line description of the arithmetic, for the report a user reads when they want to know why they got the context they got.

Trait Implementations§

Source§

impl Clone for KvLayout

Source§

fn clone(&self) -> KvLayout

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 Copy for KvLayout

Source§

impl Debug for KvLayout

Source§

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

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

impl Eq for KvLayout

Source§

impl PartialEq for KvLayout

Source§

fn eq(&self, other: &KvLayout) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for KvLayout

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> 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> 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 = !

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.