Skip to main content

SentenceEncoder

Struct SentenceEncoder 

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

Encodes sentences to fixed-length float vectors via word-embedding lookup and pooling.

Words not found in the vocabulary receive an OOV vector (all zeros by default, but they are excluded from mean pooling when all words in the sentence would otherwise be OOV — in that case a zero vector is returned).

Implementations§

Source§

impl SentenceEncoder

Source

pub fn new(vocab: &[String], config: SentenceEncoderConfig) -> Self

Create a SentenceEncoder with randomly initialised embeddings for every word in vocab.

Embeddings are initialised deterministically from a seeded LCG so that results are reproducible without importing any RNG crate.

Source

pub fn from_vectors( vectors: HashMap<String, Vec<f32>>, config: SentenceEncoderConfig, ) -> Self

Create a SentenceEncoder from a pre-built token-to-vector map.

All vectors must have the same length, which must equal config.embedding_dim. If the map is empty the encoder still works but will return zero vectors for every sentence.

Source

pub fn encode(&self, sentence: &str) -> Vec<f32>

Encode a single sentence to a fixed-length Vec<f32>.

The sentence is split on whitespace (after lower-casing). Tokens beyond max_seq_len are dropped. Words not found in the vocabulary are ignored (treated as if absent) in mean/weighted-mean pooling. For max pooling, missing words contribute a zero vector.

Source

pub fn encode_batch(&self, sentences: &[&str]) -> Vec<Vec<f32>>

Encode a batch of sentences.

Source

pub fn similarity(&self, a: &[f32], b: &[f32]) -> f32

Cosine similarity between two embedding vectors.

Returns a value in [-1.0, 1.0], or 0.0 when either vector has zero norm.

Source

pub fn most_similar<'a>( &self, query: &str, sentences: &[&'a str], top_k: usize, ) -> Vec<(&'a str, f32)>

Find the top_k sentences most similar to query (by cosine similarity), returned in descending similarity order.

Source

pub fn embedding_dim(&self) -> usize

Return the embedding dimensionality.

Source

pub fn embeddings_mut(&mut self) -> &mut HashMap<String, Vec<f32>>

Mutable access to the embeddings map for in-place updates.

Trait Implementations§

Source§

impl Debug for SentenceEncoder

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