Skip to main content

SearchKnobs

Struct SearchKnobs 

Source
pub struct SearchKnobs {
    pub prefetch: u8,
    pub batch_est: bool,
    pub frontier: f32,
    pub block_screen: bool,
}
Expand description

Runtime knobs of the search loop, each off by default so that the results are those of the plain search. VGraph::searcher reads them once per process from the environment (SearchKnobs::from_env); VGraph::searcher_with takes them explicitly.

Mechanisms, and what they may change:

  • prefetch (HMS_QGRAPH_PREFETCH, 0..=3, results never change): 0 prefetches the next candidate’s neighbour list and the code row of every admitted neighbour; 1 adds the admitted neighbours’ scales and the rows the re-rank reads; 2 adds the neighbour list of the second-nearest unexpanded candidate; 3 adds a lookahead that, after an expansion, prefetches the code rows (or screen rows) of the next candidate’s unvisited neighbours.
  • batch_est (HMS_QGRAPH_BATCH_EST, results never change): the admitted neighbours’ 4-bit rows are estimated four at a time with shared query loads (dot_i4_inline_x4 in the kernels module); the integer sums are the same.
  • frontier (HMS_QGRAPH_FRONTIER, 0.0..=1.0, 1.0 = off): with a full pool, stop when the nearest unexpanded estimate is past the point frontier of the way from the k-th best to the ef-th best. Fewer expansions, so lower recall at a given ef; the recall/QPS curve over ef is what to compare.
  • block_screen (HMS_QGRAPH_BLOCK_SCREEN, needs VGraph::with_blocks): the neighbour block screens instead of ordering; survivors fetch their code row and the pool holds row estimates, as in the plain search. A fresh neighbour is skipped when its block estimate, improved by screen_sigmas deviations of the calibrated edge error, could not enter the full pool. Off, the block search is the existing one.

Fields§

§prefetch: u8

Prefetch depth, 0 to 3 (values above 3 act as 3).

§batch_est: bool

Estimate admitted neighbours four rows at a time.

§frontier: f32

Frontier stop fraction in 0.0..=1.0; 1.0 (or a non-finite value) is off.

§block_screen: bool

Screen with the neighbour blocks and estimate survivors from their rows.

Implementations§

Source§

impl SearchKnobs

Source

pub const OFF: Self

Every knob off: the plain search.

Source

pub fn from_env() -> Self

The knobs set in the environment, read once per process; unset or invalid values (reported once) take the SearchKnobs::OFF value.

Trait Implementations§

Source§

impl Clone for SearchKnobs

Source§

fn clone(&self) -> SearchKnobs

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for SearchKnobs

Source§

impl Debug for SearchKnobs

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SearchKnobs

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for SearchKnobs

Source§

fn eq(&self, other: &SearchKnobs) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SearchKnobs

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more