Skip to main content

Codebook

Struct Codebook 

Source
pub struct Codebook {
    pub config: CodebookConfig,
    pub centroids: Vec<f32>,
    pub id: String,
    pub stats: CodebookStats,
}
Expand description

A codebook containing centroids for vector quantization

Fields§

§config: CodebookConfig

Configuration

§centroids: Vec<f32>

Centroid vectors [num_centroids × centroid_dim]

§id: String

Codebook identifier

§stats: CodebookStats

Training statistics

Implementations§

Source§

impl Codebook

Source

pub fn new(config: CodebookConfig, id: impl Into<String>) -> Self

Create a new codebook with random centroids

Source

pub fn from_centroids( config: CodebookConfig, centroids: Vec<f32>, id: impl Into<String>, ) -> Result<Self>

Create from existing centroids

Source

pub fn find_nearest(&self, vector: &[f32]) -> Result<(usize, f32)>

Find nearest centroid for a vector

Source

pub fn find_k_nearest( &self, vector: &[f32], k: usize, ) -> Result<Vec<(usize, f32)>>

Find K nearest centroids

Source

pub fn get_centroid(&self, index: usize) -> Option<&[f32]>

Get centroid by index

Source

pub fn encode_batch( &self, vectors: &[f32], vector_dim: usize, ) -> Result<Vec<u16>>

Encode a batch of vectors to indices

Source

pub fn decode_batch(&self, indices: &[u16]) -> Vec<f32>

Decode indices to vectors

Source

pub fn to_bytes(&self) -> Vec<u8> ⓘ

Serialize to bytes

Source

pub fn from_bytes(bytes: &[u8]) -> Result<Self>

Deserialize from bytes

Trait Implementations§

Source§

impl Clone for Codebook

Source§

fn clone(&self) -> Codebook

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 Codebook

Source§

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

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

impl<'de> Deserialize<'de> for Codebook

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Codebook

Source§

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

Serialize this value into the given Serde serializer. 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V