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: blob api documents #3247

Merged
merged 7 commits into from
Dec 14, 2024
Merged

docs: blob api documents #3247

merged 7 commits into from
Dec 14, 2024

Conversation

eddyxu
Copy link
Contributor

@eddyxu eddyxu commented Dec 14, 2024

Closes #3160

@github-actions github-actions bot added documentation Improvements or additions to documentation python labels Dec 14, 2024
@eddyxu eddyxu merged commit 83b8efd into main Dec 14, 2024
16 checks passed
@eddyxu eddyxu deleted the lei/blob_api branch December 14, 2024 19:43
Copy link
Contributor

@westonpace westonpace left a comment

Choose a reason for hiding this comment

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

Some minor suggestions but seems good to me

Python APIs
===========

``Lance`` is a columnar format that is specifically designed for efficient
Copy link
Contributor

Choose a reason for hiding this comment

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

Since we're talking about datasets it might be more precise to refer to it as a table format here rather than a columnar format.


Indexing and Searching
~~~~~~~~~~~~~~~~~~~~~~

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe a sentence here like

Lance supports both nearest-neighbor searches (full text search or vector search) and full columnar scans (with or without row and column filtering)

@@ -152,7 +152,7 @@ def when_not_matched_by_source_delete(self, expr: Optional[str] = None):


class LanceDataset(pa.dataset.Dataset):
"""A dataset in Lance format where the data is stored at the given uri."""
"""A Lance Dataset in Lance format where the data is stored at the given uri."""
Copy link
Contributor

Choose a reason for hiding this comment

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

This changes makes things a bit redundant. Maybe just A Lance Dataset where the data is stored at the given uri.

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 python
Projects
None yet
Development

Successfully merging this pull request may close these issues.

doc: describe how to use blob api and the benefits of it
3 participants