Skip to content

README.md

Latest commit

 

History

History
42 lines (24 loc) · 1.41 KB

README.md

File metadata and controls

42 lines (24 loc) · 1.41 KB

CuVS Java API

CuVS Java API provides a Java based simple, efficient, and a robust vector search API.

Caution

cuVS 25.02 contains an experimental version and updates to this API are expected in the coming release.

Prerequisites

Building

libcuvs libraries are needed for this API. If libcuvs libraries are already not built please do ./build.sh libcuvs java in the top level directory to build this API.

Alternatively, if libcuvs libraries are already built and you just want to build this API, please do ./build.sh java in the top level directory or just do ./build.sh in this directory.

⚠️ If you notice the tests failing please replace mvn verify with mvn clean package in the build.sh script found in this directory and try again. This should build the API (and skip the tests).

Examples

A few starter examples of CAGRA, HNSW, and Bruteforce index are provided in the examples directory.

Javadocs

To generate javadocs, in this directory (after building the API) please do:

cd cuvs-java && mvn javadoc:javadoc

The generated javadocs can be found in cuvs-java/target/apidocs