Initial cut for a cuVS Java API #450
Conversation
Co-authored-by: Vivek Narang <[email protected]>
|
FYI @cjnolet ^ |
cjnolet
added
improvement
|
/ok to test |
narangvivek10
force-pushed
the
java-api
branch
from
2cfab29
to
1597158
Compare
chatman
changed the title
|
@naramgvivek10 Let's move CuVSResources to the cuvs package instead of common? That way we can abstract out the internals of Panama out of sight of the users. |
|
/ok to test |
| @@ -459,6 +461,12 @@ if (( ${NUMARGS} == 0 )) || hasArg rust; then | |||
| cargo test | |||
| fi | |||
|
|
|||
| # Build the cuvs Java bindings | |||
| if (( ${NUMARGS} == 0 )) || hasArg java; then | |||
| cd ${REPODIR}/java | |||
There was a problem hiding this comment.
We should make this smart enough to automatically build libcuvs when the java arg is supplied. Just makes the overall experience better for users when they don't need to know all the ins and outs of the build in order to get a build from source.
| * JDK 22 | ||
| * Maven 3.9.6 or later | ||
|
|
||
| Please build libcuvs (`./build.sh libcuvs` from top level directory) before building the Java API with `./build.sh` from this directory. |
There was a problem hiding this comment.
As per comment above, I think we should mention this, but also mention that calling build.sh java from the top level will automatically build libcuvs.
java/cuvs-java/pom.xml
Outdated
| <manifest> | ||
| <addClasspath>true</addClasspath> | ||
| <mainClass> | ||
| com.nvidia.cuvs.ExampleApp</mainClass> |
There was a problem hiding this comment.
We have establiahed a convention of putting example apps in the examples subdirectory under the top-level repository. Can we please do that with Java as well? In additon to just showing how to use the APIs, those examples also demonstrate how a user would build and include cuvs artifacts in their applications.
| @@ -0,0 +1,352 @@ | |||
| /* | |||
| * Copyright (c) 2023-2024, NVIDIA CORPORATION. | |||
There was a problem hiding this comment.
All new files should only include the current year.
…eparate example project
…ent for data array
A Java API for cuVS for easy integration into Apache Lucene or other Java based projects.
Try:
For generating docs,
mvn javadoc:javadocPrerequisites:
Todo: