-
Notifications
You must be signed in to change notification settings - Fork 140
Introduce jvector-apis module and status tracker #537
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
Open
jshook
wants to merge
6
commits into
main
Choose a base branch
from
jshook_apis
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Before you submit for review:
If you did not complete any of these, then please explain below. |
MarkWolters
reviewed
Oct 13, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great documentation, that is appreciated. Commented a few minor concerns but overall looks very strong
jvector-apis/src/main/java/io/github/jbellis/jvector/status/StatusContext.java
Outdated
Show resolved
Hide resolved
jvector-apis/src/main/java/io/github/jbellis/jvector/status/StatusContext.java
Outdated
Show resolved
Hide resolved
internal-apis/src/main/java/io/github/jbellis/jvector/status/StatusTracker.java
Show resolved
Hide resolved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
[Updates 10/15]:
With some first-user input from Mark and some other cleanups and improved docs, the core code is tighter, safer, and cleaner. There were several files added in test, specifically to make it easy to understand the usage patterns for implementing tracked tasks.
I believe that we should have living examples where we can, and that means they should be tested. If necessary, we can put a group tag on the "example" tests to bypass them conveniently except for release-level tests. For now, they are enabled for review here.
[Previously ...]
The status tracking module may have use in both prod and test code, but we wanted to isolate and manage it better as a separate module. For modules like this, I propose we use a jvector-apis module. This is where you would put new modular functionality, like the status tracking API, which may be used by multiple modules. There is a good primer on this in the README in the module root.
For the status tracking API, this is a new facility to allow us to collect and share the status of internal jobs that are being run by jvector. The first use of it will be to ease testing and baseline work around performance and accuracy for different vector spaces and indexing configurations. However, it does have some hooks which may be lightweight enough to instrument prod code with, and this is a separate concern not addressed specifically in this PR. For now, this merely introduces the status tracking API, which will be pulled into the dataset streaming work once when ready.
There is a substantial amount of testing included in this PR. The demo scaffolding is there as a test layer for improving the API and making sure it is ergonomic and non-invasive enough to be added to extant code. If necessary, we can gate the unit tests of this module with an optional test group, but I'd like to see how it works as is first.
There are a couple of unrelated cleanups in this PR as well, from previous commits by other committers, around mvn exec configs, logger and test dependency inclusions which were not intended. I've personally contacted these committers and verified their intent before removing the extra deps and configurations.