docs: add missing Python index classes to API reference#3392
Open
singhvishalkr wants to merge 1 commit into
Open
docs: add missing Python index classes to API reference#3392singhvishalkr wants to merge 1 commit into
singhvishalkr wants to merge 1 commit into
Conversation
Add IvfSq, IvfRq, and HnswFlat to the Indices (Asynchronous) section of the Python API reference. These classes exist in lancedb.index but were not previously documented.
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
github-actions
Bot
added
the
documentation
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
1 participant
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.
Adds three index configuration classes to the Python API Reference that were missing from the documentation:
IvfSq- IVF Scalar Quantization indexIvfRq- IVF RabitQ Quantization indexHnswFlat- HNSW without quantization (stores raw vectors)These classes are exported in
lancedb.index.__all__and have complete docstrings in the source, but weren't showing up in the rendered docs at https://lancedb.github.io/lancedb/python/python/#indices-asynchronous.Closes #1855