Skip to main content

python wrapper for lance-rs

Project description

Python bindings for Lance Data Format

:warning: Under heavy development

Lance Logo

Lance is a new columnar data format for data science and machine learning

Why you should use Lance

  1. Is order of magnitude faster than parquet for point queries and nested data structures common to DS/ML
  2. Comes with a fast vector index that delivers sub-millisecond nearest neighbors search performance
  3. Is automatically versioned and supports lineage and time-travel for full reproducibility
  4. Integrated with duckdb/pandas/polars already. Easily convert from/to parquet in 2 lines of code

Quick start

Installation

pip install pylance

Converting to Lance

import lance

import pandas as pd
import pyarrow as pa
import pyarrow.dataset

df = pd.DataFrame({"a": [5], "b": [10]})
uri = "/tmp/test.parquet"
tbl = pa.Table.from_pandas(df)
pa.dataset.write_dataset(tbl, uri, format='parquet')

parquet = pa.dataset.dataset(uri, format='parquet')
lance.write_dataset(parquet, "/tmp/test.lance")

Reading Lance data

dataset = lance.dataset("/tmp/test.lance")
assert isinstance(dataset, pa.dataset.Dataset)

Pandas

df = dataset.to_table().to_pandas()

DuckDB

import duckdb

tbl = dataset.to_table()  # next release of duckdb will have pushdowns enabled
duckdb.query("SELECT * FROM tbl LIMIT 10").to_df()

Vector search

Download an indexed sift dataset, and unzip it into vec_data.lance

# Get top 10 similar vectors
import lance
import duckdb
import numpy as np

uri = "vec_data.lance"
dataset = lance.dataset(uri)

# Sample 100 query vectors
tbl = dataset.to_table()
sample = duckdb.query("SELECT vector FROM tbl USING SAMPLE 100").to_df()
query_vectors = np.array([np.array(x) for x in sample.vector])

# Get nearest neighbors for all of them
rs = [dataset.to_table(nearest={"column": "vector", 
                                "k": 10, 
                                "q": query_vectors[i, :]}) 
      for i in range(query_vectors.shape[0])]

For the fast indexing capability, you can and run the same code as above. We're working on a more convenient indexing tool via python.

*More distance metrics, supported types, and compute integration coming

Python package details

Install from PyPI: pip install pylance # >=0.3.0 is the new rust-based implementation Install from source: maturin develop (under the /python directory)

Import via: import lance

The python integration is done via pyo3 + custom python code:

  1. We make wrapper classes in Rust for Dataset/Scanner/RecordBatchReader that's exposed to python.
  2. These are then used by LanceDataset / LanceScanner implementations that extend pyarrow Dataset/Scanner for duckdb compat.
  3. Data is delivered via the Arrow C Data Interface

Motivation

Why do we need a new format for data science and machine learning?

1. Reproducibility is a must-have

Versioning and experimentation support should be built into the dataset instead of requiring multiple tools.
It should also be efficient and not require expensive copying everytime you want to create a new version.
We call this "Zero copy versioning" in Lance. It makes versioning data easy without increasing storage costs.

2. Cloud storage is now the default

Remote object storage is the default now for data science and machine learning and the performance characteristics of cloud are fundamentally different.
Lance format is optimized to be cloud native. Common operations like filter-then-take can be order of magnitude faster using Lance than Parquet, especially for ML data.

3. Vectors must be a first class citizen, not a separate thing

The majority of reasonable scale workflows should not require the added complexity and cost of a specialized database just to compute vector similarity. Lance integrates optimized vector indices into a columnar format so no additional infrastructure is required to get low latency top-K similarity search.

4. Open standards is a requirement

The DS/ML ecosystem is incredibly rich and data must be easily accessible across different languages, tools, and environments. Lance makes Apache Arrow integration its primary interface, which means conversions to/from is 2 lines of code, your code does not need to change after conversion, and nothing is locked-up to force you to pay for vendor compute. We need open-source not fauxpen-source.

Project details


Release history Release notifications | RSS feed

This version

0.3.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

pylance-0.3.1-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (9.2 MB view details)

Uploaded CPython 3.8+ manylinux: glibc 2.17+ x86-64

pylance-0.3.1-cp38-abi3-macosx_11_0_arm64.whl (6.5 MB view details)

Uploaded CPython 3.8+ macOS 11.0+ ARM64

pylance-0.3.1-cp38-abi3-macosx_10_7_x86_64.whl (7.1 MB view details)

Uploaded CPython 3.8+ macOS 10.7+ x86-64

File details

Details for the file pylance-0.3.1-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for pylance-0.3.1-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 ec342572c824df3794b8afe9238bd5b08a6f827cb308769038d9218c3eee47e0
MD5 d648ab836c294b07cd1cea27119cc437
BLAKE2b-256 f43bb24774d6cdccdefba13b5a93cf0a017ad2f936125794cbe56beca2439663

See more details on using hashes here.

Provenance

File details

Details for the file pylance-0.3.1-cp38-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for pylance-0.3.1-cp38-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 b1c75452ee52e032f66e53b9c305fcd3f135c48493cc7684134511839170c5b7
MD5 7c50c18fd6c2eda61aab251033ef6839
BLAKE2b-256 28765508d11b1ae7575032421a25acc567886540072d58d8c92bef4edb2f393c

See more details on using hashes here.

Provenance

File details

Details for the file pylance-0.3.1-cp38-abi3-macosx_10_7_x86_64.whl.

File metadata

File hashes

Hashes for pylance-0.3.1-cp38-abi3-macosx_10_7_x86_64.whl
Algorithm Hash digest
SHA256 cea5881e1ef4cda8559c2795bf2ad8deef8ef154713c0ef5f20a70b098b1d4f9
MD5 ea978857a697babfc63d4b498159e8f7
BLAKE2b-256 c4e8fe2e9f9275c815e701465b49d740df068f39dc3621b41625ff4427f55af2

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page