BiEncoder

Struct BiEncoder 

Source
pub struct BiEncoder<F> { /* private fields */ }
Expand description

Bi-Encoder for efficient dense retrieval.

Encodes queries and documents separately, allowing pre-computation of document embeddings for fast retrieval.

§Architecture

Query  ─┬─> Encoder ─> Query Embedding  ─┐
        │                                 ├─> Similarity Score
Document ─> Encoder ─> Doc Embedding   ─┘

Implementations§

Source§

impl<F> BiEncoder<F>
where F: Fn(&[f32]) -> Vec<f32>,

Source

pub fn new(encode_fn: F, similarity: SimilarityMetric) -> Self

Create bi-encoder with custom encoding function.

Source

pub fn encode(&self, input: &[f32]) -> Vec<f32>

Encode a single input.

Source

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

Encode a batch of inputs.

Source

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

Compute similarity between two embeddings.

Source

pub fn retrieve<T: Clone>( &self, query: &[f32], corpus: &[(T, Vec<f32>)], top_k: usize, ) -> Vec<(T, f32)>

Retrieve top-k most similar documents.

Trait Implementations§

Source§

impl<F: Debug> Debug for BiEncoder<F>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<F> Freeze for BiEncoder<F>
where F: Freeze,

§

impl<F> RefUnwindSafe for BiEncoder<F>
where F: RefUnwindSafe,

§

impl<F> Send for BiEncoder<F>
where F: Send,

§

impl<F> Sync for BiEncoder<F>
where F: Sync,

§

impl<F> Unpin for BiEncoder<F>
where F: Unpin,

§

impl<F> UnwindSafe for BiEncoder<F>
where F: UnwindSafe,

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Into<U> for T
where U: From<T>,

§

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
§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

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

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