mirror of
https://github.com/lancedb/lancedb.git
synced 2025-12-22 21:09:58 +00:00
docs: add some missing classes (#2450)
<!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Expanded Python API reference with new entries for table metadata, tagging, remote client configuration, and index statistics. - Added documentation for new classes and modules in both synchronous and asynchronous sections, including `FragmentStatistics`, `FragmentSummaryStats`, `Tags`, `AsyncTags`, `IndexStatistics`, and remote configuration options. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
This commit is contained in:
@@ -30,6 +30,12 @@ is also an [asynchronous API client](#connections-asynchronous).
|
|||||||
|
|
||||||
::: lancedb.table.Table
|
::: lancedb.table.Table
|
||||||
|
|
||||||
|
::: lancedb.table.FragmentStatistics
|
||||||
|
|
||||||
|
::: lancedb.table.FragmentSummaryStats
|
||||||
|
|
||||||
|
::: lancedb.table.Tags
|
||||||
|
|
||||||
## Querying (Synchronous)
|
## Querying (Synchronous)
|
||||||
|
|
||||||
::: lancedb.query.Query
|
::: lancedb.query.Query
|
||||||
@@ -58,6 +64,14 @@ is also an [asynchronous API client](#connections-asynchronous).
|
|||||||
|
|
||||||
::: lancedb.embeddings.open_clip.OpenClipEmbeddings
|
::: lancedb.embeddings.open_clip.OpenClipEmbeddings
|
||||||
|
|
||||||
|
## Remote configuration
|
||||||
|
|
||||||
|
::: lancedb.remote.ClientConfig
|
||||||
|
|
||||||
|
::: lancedb.remote.TimeoutConfig
|
||||||
|
|
||||||
|
::: lancedb.remote.RetryConfig
|
||||||
|
|
||||||
## Context
|
## Context
|
||||||
|
|
||||||
::: lancedb.context.contextualize
|
::: lancedb.context.contextualize
|
||||||
@@ -115,6 +129,8 @@ Table hold your actual data as a collection of records / rows.
|
|||||||
|
|
||||||
::: lancedb.table.AsyncTable
|
::: lancedb.table.AsyncTable
|
||||||
|
|
||||||
|
::: lancedb.table.AsyncTags
|
||||||
|
|
||||||
## Indices (Asynchronous)
|
## Indices (Asynchronous)
|
||||||
|
|
||||||
Indices can be created on a table to speed up queries. This section
|
Indices can be created on a table to speed up queries. This section
|
||||||
@@ -136,6 +152,8 @@ lists the indices that LanceDb supports.
|
|||||||
|
|
||||||
::: lancedb.index.IvfFlat
|
::: lancedb.index.IvfFlat
|
||||||
|
|
||||||
|
::: lancedb.table.IndexStatistics
|
||||||
|
|
||||||
## Querying (Asynchronous)
|
## Querying (Asynchronous)
|
||||||
|
|
||||||
Queries allow you to return data from your database. Basic queries can be
|
Queries allow you to return data from your database. Basic queries can be
|
||||||
|
|||||||
Reference in New Issue
Block a user