Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add snippet on incremental reindexing #1461

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

changhiskhan
Copy link
Contributor

User reported that our documentation says incremental indexing is only available in the commercial offering. Updating the docs to add guidance on how to use lance api to do incremental indexing

Copy link

ACTION NEEDED

Lance follows the Conventional Commits specification for release automation.

The PR title and description are used as the merge commit message. Please update your PR title and description to match the specification.

For details on the error please inspect the "PR Title Check" action.

@changhiskhan changhiskhan changed the title doc: add snippet on incremental reindexing docs: add snippet on incremental reindexing Jul 20, 2024
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jul 20, 2024
@@ -55,7 +55,7 @@ When a reindex job is triggered in the background, the entire data is reindexed,
### Vector reindex

* LanceDB Cloud supports incremental reindexing, where a background process will trigger a new index build for you automatically when new data is added to a dataset
* LanceDB OSS requires you to manually trigger a reindex operation -- we are working on adding incremental reindexing to LanceDB OSS as well
* LanceDB OSS requires you to manually trigger a reindex operation -- incremental indexing is available via the Lance API `lance_table.to_lance().optimize.optimize_indices()`. Incremental indexing means that any unindexed rows are added to the existing index. This is much faster than a full reindex because it does not involve kmeans training or reconstructing the graph from scratch (depending on your index type).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we mention that this is only available via python? Rust and JS do not have a to_lance equivalent.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we do #1463 instead ?

@universalmind303 @changhiskhan

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants