Struct HnswBuildParams

pub struct HnswBuildParams {
    pub max_level: u16,
    pub m: usize,
    pub ef_construction: usize,
    pub prefetch_distance: Option<usize>,
}

Parameters of building HNSW index

Fields

max_level: u16

max level ofm

m: usize

number of connections to establish while inserting new element

ef_construction: usize

size of the dynamic list for the candidates

prefetch_distance: Option<usize>

number of vectors ahead to prefetch while building the graph

Implementations

impl HnswBuildParams

pub fn max_level(self, max_level: u16) -> Self

The maximum level of the graph. The default value is 8.

pub fn num_edges(self, m: usize) -> Self

The number of connections to establish while inserting new element The default value is 30.

pub fn ef_construction(self, ef_construction: usize) -> Self

Number of candidates to be considered when searching for the nearest neighbors during the construction of the graph.

The default value is 100.

pub async fn build( self, data: ArrayRef, distance_type: DistanceType, ) -> Result<HNSW>

Build the HNSW index from the given data.

Parameters

• data: A FixedSizeList to build the HNSW.
• distance_type: The distance type to use.

Trait Implementations

impl Clone for HnswBuildParams

fn clone(&self) -> HnswBuildParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HnswBuildParams

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

Formats the value using the given formatter.

impl DeepSizeOf for HnswBuildParams

fn deep_size_of_children(&self, context: &mut Context) -> usize

Returns an estimation of the heap-managed storage of this object. This does not include the size of the object itself.

fn deep_size_of(&self) -> usize

Returns an estimation of a total size of memory owned by the object, including heap-managed storage.

impl Default for HnswBuildParams

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HnswBuildParams

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for HnswBuildParams

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.