Repository navigation
refactor(index): align naming and clarify HNSW internals - #173
Merged
Merged
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
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.
Summary
Use consistent names for shared concepts across IVF, HNSW and SymphonyQG while retaining algorithm-specific terminology. Add an index naming glossary and synchronize public C++ parameter documentation.
Also clarify HNSW's internal const access and PID types, remove unused candidate state/private helpers, and add context to candidate-ID errors. Public method names, parameter types/order/defaults, Python keywords and persisted layouts are unchanged. Renamed public C++ parameters are documented consistently.
Testing
Local Linux x86-64 validation with Clang 23 and native optimization disabled:
Full txtai/zvec application integration was not rerun; installed CMake consumers and the Python suite are the downstream-facing checks performed here. Use matching headers and libraries when rebuilding.
No performance claim. The final naming snapshot was not rerun under sanitizers or on ARM/macOS/Windows. An earlier sanitizer run reproduced 13 existing Eigen AVX-512
GemmKernel.h:815UBSan failures on unmodified HEAD; vendor code is unchanged.