diff --git a/README.md b/README.md index f60445a9..b332cc77 100644 --- a/README.md +++ b/README.md @@ -1,94 +1,97 @@ LanceDB Cloud Public Beta -
-

- - - - LanceDB Logo - +[![LanceDB](docs/src/assets/hero-header.png)](https://lancedb.com) +[![Website](https://img.shields.io/badge/-Website-100000?style=for-the-badge&labelColor=645cfb&color=645cfb)](https://lancedb.com/) +[![Blog](https://img.shields.io/badge/Blog-100000?style=for-the-badge&labelColor=645cfb&color=645cfb)](https://blog.lancedb.com/) +[![Discord](https://img.shields.io/badge/-Discord-100000?style=for-the-badge&logo=discord&logoColor=white&labelColor=645cfb&color=645cfb)](https://discord.gg/zMM32dvNtd) +[![Twitter](https://img.shields.io/badge/-Twitter-100000?style=for-the-badge&logo=x&logoColor=white&labelColor=645cfb&color=645cfb)](https://twitter.com/lancedb) +[![LinkedIn](https://img.shields.io/badge/-LinkedIn-100000?style=for-the-badge&logo=linkedin&logoColor=white&labelColor=645cfb&color=645cfb)](https://www.linkedin.com/company/lancedb/) -**Search More, Manage Less** -LanceDB -lancdb -[![Blog](https://img.shields.io/badge/Blog-12100E?style=for-the-badge&logoColor=white)](https://blog.lancedb.com/) -[![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/zMM32dvNtd) -[![Twitter](https://img.shields.io/badge/Twitter-%231DA1F2.svg?style=for-the-badge&logo=Twitter&logoColor=white)](https://twitter.com/lancedb) -[![Gurubase](https://img.shields.io/badge/Gurubase-Ask%20LanceDB%20Guru-006BFF?style=for-the-badge)](https://gurubase.io/g/lancedb) +LanceDB -

+# **The Multimodal AI Lakehouse** -LanceDB Multimodal Search +[**How to Install** ](#how-to-install) ✦ [**Detailed Documentation**](https://lancedb.github.io/lancedb/) ✦ [**Tutorials and Recipes**](https://github.com/lancedb/vectordb-recipes/tree/main) ✦ [**Contributors**](#contributors) + +**The ultimate multimodal data platform for AI/ML applications.** + +LanceDB is designed for fast, scalable, and production-ready vector search. It is built on top of the Lance columnar format. You can store, index, and search over petabytes of multimodal data and vectors with ease. +LanceDB is a central location where developers can build, train and analyze their AI workloads. -

-
+
-LanceDB is an open-source database for vector-search built with persistent storage, which greatly simplifies retrieval, filtering and management of embeddings. +## **Demo: Multimodal Search by Keyword, Vector or with SQL** +LanceDB Multimodal Search -The key features of LanceDB include: +## **Star LanceDB to get updates!** -* Production-scale vector search with no servers to manage. +
+⭐ Click here ⭐ to see how fast we're growing! + + + + +
-* Store, query and filter vectors, metadata and multi-modal data (text, images, videos, point clouds, and more). +## **Key Features**: -* Support for vector similarity search, full-text search and SQL. +- **Fast Vector Search**: Search billions of vectors in milliseconds with state-of-the-art indexing. +- **Comprehensive Search**: Support for vector similarity search, full-text search and SQL. +- **Multimodal Support**: Store, query and filter vectors, metadata and multimodal data (text, images, videos, point clouds, and more). +- **Advanced Features**: Zero-copy, automatic versioning, manage versions of your data without needing extra infrastructure. GPU support in building vector index. -* Native Python and Javascript/Typescript support. +### **Products**: +- **Open Source & Local**: 100% open source, runs locally or in your cloud. No vendor lock-in. +- **Cloud and Enterprise**: Production-scale vector search with no servers to manage. Complete data sovereignty and security. -* Zero-copy, automatic versioning, manage versions of your data without needing extra infrastructure. +### **Ecosystem**: +- **Columnar Storage**: Built on the Lance columnar format for efficient storage and analytics. +- **Seamless Integration**: Python, Node.js, Rust, and REST APIs for easy integration. Native Python and Javascript/Typescript support. +- **Rich Ecosystem**: Integrations with [**LangChain** 🦜️🔗](https://python.langchain.com/docs/integrations/vectorstores/lancedb/), [**LlamaIndex** 🦙](https://gpt-index.readthedocs.io/en/latest/examples/vector_stores/LanceDBIndexDemo.html), Apache-Arrow, Pandas, Polars, DuckDB and more on the way. -* GPU support in building vector index(*). +## **How to Install**: -* Ecosystem integrations with [LangChain 🦜️🔗](https://python.langchain.com/docs/integrations/vectorstores/lancedb/), [LlamaIndex 🦙](https://gpt-index.readthedocs.io/en/latest/examples/vector_stores/LanceDBIndexDemo.html), Apache-Arrow, Pandas, Polars, DuckDB and more on the way. +Follow the [Quickstart](https://lancedb.github.io/lancedb/basic/) doc to set up LanceDB locally. -LanceDB's core is written in Rust 🦀 and is built using Lance, an open-source columnar format designed for performant ML workloads. +**API & SDK:** We also support Python, Typescript and Rust SDKs -## Quick Start +| Interface | Documentation | +|-----------|---------------| +| Python SDK | https://lancedb.github.io/lancedb/python/python/ | +| Typescript SDK | https://lancedb.github.io/lancedb/js/globals/ | +| Rust SDK | https://docs.rs/lancedb/latest/lancedb/index.html | +| REST API | https://docs.lancedb.com/api-reference/introduction | -**Javascript** -```shell -npm install @lancedb/lancedb -``` +## **Join Us and Contribute** -```javascript -import * as lancedb from "@lancedb/lancedb"; +We welcome contributions from everyone! Whether you're a developer, researcher, or just someone who wants to help out. -const db = await lancedb.connect("data/sample-lancedb"); -const table = await db.createTable("vectors", [ - { id: 1, vector: [0.1, 0.2], item: "foo", price: 10 }, - { id: 2, vector: [1.1, 1.2], item: "bar", price: 50 }, -], {mode: 'overwrite'}); +If you have any suggestions or feature requests, please feel free to open an issue on GitHub or discuss it on our [**Discord**](https://discord.gg/G5DcmnZWKB) server. + +[**Check out the GitHub Issues**](https://github.com/lancedb/lancedb/issues) if you would like to work on the features that are planned for the future. If you have any suggestions or feature requests, please feel free to open an issue on GitHub. + +## **Contributors** + + + + -const query = table.vectorSearch([0.1, 0.3]).limit(2); -const results = await query.toArray(); +## **Stay in Touch With Us** +
-// You can also search for rows by specific criteria without involving a vector search. -const rowsByCriteria = await table.query().where("price >= 10").toArray(); -``` +
-**Python** -```shell -pip install lancedb -``` +[![Website](https://img.shields.io/badge/-Website-100000?style=for-the-badge&labelColor=645cfb&color=645cfb)](https://lancedb.com/) +[![Blog](https://img.shields.io/badge/Blog-100000?style=for-the-badge&labelColor=645cfb&color=645cfb)](https://blog.lancedb.com/) +[![Discord](https://img.shields.io/badge/-Discord-100000?style=for-the-badge&logo=discord&logoColor=white&labelColor=645cfb&color=645cfb)](https://discord.gg/zMM32dvNtd) +[![Twitter](https://img.shields.io/badge/-Twitter-100000?style=for-the-badge&logo=x&logoColor=white&labelColor=645cfb&color=645cfb)](https://twitter.com/lancedb) +[![LinkedIn](https://img.shields.io/badge/-LinkedIn-100000?style=for-the-badge&logo=linkedin&logoColor=white&labelColor=645cfb&color=645cfb)](https://www.linkedin.com/company/lancedb/) -```python -import lancedb - -uri = "data/sample-lancedb" -db = lancedb.connect(uri) -table = db.create_table("my_table", - data=[{"vector": [3.1, 4.1], "item": "foo", "price": 10.0}, - {"vector": [5.9, 26.5], "item": "bar", "price": 20.0}]) -result = table.search([100, 100]).limit(2).to_pandas() -``` - -## Blogs, Tutorials & Videos -* 📈 2000x better performance with Lance over Parquet -* 🤖 Build a question and answer bot with LanceDB +
diff --git a/docs/src/assets/hero-header.png b/docs/src/assets/hero-header.png new file mode 100644 index 00000000..58805372 Binary files /dev/null and b/docs/src/assets/hero-header.png differ diff --git a/docs/src/assets/lancedb.png b/docs/src/assets/lancedb.png new file mode 100644 index 00000000..d2fe74fc Binary files /dev/null and b/docs/src/assets/lancedb.png differ