Files
lancedb/docs/src/index.md
Chang She bb01ad5290 doc: fix broken link and add README (#573)
Fix broken link to embedding functions

testing: broken link was verified after local docs build to have been
repaired

---------

Co-authored-by: Chang She <chang@lancedb.com>
2023-10-16 16:13:07 -07:00

3.1 KiB

LanceDB

LanceDB is an open-source database for vector-search built with persistent storage, which greatly simplifies retrieval, filtering and management of embeddings.

Illustration

The key features of LanceDB include:

  • Store, query and filter vectors, metadata and multi-modal data (text, images, videos, point clouds, and more).

  • Support for production-scale vector similarity search, full-text search and SQL, with no servers to manage.

  • Native Python and Javascript/Typescript support.

  • Zero-copy, automatic versioning, manage versions of your data without needing extra infrastructure.

  • Persisted on HDD, allowing scalability without breaking the bank.

  • Ingest your favorite data formats directly, like pandas DataFrames, Pydantic objects and more.

LanceDB's core is written in Rust 🦀 and is built using Lance, an open-source columnar format designed for performant ML workloads.

Quick Start

=== "Python" shell pip install 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_list()
  ```

=== "Javascript" shell npm install vectordb

  ```javascript
  const lancedb = require("vectordb");

  const uri = "data/sample-lancedb";
  const db = await lancedb.connect(uri);
  const table = await db.createTable("my_table",
        [{ id: 1, vector: [3.1, 4.1], item: "foo", price: 10.0 },
        { id: 2, vector: [5.9, 26.5], item: "bar", price: 20.0 }])
  const results = await table.search([100, 100]).limit(2).execute();
  ```

Complete Demos (Python)

Complete Demos (JavaScript)