Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hanabi1224/ruannoy
Rust port of annoy (https://github.com/spotify/annoy)
https://github.com/hanabi1224/ruannoy
annoy approximate-nearest-neighbor-search dotnet java kotlin nearest-neighbor-search rust
Last synced: 2 days ago
JSON representation
Rust port of annoy (https://github.com/spotify/annoy)
- Host: GitHub
- URL: https://github.com/hanabi1224/ruannoy
- Owner: hanabi1224
- License: mit
- Created: 2018-06-19T05:57:09.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-04T04:35:18.000Z (2 months ago)
- Last Synced: 2024-11-02T17:39:46.670Z (14 days ago)
- Topics: annoy, approximate-nearest-neighbor-search, dotnet, java, kotlin, nearest-neighbor-search, rust
- Language: Rust
- Homepage:
- Size: 10.9 MB
- Stars: 40
- Watchers: 2
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RuAnnoy
[](https://github.com/hanabi1224/RuAnnoy/actions/workflows/main.yml)
[](https://github.com/hanabi1224/RuAnnoy/blob/master/LICENSE)
========
This library is a rust port of [spotify/annoy](https://github.com/spotify/annoy) , currently only index serving is supported.
A live demo using web assembly is available at https://annoy-web-demo.vercel.app/
It also provides [FFI bindings](https://github.com/hanabi1224/RuAnnoy#ffi-support) for [jvm](https://github.com/hanabi1224/RuAnnoy#kotlinjava), [dotnet](https://github.com/hanabi1224/RuAnnoy#dotnet) and [dart](https://github.com/hanabi1224/RuAnnoy#dart)
| Metric | Serve | Build | jvm binding | dotnet binding | dart binding | WASM support |
| :-------- | :---: | ----: | ----------- | -------------- | ------------ | ------------ |
| Angular | ✅ | ❌ | ✅ | ✅ | ✅ | ✅ |
| Euclidean | ✅ | ❌ | ✅ | ✅ | ✅ | ✅ |
| Manhattan | ✅ | ❌ | ✅ | ✅ | ✅ | ✅ |
| Dot | ✅ | ❌ | ✅ | ✅ | ✅ | ✅ |
| Hamming | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |
### Install via [crates.io](https://crates.io/crates/annoy-rs)
[](https://crates.io/crates/annoy-rs)
[](https://codecov.io/gh/hanabi1224/RuAnnoy)
[](https://deps.rs/repo/github/hanabi1224/RuAnnoy)
```toml
# Cargo.toml
[dependencies]
annoy-rs = "0.1"
```
### Usage
```rust
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);
```
## SIMD support
SIMD is supported via [`std::simd`](https://doc.rust-lang.org/nightly/std/simd/index.html) on nightly rust. Note that avx intrinsics need to be enabled explicitly by setting your cpu features in `RUSTFLAGS` environment variable.
```bash
RUSTFLAGS="-Ctarget-feature=+avx" cargo +nightly build --release
# or
RUSTFLAGS="-Ctarget-cpu=native" cargo +nightly build --release
```
## WASM support
Install [wasm-pack](https://rustwasm.github.io/wasm-pack/installer/)
```bash
wasm-pack build
wasm-pack test --node
```
simd128 is supported in chrome by default.
To enable simd128, build with below command
```bash
RUSTFLAGS="-Ctarget-feature=+simd128" cargo +nightly build --release --target wasm32-unknown-unknown
```
An example site is deployed at https://annoy-web-demo.vercel.app/
Source code is under [example/web](https://github.com/hanabi1224/RuAnnoy/tree/master/example/web)
## FFI support
### kotlin/java
It uses JNI bindings to rust crate and is ~5-10x faster than [pure java implementation](https://github.com/spotify/annoy-java) in [benchmark scenario](https://github.com/hanabi1224/RuAnnoy/tree/master/bench)
Note that the prebuilt dynamically linked libraries are built with simd support, avx cpu feature is required.
#### Install via [jitpack.io](https://jitpack.io/#hanabi1224/RuAnnoy)
[](https://jitpack.io/#hanabi1224/RuAnnoy)
```gradle
repositories {
mavenCentral()
maven { url 'https://jitpack.io' }
}
dependencies {
implementation 'com.github.hanabi1224:RuAnnoy:'
}
```
#### Usage
```kotlin
val index = AnnoyIndex.tryLoad("index.5d.ann", 5, IndexType.Angular)
```
### dotnet
| Runtimes | Nuget package |
| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| RuAnnoy | [](https://www.nuget.org/packages/RuAnnoy) |
| RuAnnoy-Batteries-Windows-x64 | [](https://www.nuget.org/packages/RuAnnoy-Batteries-Windows-x64) |
| RuAnnoy-Batteries-Linux-x64 | [](https://www.nuget.org/packages/RuAnnoy-Batteries-Linux-x64) |
| RuAnnoy-Batteries-Darwin-x64 | [](https://www.nuget.org/packages/RuAnnoy-Batteries-Darwin-x64) |
#### Install via nuget
```xml
```
#### Usage
```csharp
var index = AnnoyIndex.Load("index.5d.ann", 5, IndexType.Angular);
```
### dart
#### Install via [pub.dev](https://pub.dev/packages/dart_native_annoy)
```yaml
# pubspec.yaml
dependencies:
dart_native_annoy: ^0.1.0
```
#### Usage
```dart
import 'dart:ffi';
import 'package:dart_native_annoy/annoy.dart';
/// Creat factory from DynamicLibrary
final indexFactory = AnnoyIndexFactory(lib: DynamicLibrary.open('libannoy_rs_ffi.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