Repository navigation
refactor: align numerical naming and documentation - #180
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
Align internal names across Core, FastScan, clustering and SIMD, and document the shared conventions. Clarify query wrappers, scalar/batch scoring outputs, clustering counts/workers and FHT arguments; preserve public APIs, mathematical operations, persisted layouts,
G_*fields andniter_.Update numerical examples and correct three documentation inconsistencies: HNSW code sizes use
padded_dim, the IVF layout uses a neutral cluster-metadata label, and IVFaddhelp explains potentially approximate initializer routing. Stub and runtime help use the same wording.Testing
git diff --checkpassed.ARM code was source/token checked; native ARM, Windows and macOS execution was not rerun. No performance change is claimed.