Skip to main content

SparseEmbed

Struct SparseEmbed 

Source
pub struct SparseEmbed {
    pub indices: Vec<u32>,
    pub values: Vec<f32>,
    pub vocab_id: String,
}
Expand description

A sparse embedding over a fixed vocabulary.

indices MUST be strictly ascending; values MUST have the same length as indices. Both invariants are checked by Self::new and enforced on deserialise in a future CBOR round-trip test. vocab_id pins the model family so two adapters with different vocabs never fuse posting lists; compare as a string (e.g. "bert-base-uncased@30522").

Fields§

§indices: Vec<u32>

Token IDs in the vocabulary, strictly ascending.

§values: Vec<f32>

Non-zero weights, aligned with indices.

§vocab_id: String

Vocabulary identifier.

Implementations§

Source§

impl SparseEmbed

Source

pub fn new( indices: Vec<u32>, values: Vec<f32>, vocab_id: impl Into<String>, ) -> Result<Self, SparseError>

Construct a SparseEmbed. Panics (debug) / errors (release) if the invariants are violated. indices is taken as-is; if the caller is unsure whether it is sorted, use Self::from_unsorted instead.

§Errors
  • SparseError::Config if indices.len() != values.len() or indices contains duplicates / non-ascending entries.
Source

pub fn from_unsorted( pairs: impl IntoIterator<Item = (u32, f32)>, vocab_id: impl Into<String>, ) -> Self

Construct from an unsorted (index, value) pair list. Duplicate indices are kept as the maximum value (SPLADE’s own pooling rule). Useful from ONNX-side decoders that produce vectors in token-emission order.

Source

pub const fn nnz(&self) -> usize

Number of non-zero entries.

Source

pub fn dot(&self, other: &Self) -> Option<f32>

Dot product with another sparse embedding (must share vocab_id). Returns None if the vocab_ids differ.

Trait Implementations§

Source§

impl Clone for SparseEmbed

Source§

fn clone(&self) -> SparseEmbed

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SparseEmbed

Source§

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

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

impl<'de> Deserialize<'de> for SparseEmbed

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 PartialEq for SparseEmbed

Source§

fn eq(&self, other: &SparseEmbed) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for SparseEmbed

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

impl StructuralPartialEq for SparseEmbed

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> 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> Same for T

Source§

type Output = T

Should always be Self
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.
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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,