diff --git a/.gitignore b/.gitignore index ff48bc56..82273582 100644 --- a/.gitignore +++ b/.gitignore @@ -3,4 +3,5 @@ *.egg-info **/__pycache__ -rust/target \ No newline at end of file +rust/target +rust/Cargo.lock \ No newline at end of file diff --git a/docs/docs/index.md b/docs/docs/index.md new file mode 100644 index 00000000..7d10cdb8 --- /dev/null +++ b/docs/docs/index.md @@ -0,0 +1,19 @@ +# 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. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml new file mode 100644 index 00000000..70c3765a --- /dev/null +++ b/docs/mkdocs.yml @@ -0,0 +1,3 @@ +site_name: LanceDB Documentation +theme: + name: material