Revise README for DiskANN3 #1046
Open
harsha-simhadri wants to merge 9 commits into
Open
Conversation
Updated README to reflect changes in DiskANN3 and added details about the Provider API and getting started guide.
Corrected formatting and improved clarity in the README.
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the top-level README to describe DiskANN3 (Rust main branch) and its Provider API, plus a short “Getting Started” section pointing to benchmarking and provider integration entry points.
Changes:
- Replaces the prior badge/paper-heavy intro with a DiskANN3 overview and feature list.
- Adds Provider API context and a “Getting Started” section with links to benchmarks and the provider contract.
- Moves badges and paper links into the “Legacy C++ Code” section.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Updated the README to clarify the DiskANN3 library's purpose and usage, including changes to the description of the API and algorithmic features.
Updated project name and description in README.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1046 +/- ##
==========================================
- Coverage 90.60% 89.47% -1.13%
==========================================
Files 461 461
Lines 85494 85494
==========================================
- Hits 77462 76498 -964
- Misses 8032 8996 +964
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
harsha-simhadri
changed the title
metajack
approved these changes
May 11, 2026
| [](https://harsha-simhadri.org/pubs/Filtered-DiskANN23.pdf) | ||
| To use DiskANN3 in your system, you would implement the `DataProvider` trait for your store to describe how index terms such as vectors, adjacency lists should be store and retrieved. DiskANN3 provides vector update and query API to users and internally uses the implementation of `DataProvider` trait to serve these requests. | ||
|
|
||
| This repo offers the following Provider implementations as illustrative examples: |
Contributor
There was a problem hiding this comment.
Do we want to future-proof these claims with dates or version tags of competitors?
| The provider for [Cosmos DB NoSQL Vector Search](https://learn.microsoft.com/en-us/azure/cosmos-db/vector-search) is not included here but documented in the [VLDB'25 paper](https://www.vldb.org/pvldb/vol18/p5166-upreti.pdf). | ||
|
|
||
| The library supports the following algorithmic features | ||
| - Real-time updates (using [IP-DiskANN](https://arxiv.org/abs/2502.13826)) that support stable recall under long update streams -- no merges, rebuilds, patches needed. |
Contributor
There was a problem hiding this comment.
We also support the FreshDiskANN version, right? IP-DiskANN is just the default.
Contributor
Author
There was a problem hiding this comment.
Do we support the whole tier merge architecturein main branch?
|
|
||
| The provider for [Cosmos DB NoSQL Vector Search](https://learn.microsoft.com/en-us/azure/cosmos-db/vector-search) is not included here but documented in the [VLDB'25 paper](https://www.vldb.org/pvldb/vol18/p5166-upreti.pdf). | ||
|
|
||
| The library supports the following algorithmic features |
Contributor
There was a problem hiding this comment.
Maybe we should mention special types of search such as range, diverse?
| - Real-time updates (using [IP-DiskANN](https://arxiv.org/abs/2502.13826)) that support stable recall under long update streams -- no merges, rebuilds, patches needed. | ||
| - A diverse set of distance functions and quantizers (PQ, MinMax, Scalar, Spherical) implemented for x86 and aarch64. | ||
| - Choice of memory tiers to allow operation at different price-performance points. | ||
| - Hooks to allow attribute filters (predicate) processsing along with vector search. |
| @@ -24,7 +32,18 @@ See [guidelines](CONTRIBUTING.md) for contributing to this project. | |||
|
|
|||
| ## Legacy C++ Code | |||
Contributor
There was a problem hiding this comment.
Mention that this is DiskANN2?
arrayka
approved these changes
May 12, 2026
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
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.
Updated README to reflect changes in DiskANN3 and added details about the Provider API and getting started guide.