Skip to content

Commit

Permalink
Add some extra docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Jay Chia committed May 2, 2024
1 parent 0836036 commit e153039
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions daft/io/_lance.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,13 @@ def read_lance(url: str, io_config: Optional["IOConfig"] = None) -> DataFrame:
This function requires the use of `LanceDB <https://lancedb.github.io/lancedb/>`_, which is the Python
library for the LanceDB project.
To ensure that this is installed with Daft, you may install: ``pip install getdaft[lance]``
Example:
>>> df = daft.read_lance("s3://my-lancedb-bucket/data/")
>>> df.show()
Args:
url: URL to the LanceDB table (supports remote URLs to object stores such as `s3://` or `gs://`)
io_config: A custom IOConfig to use when accessing LanceDB data. Defaults to None.
Expand Down

0 comments on commit e153039

Please sign in to comment.