Skip to main content

RetrievalEngine

Struct RetrievalEngine 

Source
pub struct RetrievalEngine<B: Backend> { /* private fields */ }
Expand description

Cross-modal retrieval engine.

Pre-computes embeddings for an indexed database of sensor recordings and/or text captions and enables fast nearest-neighbour search.

Implementations§

Source§

impl<B: Backend> RetrievalEngine<B>

Source

pub fn new(model: SensorLMModel<B>) -> Self

Create a new retrieval engine.

Source

pub fn index_sensor( &mut self, sensor_batches: impl IntoIterator<Item = Tensor<B, 3>>, )

Pre-compute and store sensor embeddings from a batch of sensor data.

§Arguments
  • sensor_batches – Iterator of (B, T, C) sensor tensors.
Source

pub fn index_text( &mut self, text_batches: impl IntoIterator<Item = (Tensor<B, 2, Int>, Tensor<B, 2, Int>)>, )

Pre-compute and store text embeddings from batches of token sequences.

Source

pub fn sensor_to_text( &self, query_sensor: Tensor<B, 3>, top_k: usize, ) -> Vec<Vec<RetrievalResult>>

Retrieve the top-k most similar texts for each sensor query.

§Arguments
  • query_sensor(Q, T, C) query sensor tensors.
  • top_k – Number of results to return per query.
§Returns

A vector of Q lists, each containing top_k RetrievalResults sorted by descending similarity.

§Panics

Panics if no text embeddings have been indexed.

Source

pub fn text_to_sensor( &self, query_ids: Tensor<B, 2, Int>, query_mask: Tensor<B, 2, Int>, top_k: usize, ) -> Vec<Vec<RetrievalResult>>

Retrieve the top-k most similar sensor recordings for each text query.

§Panics

Panics if no sensor embeddings have been indexed.

Source

pub fn evaluate_recall( &self, sensor: Tensor<B, 3>, ids: Tensor<B, 2, Int>, mask: Tensor<B, 2, Int>, k: usize, ) -> (f32, f32)

Evaluate Recall@k on a paired (sensor, text) evaluation set.

Assumes ground truth is the diagonal: sensor i corresponds to text i.

§Arguments
  • sensor(N, T, C) evaluation sensor data.
  • ids(N, L) token IDs.
  • mask(N, L) attention mask.
  • k – Recall@k.

Auto Trait Implementations§

§

impl<B> !Freeze for RetrievalEngine<B>

§

impl<B> !RefUnwindSafe for RetrievalEngine<B>

§

impl<B> Send for RetrievalEngine<B>

§

impl<B> !Sync for RetrievalEngine<B>

§

impl<B> Unpin for RetrievalEngine<B>

§

impl<B> UnsafeUnpin for RetrievalEngine<B>

§

impl<B> UnwindSafe for RetrievalEngine<B>

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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

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