Skip to main content

EmbeddingCompressionCodec

Struct EmbeddingCompressionCodec 

Source
pub struct EmbeddingCompressionCodec { /* private fields */ }
Expand description

Codec for compressing dense embedding vectors.

Use register_codec to create named codec configurations, then call compress / decompress as needed.

Implementations§

Source§

impl EmbeddingCompressionCodec

Source

pub fn new() -> Self

Create a new codec with an empty registry.

Source

pub fn register_codec( &mut self, name: &str, method: EccMethod, bits: u8, block_size: usize, ) -> EccCodecId

Register a new codec and return its id.

bits must be 4, 8, or 16. block_size is used by PQ / HybridPQ.

Source

pub fn register_from_config(&mut self, config: &EccCodecConfig) -> EccCodecId

Register a codec from a full EccCodecConfig.

Source

pub fn get_spec(&self, id: EccCodecId) -> Option<&EccCodecSpec>

Look up a codec spec by id.

Source

pub fn codec_count(&self) -> usize

Return the number of registered codecs.

Source

pub fn compress( &mut self, codec_id: EccCodecId, embedding: &[f64], ) -> Result<EccCompressed, EccError>

Compress a single embedding vector using the specified codec.

Source

pub fn decompress( &self, compressed: &EccCompressed, ) -> Result<Vec<f64>, EccError>

Decompress a previously compressed payload.

Source

pub fn compress_batch( &mut self, codec_id: EccCodecId, embeddings: &[Vec<f64>], ) -> Vec<Result<EccCompressed, EccError>>

Compress a batch of embeddings with the same codec.

Source

pub fn decompress_batch( &self, batch: &[EccCompressed], ) -> Vec<Result<Vec<f64>, EccError>>

Decompress a batch of compressed payloads.

Source

pub fn reconstruction_error(original: &[f64], decompressed: &[f64]) -> f64

Compute mean squared error between original and decompressed vectors.

Source

pub fn estimate_ratio(&self, codec_id: EccCodecId, dim: usize) -> f64

Estimate the theoretical compression ratio for a given codec and vector dimension.

The estimate is based on the quantization bit-width and method overhead.

Source

pub fn codec_stats(&self) -> EccCodecStats

Compute aggregate statistics over the compression log.

Source

pub fn log_entries(&self) -> &VecDeque<EccCompressionRecord>

Return a read-only view of the compression log.

Trait Implementations§

Source§

impl Default for EmbeddingCompressionCodec

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more