reorg docs

This commit is contained in:
Chang She
2023-03-22 18:56:15 -07:00
parent c5eaeb5ca1
commit 2ffd94c3ec
5 changed files with 6 additions and 4 deletions

20
docs/src/index.md Normal file
View File

@@ -0,0 +1,20 @@
# Welcome to LanceDB's Documentation
LanceDB is an open-source database for vector-search built with persistent storage, which greatly simplifies retrevial, filtering and management of embeddings.
The key features of LanceDB include:
* Production-scale vector search with no servers to manage.
* Combine attribute-based information with vectors and store them as a single source-of-truth.
* Zero-copy, automatic versioning, manage versions of your data without needing extra infrastructure.
* Ecosystem integrations: Apache-Arrow, Pandas, Polars, DuckDB and more on the way.
LanceDB's core is written in Rust 🦀 and is built using Lance, an open-source columnar format designed for performant ML workloads.
## Documentation Quick Links
* `Quick start` - search and filter a hello world vector dataset with LanceDB using the Python SDK.
* [`API Reference`](python.md) - detailed documentation for the LanceDB Python SDK.

12
docs/src/python.md Normal file
View File

@@ -0,0 +1,12 @@
# LanceDB Python API Reference
## Installation
```shell
pip install lancedb
```
::: lancedb
::: lancedb.db
::: lancedb.table
::: lancedb.query