Struct VqCodebook 

pub struct VqCodebook<B: Backend> { /* private fields */ }

VQ Semantic Codebook for dequantizing semantic token indices.

Uses EMA (Exponential Moving Average) codebook: the embedding for each entry is embedding_sum / cluster_usage. This normalizes accumulated embeddings by how often each codebook entry was used during training.

Pre-normalizes embeddings to CPU cache at construction to avoid GPU readback during dequantize() (required for WASM compatibility).

Implementations

impl<B: Backend> VqCodebook<B>

pub fn new( embedding_sum: Tensor<B, 2>, cluster_usage: Tensor<B, 1>, cpu_normalized: Vec<f32>, ) -> Self

Create VQ codebook from loaded tensors and pre-computed CPU cache.

Use Self::precompute_normalized to build the CPU cache from raw f32 slices (before uploading to GPU) to avoid GPU readback.

pub fn precompute_normalized( embed_vals: &[f32], usage_vals: &[f32], n_entries: usize, embed_dim: usize, ) -> Vec<f32>

Pre-compute normalized embeddings from raw f32 slices.

Call this on CPU-side data BEFORE constructing tensors, to avoid any GPU readback (required for WASM compatibility).

pub fn from_safetensors( safetensors: &SafeTensors<'_>, device: &B::Device, ) -> Result<Self>

Load VQ codebook from SafeTensors.

Expects:

• audio_tokenizer.quantizer.semantic_codebook.embedding_sum [8192, 256]
• audio_tokenizer.quantizer.semantic_codebook.cluster_usage [8192]

pub fn dequantize(&self, indices: &[usize]) -> Tensor<B, 2>

Dequantize a batch of semantic token indices to embedding vectors.

Arguments

• indices - Semantic token indices, each in [0, 8191]. Shape: [N]

Returns

Embedding vectors [N, 256], normalized by cluster usage.

pub fn dequantize_one(&self, index: usize) -> Tensor<B, 2>

Dequantize a single semantic token index.

Arguments

• index - Semantic token index in [0, 8191]

Returns

Embedding vector [1, 256], normalized by cluster usage.

Trait Implementations

impl<B> AutodiffModule<B> for VqCodebook<B>

where B: AutodiffBackend + Backend, <B as AutodiffBackend>::InnerBackend: Backend,

type InnerModule = VqCodebook<<B as AutodiffBackend>::InnerBackend>

Inner module without auto-differentiation.

fn valid(&self) -> Self::InnerModule

Get the same module, but on the inner backend without auto-differentiation.

impl<B: Backend> Clone for VqCodebook<B>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<B: Debug + Backend> Debug for VqCodebook<B>

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

Formats the value using the given formatter.

impl<B: Backend> Display for VqCodebook<B>

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

Formats the value using the given formatter.

impl<B: Backend> Module<B> for VqCodebook<B>

type Record = VqCodebookRecord<B>

Type to save and load the module.

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

Load the module state from a record.

fn into_record(self) -> Self::Record

Convert the module into a record containing the state.

fn num_params(&self) -> usize

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

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

Visit each tensor parameter in the module with a visitor.

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

Map each tensor parameter in the module with a mapper.

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

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

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

Move the module and all of its sub-modules to the given device.

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

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

fn devices(&self) -> Vec<<B as Backend>::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.

fn save_file<FR, PB>( self, file_path: PB, recorder: &FR, ) -> Result<(), RecorderError>

where FR: FileRecorder<B>, PB: Into<PathBuf>,

Save the module to a file using the provided file recorder.

fn load_file<FR, PB>( self, file_path: PB, recorder: &FR, device: &<B as Backend>::Device, ) -> Result<Self, RecorderError>

where FR: FileRecorder<B>, PB: Into<PathBuf>,

Load the module from a file using the provided file recorder.

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

Quantize the weights of the module.

impl<B: Backend> ModuleDisplay for VqCodebook<B>

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

Formats the module with provided display settings.

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

Custom display settings for the module.

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

Custom attributes for the module.

impl<B: Backend> ModuleDisplayDefault for VqCodebook<B>

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

Attributes of the module used for display purposes.

fn num_params(&self) -> usize

Gets the number of the parameters of the module.