Struct KvDictionary 

pub struct KvDictionary {
    pub dim: usize,
    pub n_atoms: usize,
    pub atoms: Vec<f32>,
    pub sparsity: usize,
}

A learned per-layer KV dictionary: n_atoms atoms, each of length dim, row-major in atoms.

Fields

dim: usize

n_atoms: usize

atoms: Vec<f32>

n_atoms × dim, row-major; each atom is L2-normalized.

sparsity: usize

Sparsity k this dictionary was trained for (atoms per coded vector).

Implementations

impl KvDictionary

pub fn normalize_atoms(&mut self) -> bool

Normalize every dictionary atom in place after loading or training. Returns false when the declared shape is inconsistent or an atom has effectively zero magnitude.

pub fn reconstruct(&self, code: &SparseCode) -> Vec<f32>

Reconstruct a vector from its sparse code: Σ coeffs[i] · atom(indices[i]). The read-path operation the attention shader mirrors.

pub fn encode(&self, v: &[f32], k: usize) -> SparseCode

Orthogonal Matching Pursuit: encode v with at most k atoms. Greedy selection by maximum absolute correlation with the residual, re-solving all selected coefficients by least squares each step (the “orthogonal” in OMP). Stops early if the residual is already ~0.

impl KvDictionary

pub fn encode_to_words(&self, vec: &[f32], k: usize, out: &mut [f32])

Encode vec to k contiguous code words in out (len ≥ k). Pads with zero-coeff words if OMP selected fewer than k atoms (a zero coeff reconstructs to nothing).

pub fn reconstruct_from_words(&self, words: &[f32], k: usize, out: &mut [f32])

Reconstruct a vector from k contiguous code words (words len ≥ k) into out (len = dim). The exact f16-coefficient inverse of [encode_to_words] — the compressed-cache read path.

impl KvDictionary

pub fn reconstruction_error(&self, vectors: &[Vec<f32>], k: usize) -> f64

Mean relative reconstruction error over vectors: mean_i ‖v_i − D·code_i‖ / ‖v_i‖. The quality proxy compared against uniform quantization in the go/no-go.

Trait Implementations

impl Clone for KvDictionary

fn clone(&self) -> KvDictionary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KvDictionary

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KvDictionary

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for KvDictionary

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.