mirror of https://github.com/lancedb/lancedb.git synced 2026-01-04 02:42:57 +00:00

Files

Chang She b0a88a7286 feat(python): Set heap size to get faster fts indexing performance (#762 )

By default tantivy-py uses 128MB heapsize. We change the default to 1GB
and we allow the user to customize this

locally this makes `test_fts.py` run 10x faster

2024-01-07 15:15:13 -08:00

overrides/partials

[docs] CTA for discord + twitter (#218 )

2023-06-22 16:52:34 -07:00

src

feat(python): Set heap size to get faster fts indexing performance (#762 )

2024-01-07 15:15:13 -08:00

test

doc: add doc to use GPU for indexing (#611 )

2023-10-30 15:25:00 -07:00

mkdocs.yml

SaaS JS API sdk doc (#740 )

2024-01-03 16:24:21 -08:00

README.md

doc: fix broken link and add README (#573 )

2023-10-16 16:13:07 -07:00

requirements.txt

feat(python): add option to flatten output in to_pandas (#722 )

2023-12-20 12:23:07 -08:00

README.md

LanceDB Documentation

LanceDB docs are deployed to https://lancedb.github.io/lancedb/.

Docs is built and deployed automatically by Github Actions whenever a commit is pushed to the main branch. So it is possible for the docs to show unreleased features.

Building the docs

Setup

Install LanceDB. From LanceDB repo root: pip install -e python
Install dependencies. From LanceDB repo root: pip install -r docs/requirements.txt
Make sure you have node and npm setup
Make sure protobuf and libssl are installed

Building node module and create markdown files

See Javascript docs README

Build docs

From LanceDB repo root:

Run: PYTHONPATH=. mkdocs build -f docs/mkdocs.yml

If successful, you should see a docs/site directory that you can verify locally.