instant-distance

Fast minimal implementation of HNSW maps for approximate nearest neighbors searches

11 unstable releases

0.6.1 Jun 26, 2023
0.6.0 Aug 1, 2022
0.5.1 Mar 28, 2022
0.5.0 May 20, 2021
0.1.3 Feb 17, 2021
Download history 203/week @ 2024-06-17 105/week @ 2024-06-24 185/week @ 2024-07-01 245/week @ 2024-07-08 192/week @ 2024-07-15 74/week @ 2024-07-22 146/week @ 2024-07-29 174/week @ 2024-08-05 82/week @ 2024-08-12 72/week @ 2024-08-19 199/week @ 2024-08-26 166/week @ 2024-09-02 286/week @ 2024-09-09 271/week @ 2024-09-16 246/week @ 2024-09-23 164/week @ 2024-09-30

980 downloads per month
Used in 2 crates

MIT/Apache

37KB
826 lines

Cover logo

Instant Distance: fast HNSW indexing

Build status License: MIT License: Apache 2.0

Instance Distance is a fast pure-Rust implementation of the Hierarchical Navigable Small Worlds paper by Malkov and Yashunin for finding approximate nearest neighbors. This implementation powers the InstantDomainSearch.com backend services used for word vector indexing.

What it does

Instant Distance is an implementation of a fast approximate nearest neighbor search algorithm. The algorithm is used to find the closest point(s) to a given point in a set. As one example, it can be used to make simple translations.

Using the library

Rust

[dependencies]
instant-distance = "0.5.0"

Example

use instant_distance::{Builder, Search};

fn main() {
    let points = vec![Point(255, 0, 0), Point(0, 255, 0), Point(0, 0, 255)];
    let values = vec!["red", "green", "blue"];

    let map = Builder::default().build(points, values);
    let mut search = Search::default();

    let cambridge_blue = Point(163, 193, 173);

    let closest_point = map.search(&cambridge_blue, &mut search).next().unwrap();

    println!("{:?}", closest_point.value);
}

#[derive(Clone, Copy, Debug)]
struct Point(isize, isize, isize);

impl instant_distance::Point for Point {
    fn distance(&self, other: &Self) -> f32 {
        // Euclidean distance metric
        (((self.0 - other.0).pow(2) + (self.1 - other.1).pow(2) + (self.2 - other.2).pow(2)) as f32)
            .sqrt()
    }
}

Testing

Rust:

cargo t -p instant-distance --all-features

Python:

make test-python

Dependencies

~2–9.5MB
~93K SLoC