mirror of https://github.com/lancedb/lancedb.git synced 2025-12-25 22:29:58 +00:00

Files

Will Jones fed33a51d5 wip: make the python API reference a bit nicer (#162 )

Adds:

* Make `mkdocstrings` aware we are using numpy-style docstrings
* Fixes broken link on `index.md` to Python API docs (and added link to
node ones)
* Added examples to various classes.
* Added doctest to verify examples work.

2023-06-08 16:07:06 -07:00

572 B

Raw Blame History

LanceDB Python API Reference

Installation

pip install lancedb

Connection

::: lancedb.connect

::: lancedb.LanceDBConnection

Table

::: lancedb.table.LanceTable

Querying

::: lancedb.query.LanceQueryBuilder

::: lancedb.query.LanceFtsQueryBuilder

Embeddings

::: lancedb.embeddings.with_embeddings

::: lancedb.embeddings.EmbeddingFunction

Context

::: lancedb.context.contextualize

::: lancedb.context.Contextualizer

Full text search

::: lancedb.fts.create_index

::: lancedb.fts.populate_index

::: lancedb.fts.search_index

572 B Raw Blame History