Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@
[![PyPI version](https://img.shields.io/pypi/v/lance-csr?color=555)](https://pypi.org/project/lance-csr/)
[![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-555)](LICENSE)

[Documentation](https://lance-csr.pages.dev/) · [Examples](examples/README.md) ·
[Documentation](https://lance-csr.hdclabs.ai/) · [Examples](examples/README.md) ·
[Releases](https://github.com/hyperdimensionalcomputingai/lance-csr/releases) · [Contributing](CONTRIBUTING.md)

lance-csr is a fast graph query engine over [Lance](https://lancedb.github.io/lance/) datasets, built in Rust on
Apache DataFusion, with Python bindings. It is a fork of [lance-graph](https://github.com/lance-format/lance-graph)
and a research test bed: it pushes the limits of CSR indexes and DataFusion on top of the Lance format, with the
goal of making multi-hop path traversal fast.

**Documentation:** Visit the [lance-csr documentation site](https://lance-csr.pages.dev/) for getting started,
**Documentation:** Visit the [lance-csr documentation site](https://lance-csr.hdclabs.ai/) for getting started,
Cypher guides, the CSR index, the Python API reference, and benchmarks.

## Goals
Expand Down Expand Up @@ -93,7 +93,7 @@ See [`python/README.md`](python/README.md) for details and usage.

To use the engine from Rust, add the crate with `cargo add lance-csr` and see
[`crates/lance-csr/README.md`](crates/lance-csr/README.md) and the
[Rust guide](https://lance-csr.pages.dev/rust/).
[Rust guide](https://lance-csr.hdclabs.ai/rust/).

## Build from source

Expand Down
1 change: 1 addition & 0 deletions crates/lance-csr-catalog/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ edition = "2021"
license = "Apache-2.0"
authors = ["The lance-csr Authors"]
repository = "https://github.com/hyperdimensionalcomputingai/lance-csr"
homepage = "https://lance-csr.hdclabs.ai/"
readme = "README.md"
description = "Catalog and namespace utilities for Lance graph"
keywords = ["lance", "graph", "catalog", "namespace"]
Expand Down
1 change: 1 addition & 0 deletions crates/lance-csr/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ edition = "2021"
license = "Apache-2.0"
authors = ["The lance-csr Authors"]
repository = "https://github.com/hyperdimensionalcomputingai/lance-csr"
homepage = "https://lance-csr.hdclabs.ai/"
readme = "README.md"
description = "Graph query engine for Lance datasets with Cypher support"
keywords = ["lance", "graph", "cypher", "query", "datafusion"]
Expand Down
8 changes: 4 additions & 4 deletions crates/lance-csr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ new write with `refresh()`:
cargo run -p lance-csr --example embedded_query
```

The [Rust guide](https://lance-csr.pages.dev/rust/) covers the API, and the rest of the
[documentation](https://lance-csr.pages.dev/) covers the graph schema, supported Cypher and the CSR index.
The [Rust guide](https://lance-csr.hdclabs.ai/rust/) covers the API, and the rest of the
[documentation](https://lance-csr.hdclabs.ai/) covers the graph schema, supported Cypher and the CSR index.
Building the crate needs `protoc` for Lance's dependencies.

For one query over in-memory batches, `CypherQuery` works without an engine:
Expand Down Expand Up @@ -141,7 +141,7 @@ A builder (`CypherQueryBuilder`) is also available for constructing queries prog

## Supported Cypher

See [Supported Cypher](https://lance-csr.pages.dev/cypher/#supported-cypher) in the documentation for the
See [Supported Cypher](https://lance-csr.hdclabs.ai/cypher/#supported-cypher) in the documentation for the
clauses, patterns, expressions and functions the engine runs.

## Crate Layout
Expand Down Expand Up @@ -204,7 +204,7 @@ cargo test -p lance-csr
## Benchmarks

All published numbers were measured through the Python package; see the
[benchmarks page](https://lance-csr.pages.dev/benchmarks/). Criterion micro-benchmarks live in the unpublished
[benchmarks page](https://lance-csr.hdclabs.ai/benchmarks/). Criterion micro-benchmarks live in the unpublished
`lance-csr-benches` crate.

## Python Bindings
Expand Down
5 changes: 3 additions & 2 deletions docs/AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,9 @@ the internals; `rust.md` covers the same engine for Rust developers. The CSR ind
- Preview with `uv run --project docs --locked zensical serve`; check with
`uv run --project docs --locked zensical build --strict`, which CI runs on every pull request. Fix every
warning.
- Cloudflare Pages builds and hosts the site at https://lance-csr.pages.dev/ through its native GitHub
integration. Pushes to `main` automatically deploy when automatic production deployments are enabled.
- Cloudflare Pages builds and hosts the site at https://lance-csr.hdclabs.ai/ (a custom domain on the
`lance-csr` Pages project) through its native GitHub integration. `site_url` in `zensical.toml` must match
it, because it sets the canonical and social-preview URLs. Pushes to `main` automatically deploy when automatic production deployments are enabled.
Build from the repository root with the locked build command above and publish `site/`.
- Files that aren't pages (this file, `check_snippets.py`, `sync_benchmarks.py`, the uv project, `overrides/`, the
brand README and previews) are listed under `exclude_docs` in `zensical.toml`. Add new non-page files there.
Expand Down
6 changes: 6 additions & 0 deletions python/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@ classifiers = [
"Topic :: Scientific/Engineering",
]

[project.urls]
Documentation = "https://lance-csr.hdclabs.ai/"
Repository = "https://github.com/hyperdimensionalcomputingai/lance-csr"
Issues = "https://github.com/hyperdimensionalcomputingai/lance-csr/issues"
Releases = "https://github.com/hyperdimensionalcomputingai/lance-csr/releases"

[tool.maturin]
python-source = "python"
module-name = "lance_csr._internal"
Expand Down
2 changes: 1 addition & 1 deletion zensical.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
site_name = "lance-csr"
site_url = "https://lance-csr.pages.dev/"
site_url = "https://lance-csr.hdclabs.ai/"
site_description = "A fast, embedded Cypher graph query engine over Lance datasets, with a CSR adjacency index"
site_author = "The lance-csr Authors"
copyright = "Copyright © The lance-csr Authors. Apache 2.0 licensed."
Expand Down
Loading