annoy-rs

Crates.ioannoy-rs
lib.rsannoy-rs
version0.1.0
sourcesrc
created_at2021-11-27 18:40:43.652227
updated_at2021-11-27 18:40:43.652227
descriptionA rust implementation of annoy(https://github.com/spotify/annoy) (Index serving only). Providing C api as well
homepage
repositoryhttps://github.com/hanabi1224/RuAnnoy
max_upload_size
id488518
size198,480
hanabi1224 (hanabi1224)

documentation

README

RuAnnoy

main travis MIT License

This library is a rust port of spotify/annoy , currently only index serving is supported.

It also provides FFI bindings for jvm, dotnet and dart

Metric Serve Build jvm Binding dotnet Binding dart Binding
Angular ✅ ❌ ✅ ✅ ✅
Euclidean ✅ ❌ ✅ ✅ ✅
Manhattan ✅ ❌ ✅ ✅ ✅
Dot ✅ ❌ ✅ ✅ ✅
Hamming ❌ ❌ ❌ ❌ ❌

Install via crates.io

Crates.io codecov

# Cargo.toml
[dependencies]
annoy-rs = "0"

Usage

use annoy_rs::*;

let index = AnnoyIndex::load(10, "index.ann", IndexType::Angular).unwrap();
let v0 = index.get_item_vector(0);
let nearest = index.get_nearest(v0.as_ref(), 5, -1, true);

FFI support

kotlin/java

It uses JNI bindings to rust crate and is ~5-10x faster than pure java implementation in benchmark scenario

Install via jitpack.io

Release

repositories {
  mavenCentral()
  maven { url 'https://jitpack.io' }
}
  
dependencies {
  implementation 'com.github.hanabi1224:RuAnnoy:<tag>'
}

Usage

val index = AnnoyIndex.tryLoad("index.5d.ann", 5, IndexType.Angular)

dotnet

Runtimes Nuget package
RuAnnoy NuGet version
RuAnnoy-Batteries-Windows-x64 NuGet version
RuAnnoy-Batteries-Linux-x64 NuGet version
RuAnnoy-Batteries-Darwin-x64 NuGet version

Install via nuget

  <ItemGroup>
    <PackageReference Include="RuAnnoy" Version="*" />
    <PackageReference Include="RuAnnoy-Batteries-Windows-x64" Version="*" />
  </ItemGroup>

Usage

var index = AnnoyIndex.Load("index.5d.ann", 5, IndexType.Angular);

dart

Install via pub.dev

# pubspec.yaml
dependencies:
  dart_native_annoy: ^0.1.0

Usage

import 'dart:ffi';
import 'package:dart_native_annoy/annoy.dart';

/// Creat factory from DynamicLibrary
final fac = AnnoyIndexFactory(lib: DynamicLibrary.open('libannoy_rs.so'));

/// Load index
final index = indexFactory.loadIndex(
      'index.euclidean.5d.ann', 5, IndexType.Euclidean)!;

print('size: ${index.size}');

final v3 = index.getItemVector(3);

final nearest = index.getNearest(v0, 5, includeDistance: true);

TODO

  • Index building support
  • CLI tool to build index from file
Commit count: 96

cargo fmt