annoy4s

License	Apache-2.0
Categories	Net
GroupId	net.pishen
ArtifactId	annoy4s_2.12
Last Version	0.10.0
Release Date	Apr 8, 2021
Type	jar
Description	annoy4s annoy4s
Project URL	https://github.com/annoy4s/annoy4s
Project Organization	net.pishen
Source Code Management	https://github.com/annoy4s/annoy4s.git

Download annoy4s_2.12

Filename	Size
annoy4s_2.12-0.10.0.pom
annoy4s_2.12-0.10.0.jar	164 KB
annoy4s_2.12-0.10.0-sources.jar	139 KB
annoy4s_2.12-0.10.0-javadoc.jar	1 MB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/net.pishen/annoy4s_2.12/ -->
<dependency>
    <groupId>net.pishen</groupId>
    <artifactId>annoy4s_2.12</artifactId>
    <version>0.10.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/net.pishen/annoy4s_2.12/
implementation 'net.pishen:annoy4s_2.12:0.10.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/net.pishen/annoy4s_2.12/
implementation ("net.pishen:annoy4s_2.12:0.10.0")

Apache Buildr

'net.pishen:annoy4s_2.12:jar:0.10.0'

Apache Ivy

<dependency org="net.pishen" name="annoy4s_2.12" rev="0.10.0">
  <artifact name="annoy4s_2.12" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='net.pishen', module='annoy4s_2.12', version='0.10.0')
)

Scala SBT

libraryDependencies += "net.pishen" % "annoy4s_2.12" % "0.10.0"

Leiningen

[net.pishen/annoy4s_2.12 "0.10.0"]

Dependencies

compile (3)

Group / Artifact	Type	Version
org.scala-lang : scala-library	jar	2.12.10
com.github.pathikrit : better-files_2.12	jar	3.8.0
net.java.dev.jna : jna	jar	5.4.0

test (1)

Group / Artifact	Type	Version
org.scalatest : scalatest_2.12	jar	3.0.8

Project Modules

There are no modules declared in this project.

annoy4s

A JNA wrapper around spotify/annoy which calls the C++ library of annoy directly from Scala/JVM.

Installation

For linux-x86-64 or Mac users, just add the library directly as:

libraryDependencies += "net.pishen" %% "annoy4s" % "0.10.0"

If you meet an error like below when using annoy4s, you may have to compile the native library by yourself.

java.lang.UnsatisfiedLinkError: Unable to load library 'annoy': Native library

To compile the native library and install annoy4s on local machine:

1. Clone this repository.
2. Check the values of organization and version in build.sbt, you may change it to the value you want, it's recommended to let version have the -SNAPSHOT suffix.
3. Run compileNative in sbt (Note that g++ installation is required).
4. Run test in sbt to see if the native library is successfully compiled.
5. Run publishLocal in sbt to install annoy4s on your machine.

Now you can add the library dependency as (organization and version may be different according to your settings):

libraryDependencies += "net.pishen" %% "annoy4s" % "0.10.0-SNAPSHOT"

The library file generated by the g++ command in compileNative can also be installed independently on your machine. Please reference to library search paths for more details on how to make JNA able to load the library.

Usage

Create and query the index in memory mode:

import annoy4s._

val annoy = Annoy.create[Int]("./input_vectors", numOfTrees = 10, metric = Euclidean, verbose = true)

val result: Option[Seq[(Int, Float)]] = annoy.query(itemId, maxReturnSize = 30)

• The format of ./input_vectors is <item id> <vector> for each line, here is an example:

3 0.2 -1.5 0.3
5 0.4 0.01 -0.5
0 1.1 0.9 -0.1
2 1.2 0.8 0.2

• <item id> could be Int, Long, String, or UUID, just change the type parameter at Annoy.create[T]. You can also implement a KeyConverter[T] by yourself to support your own type.
• metric could be Euclidean, Angular, Manhattan or Hamming.
• result is a tuple list of id and distances, where the query item is itself contained.

To use the index in disk mode, one need to provide an outputDir:

val annoy = Annoy.create[Int]("./input_vectors", 10, outputDir = "./annoy_result/", Euclidean)

val result: Option[Seq[(Int, Float)]] = annoy.query(itemId, maxReturnSize = 30)

annoy.close()

// load an created index
val reloadedAnnoy = Annoy.load[Int]("./annoy_result/")

val reloadedResult: Option[Seq[(Int, Float)]] = reloadedAnnoy.query(itemId, 30)

Versions

Version
0.10.0 Apr 8, 2021
0.9.0 Sep 13, 2019
0.8.0 Dec 13, 2018
0.7.0 Sep 20, 2018
0.6.0 Jan 25, 2018
0.5.0 Aug 5, 2017