docs(index): fix stale default values in HnswBuildParams doc comments - #8140
Open
wombatu-kun wants to merge 1 commit into
Open
docs(index): fix stale default values in HnswBuildParams doc comments#8140wombatu-kun wants to merge 1 commit into
wombatu-kun wants to merge 1 commit into
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.
The three builder methods on
HnswBuildParamsdocument default values that no longer matchimpl Default.Defaultgivesmax_level87num_edges3020ef_construction100150The format spec table in
docs/src/format/index/vector/index.mdalready lists the correct values, so these builder doc comments are the only place left stating the old ones.Also fixes the
max_levelfield doc, which currently reads "max level ofm".Docs only, no behavior change.
One question while I am here:
lance.util.HNSW.buildin the Python bindings still defaultsef_constructionto 100, the value the Rust default carried before it moved to 150. That is a real default rather than a doc, so I left it untouched. Should it be lined up with 150? I can fold that into this PR or send it as a separate follow-up, whichever you prefer.