Add the support for IndexIDMap with Cagra index

[navneet1v]

Description

Add the support for adding vectors with ids when IndexIDMap is used with Cagra Index.

Resolves issue: #4107

[facebook-github-bot]

Hi @navneet1v!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

[navneet1v]

@gtwang01 can you please review the PR

[gtwang01]

Our team is currently reviewing whether to include this feature or not. I'll let you know when we make a decision.

[gtwang01]

You also need to sign the contributor license agreement.

[navneet1v]

You also need to sign the contributor license agreement.

I am working on this. It might take some time.

[navneet1v]

You also need to sign the contributor license agreement.

I am working on this. It might take some time.

The CLA is approved now.

[navneet1v]

@gtwang01 any update on this?

[gtwang01]

I'll have an update later today in a few hours

[gtwang01]

Update: we can accept this.

One request - the PR links to the discussion, but the code itself could be confusing to readers. Can you add a comment in the function like there is with the train function? Suggestion: "Normal usage of GpuIndexCagra is to only call train, which internally builds the graph without having to explicitly add vectors. The add API is included for wrapping GpuIndexCagra with IndexIDMap in order to support add_with_ids."

[navneet1v]

Update: we can accept this.

One request - the PR links to the discussion, but the code itself could be confusing to readers. Can you add a comment in the function like there is with the train function? Suggestion: "Normal usage of GpuIndexCagra is to only call train, which internally builds the graph without having to explicitly add vectors. The add API is included for wrapping GpuIndexCagra with IndexIDMap in order to support add_with_ids."

sure I can add this. This is no biggie. Thanks for the update. Let me update the PR.

[facebook-github-bot]

@gtwang01 has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

[navneet1v]

@gtwang01 updated the docs.