Skip to main content

IndexOptimizer

Struct IndexOptimizer 

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

Hyperparameter search engine for ANN index configurations.

Collects benchmark observations and provides:

  • best-parameter selection for a given OptimizationTarget,
  • Pareto-front extraction in the recall–QPS plane,
  • a simple grid-expansion suggestion for the next candidate.

Implementations§

Source§

impl IndexOptimizer

Source

pub fn new(index_type: IndexType, target: OptimizationTarget) -> Self

Create a new optimiser for index_type that pursues target.

Source

pub fn add_benchmark(&mut self, point: BenchmarkPoint)

Record a new benchmark observation.

Source

pub fn benchmark_count(&self) -> usize

Number of recorded benchmark observations.

Source

pub fn best_params(&self) -> Option<&BenchmarkPoint>

Return the benchmark point with the highest score under the current target, or None if no benchmarks have been recorded.

Source

pub fn pareto_front(&self) -> Vec<&BenchmarkPoint>

Extract the Pareto-optimal front in the (recall_at_10, qps) plane.

A point a dominates b when a.recall_at_10 >= b.recall_at_10 and a.qps >= b.qps with at least one strict inequality. The returned vector contains only non-dominated points, sorted by descending recall.

Source

pub fn suggest_next_params(&self) -> Option<IndexParams>

Suggest the next parameter configuration to benchmark.

The strategy is a simple grid expansion: take the best observed configuration and propose a neighbouring point by incrementing the most impactful parameter by one step. Returns None when no benchmarks exist or the index type is Flat (no free parameters).

Source

pub fn index_type(&self) -> &IndexType

Reference to the index type being optimised.

Source

pub fn benchmarks(&self) -> &[BenchmarkPoint]

All recorded benchmark points.

Source

pub fn clear(&mut self)

Clear all recorded benchmarks (useful for re-runs).

Source

pub fn ranked_benchmarks(&self) -> Vec<&BenchmarkPoint>

Return all benchmarks sorted by score under the current target (descending).

Source

pub fn score_of(&self, point: &BenchmarkPoint) -> f64

Return the score of the given benchmark point under the current target.

Source

pub fn filter_by_recall(&self, min_recall: f64) -> Vec<&BenchmarkPoint>

Return benchmarks that achieve at least min_recall recall@10.

Source

pub fn filter_by_qps(&self, min_qps: f64) -> Vec<&BenchmarkPoint>

Return benchmarks that achieve at least min_qps queries per second.

Source

pub fn recall_stats(&self) -> Option<RecallStats>

Compute summary statistics (min/max/mean) over recall@10 values.

Source

pub fn group_by_variant(&self) -> HashMap<&'static str, Vec<&BenchmarkPoint>>

Group benchmarks by their parameter variant (Hnsw vs Ivf).

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

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> ErasedDestructor for T
where T: 'static,