Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial cut for a cuVS Java API #450

Open
wants to merge 59 commits into
base: branch-25.02
Choose a base branch
from

Conversation

chatman
Copy link

@chatman chatman commented Nov 8, 2024

A Java API for cuVS for easy integration into Apache Lucene or other Java based projects.

Try:

./build.sh libcuvs
./build.sh java

For generating docs, mvn javadoc:javadoc

Prerequisites:

  • JDK 22
  • Maven 3.9.6+

Todo:

  • Generate project panama classes using jextract on every build
  • Algorithms other than Cagra
  • Prefiltering in cagra

Co-authored-by: Vivek Narang <[email protected]>
@chatman chatman requested review from a team as code owners November 8, 2024 14:05
@chatman chatman requested a review from msarahan November 8, 2024 14:05
Copy link

copy-pr-bot bot commented Nov 8, 2024

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@github-actions github-actions bot added the CMake label Nov 8, 2024
@chatman
Copy link
Author

chatman commented Nov 8, 2024

FYI @cjnolet ^
An ExampleApp.java is added as a starting point for the review.

@cjnolet cjnolet added improvement Improves an existing functionality non-breaking Introduces a non-breaking change labels Nov 8, 2024
@cjnolet cjnolet changed the base branch from branch-24.10 to branch-24.12 November 8, 2024 16:06
@cjnolet
Copy link
Member

cjnolet commented Nov 8, 2024

/ok to test

@chatman chatman changed the title [WIP] Initial cut for a cuVS Java API Initial cut for a cuVS Java API Nov 18, 2024
@chatman
Copy link
Author

chatman commented Nov 18, 2024

@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.

narangvivek10 and others added 13 commits December 13, 2024 13:28
… etc. (#6)

* Ability to configure CAGRA compression parameters
* Enabling indexing threads
* Enabling RMM pool resource configuration
* Bug fixes for wrong values passed in index and search parameters
* Deallocation of resources using Autoclosable
* Including a randomized test

Co-authored-by: Vivek Narang <[email protected]>
Co-authored-by: Ishan Chattopadhyaya <[email protected]>
Co-authored-by: Puneet Ahuja <[email protected]>
* Bruteforce API implementation

Co-authored-by: Vivek Narang <[email protected]>
* Bruteforce serialize and deserialize API implementation

Co-authored-by: Vivek Narang <[email protected]>
* code updates for the added index parameter

Co-authored-by: Vivek Narang <[email protected]>
Co-authored-by: Vivek Narang <[email protected]>
* move prefilter from index to query

Co-authored-by: Vivek Narang <[email protected]>
Co-authored-by: Vivek Narang <[email protected]>
@chatman chatman requested a review from a team as a code owner January 6, 2025 15:16
@github-actions github-actions bot added the cpp label Jan 6, 2025
narangvivek10 and others added 3 commits January 7, 2025 09:29
* review updates
---------
Co-authored-by: Vivek Narang <[email protected]>
@cjnolet
Copy link
Member

cjnolet commented Jan 8, 2025

/ok to test

@cjnolet
Copy link
Member

cjnolet commented Jan 15, 2025

/ok to test

java/build.sh Outdated
@@ -0,0 +1,10 @@
VERSION="25.02"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make sure this version gets updated when ci/release/update_versions.sh is called.

@@ -0,0 +1,354 @@
/*
* Copyright (c) 2025, NVIDIA CORPORATION.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a small nitpick: I notice this file is prefixed with "CuVS" while most of the other files are prefixed with "Cuvs". I personally prefer "CuVS" (or even "cuVS" if that doesn't break convention too badly) but I would at least make it consistent.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this note. I will fix this soon.

private MethodHandle searchMethodHandle;
private MethodHandle destroyIndexMethodHandle;
private MethodHandle serializeMethodHandle;
private MethodHandle deserializeMethodHandle;

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we make these MethodHandles static final - since they optimise much nicer by the JVM? I'm happy to rework some of the code flow here, if possible (and it that would be helpful) - though I'm not overly familiar with the development environment.

* update ci release script to update the version in build.sh
* class name updates
---------
Co-authored-by: Vivek Narang <[email protected]>
@narangvivek10 narangvivek10 requested a review from a team as a code owner January 22, 2025 22:29
@github-actions github-actions bot added the ci label Jan 22, 2025
Co-authored-by: Vivek Narang <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci CMake cpp improvement Improves an existing functionality non-breaking Introduces a non-breaking change
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

4 participants