Skip to content

Add API handlers and API Docker image #43

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

Merged
merged 3 commits into from
Apr 4, 2025

Conversation

rchitale7
Copy link
Member

Description

Initial implementation of Remote Vector Index Builder API handlers. The API handler is a Docker image, built from the base Core image. It contains the out the box functionality to integrate Faiss GPU accelerated index building with the k-NN vector engine.

Issues Resolved

Closes #42

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@rchitale7 rchitale7 self-assigned this Mar 28, 2025
@rchitale7 rchitale7 marked this pull request as ready for review March 28, 2025 15:38
@Rajrahane
Copy link
Member

One comment with memory management.
I understand memory allocations are rounded up to nearest boundary, of say 256 bytes
using floats for multiplications would work, but we'll have to round up to the nearest boundary, and subtract that value from the total_memory used.

We might end up subtracting less and an incorrect request acceptance by the request queue would throw an out of memory error during the index build process

@rchitale7
Copy link
Member Author

The memory estimations are already pretty rough - the formula we're using in calculate_memory_requirements isn't actually accurate. Improving the accuracy of memory calculations, along with more robust request store management features, should be taken as follow up issues/PRs, in my opinion.

…y, and prevent eviction of in progress tasks

Signed-off-by: Rohan Chitale <[email protected]>
Signed-off-by: Rohan Chitale <[email protected]>
@rchitale7
Copy link
Member Author

Will add instructions for how to configure and run the API handler once this PR #46 is merged. Basically, i will condense whats talked about here opensearch-project/k-NN#2545 into easy to read instructions

Copy link
Collaborator

@jed326 jed326 left a comment

Choose a reason for hiding this comment

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

I will make a second pass on the tests later, but the source code LGTM so approving

Copy link
Member

@Rajrahane Rajrahane left a comment

Choose a reason for hiding this comment

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

LGTM

@rchitale7 rchitale7 merged commit a4fa6f7 into opensearch-project:main Apr 4, 2025
4 checks passed
@rchitale7 rchitale7 deleted the api-image branch April 4, 2025 19:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Implementation] Create API handlers for Remote Vector Index Builder Core
3 participants