Skip to main content

MaxSimReranker

Struct MaxSimReranker 

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

MaxSim between the query’s token matrix and each candidate’s document, read from the source of the candidate’s corpus.

Every source must carry the same representation and score semantics, so scores from different corpora share one scale; the reranker requires its query feature to carry that representation, so vectors from a different encoder are refused before anything is fetched. Each rerank takes one view of every source, and a candidate its source’s view does not hold is unscored.

Implementations§

Source§

impl MaxSimReranker

Source

pub fn new( sources: impl IntoIterator<Item = Arc<dyn MultiVectorSource>>, feature: impl Into<String>, ) -> Result<Self>

Sources must be for distinct corpora.

Examples found in repository?
examples/stored_maxsim.rs (line 96)
76fn main() -> Result<()> {
77    let representation = Representation::new("toy-encoder", "1", DIMENSION, true)?;
78    let directory = std::env::temp_dir().join(format!("lateweave-example-{}", std::process::id()));
79    let path = directory.join("vectors");
80
81    // The indexing side: one token per word, the axis standing in for what
82    // a real encoder produces.
83    let mut writer =
84        VectorStoreWriter::create(&path, Encoding::Float32, "fruit", representation.clone())?;
85    let embeddings = [unit(0), unit(2), unit(1), unit(2), unit(0), unit(3)].concat();
86    writer.append(["a", "b", "c"], &embeddings, DIMENSION, &[2, 2, 2], None)?;
87    writer.commit()?;
88
89    // The serving side.
90    let gatherer = TermGatherer {
91        requires: BTreeMap::new(),
92        documents: vec![("a", "red apple"), ("b", "green apple"), ("c", "red car")],
93        indexed_at: SystemTime::now(),
94    };
95    let store = Arc::new(VectorStore::open(&path)?) as Arc<dyn MultiVectorSource>;
96    let reranker = MaxSimReranker::new([store], DEFAULT_FEATURE)?;
97    let pipeline = SearchPipeline::new(Arc::new(gatherer), Some(Arc::new(reranker)));
98
99    let query = Query::new("apple").with_feature(
100        DEFAULT_FEATURE,
101        Feature::lazy(representation, || {
102            TokenMatrix::new(unit(1).to_vec(), DIMENSION)
103        }),
104    );
105    let request = SearchRequest::new(10, 2).with_budget(ResourceBudget::new(4096, 64, Some(1))?);
106
107    let print = |label: &str| -> Result<()> {
108        let result = pipeline.search(&query, &request)?;
109        println!("{label}:");
110        for document in &result.documents {
111            println!(
112                "  #{} {:?} score {}",
113                document.rank, document.key, document.score
114            );
115        }
116        println!("  {:?}", result.diagnostics);
117        Ok(())
118    };
119    print("before the delete")?;
120
121    // The indexing side deletes "b" from the vectors; the gatherer still
122    // finds it, and the pipeline drops it.
123    writer.delete(["b"]);
124    writer.commit()?;
125    print("after the delete")?;
126
127    std::fs::remove_dir_all(directory)?;
128    Ok(())
129}
Source

pub fn feature(&self) -> &str

Trait Implementations§

Source§

impl Reranker for MaxSimReranker

Source§

fn requires(&self) -> &Requirements

Source§

fn score_semantics(&self) -> &str

Source§

fn rerank( &self, query: &Query, candidates: &[Candidate], budget: &ResourceBudget, ) -> Result<Scored>

Source§

fn name(&self) -> &str

Reported in search diagnostics.

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.