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

Add "replace" to streaming challenge with new runbooks #301

Merged
merged 8 commits into from
Aug 26, 2024

Conversation

magdalendobson
Copy link
Collaborator

This PR adds a new operation, "replace," to the options in the streaming benchmark challenge. It reflects the operation where an embedding for a particular vector ID is updated, with use cases such as computing a new embedding to reflect small changes to a document ID. The changes to the core repository are fairly small: the running and loading code now accept replace as an option, and it is included in the streaming groundtruth calculation script. All these changes are fully backwards-compatible with the original neurips23 runners.

We also contribute three new runbooks that use the new "replace" operation. The first is simple_replace_runbook.yaml, which is modeled after the existing simple runbook. The second, random_replace_runbook.yaml is based on the msturing-10m-clustered dataset. It first inserts a prefix of the data in each cluster, then replaces part of that prefix with data from a randomly selected cluster. The third, clustered_replace_runbook.yaml is also based on msturing-10m-clustered, and it inserts a prefix of the data in each cluster, then replaces part of that prefix with reserved data points from the same cluster. The script for generating these runbooks is deterministic and is provided in gen_replace_runbooks.py.

@magdalendobson
Copy link
Collaborator Author

In response to suggestions @harsha-simhadri, I added a README that documents the semantics of replace. I also used this as an opportunity to start collecting a list of streaming runbooks with brief descriptions, as we now have ten runbooks.

magdalendobson and others added 3 commits August 23, 2024 11:49
@magdalendobson magdalendobson marked this pull request as ready for review August 26, 2024 15:16
@harsha-simhadri harsha-simhadri merged commit 4aea829 into main Aug 26, 2024
48 of 76 checks passed
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.

2 participants