Skip to main content

VqCodebook

Struct VqCodebook 

Source
pub struct VqCodebook {
    pub embeddings: Vec<f32>,
    pub n_codes: usize,
    pub code_dim: usize,
    pub ema_momentum: f32,
    pub commitment_weight: f32,
    pub ema_counts: Vec<f32>,
    pub ema_sum: Vec<f32>,
}
Expand description

EMA-maintained vector-quantisation codebook.

Stores K code vectors of dimension C as a flat [K × C] row-major buffer. EMA running statistics (ema_counts, ema_sum) are used for the Laplace-smoothed online codebook update rule:

    n_k  ← m·n_k + (1-m)·|S_k|
    e_k  ← m·e_k_sum + (1-m)·Σ_{z∈S_k} z   (running sum)
    code_k ← e_k_sum / n_k                   (normalised)

Fields§

§embeddings: Vec<f32>

Codebook entries E ∈ ℝ^{K×C}, row-major. Length = K * C.

§n_codes: usize

Number of codes K.

§code_dim: usize

Code dimensionality C.

§ema_momentum: f32

EMA momentum m for codebook update (closer to 1 → slower update).

§commitment_weight: f32

Commitment loss weight β.

§ema_counts: Vec<f32>

EMA usage counts per code [K]. Initialised to 1 (Laplace smoothing).

§ema_sum: Vec<f32>

EMA running sums per code [K × C]. Initialised to the code vectors.

Trait Implementations§

Source§

impl Clone for VqCodebook

Source§

fn clone(&self) -> VqCodebook

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 VqCodebook

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, 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.