mirror of
https://github.com/lancedb/lancedb.git
synced 2026-10-13 15:22:30 +00:00
Jack YeandBrendan Clement
47b7babc08
Move the public website pages into `docs/web` beside the SDK, with
shared navigation and executable example sources in `docs/web-tests`.
The combined website is assembled by
[lancedb/docs#355](https://github.com/lancedb/docs/pull/355), with six
Enterprise replacements from
[lancedb/sophon#7681](https://github.com/lancedb/sophon/pull/7681).
This includes Function guidance, runnable Quickstarts, regenerated
snippets, production contact/demo fixes, the legacy SQL route, and the
LeRobot redirect. LeRobot remains attributed to Geneva; all 34 Geneva
pages remain in the docs repository until Function officially launches.
Materialized-view guidance follows the full rebuild refresh introduced
by #4373: local refresh writes the complete result, has no `full`
argument, supports `source_version`, and no longer requires stable row
IDs. Deployment SQL refresh options and stable-ID setup are qualified by
version/configuration. Function input guidance distinguishes ordinary
stored columns from computed inputs supported by newer deployments.
**Validation:** independently accepted local checks include 95 Python
tests (real Enterprise excluded), eight TypeScript tests, Rust
Quickstart, snippet parity, typos, deterministic assembly, Mint
validation and links/anchors/redirects. The combined baseline retains
all 181 production routes and 17 legacy redirects. Examples ran locally
against source-built Python SDK 0.40.0b13; existing GitHub workflows do
not run `docs/web-tests`. New main at `069b2f7d` is 0.41.0b0 and adds
computed Function inputs; that SDK was not exercised by the accepted
tests. Latest prose corrections receive focused site validation.
**Merge/rollout:** merge this and #7681 before #355's combined CI, which
reads producer `main`. This is migration infrastructure: section
overlays, source-owned skills and automatic versioned paired releases
remain follow-ups. The current manual publisher is transitional. Hosted
validation, a supported SDK/Enterprise release pair and a real
Enterprise walkthrough remain pending.
Production Mintlify watches `lancedb/docs:deploy-freeze`, directory
`docs`; preserve that source through review. The separate SDK GitHub
Pages reference workflow rebuilds on main merges.
**Updated-head CI (9a50f8db):**
[Typos](https://github.com/lancedb/lancedb/actions/runs/37654185443/job/112904990558),
[PR
title](https://github.com/lancedb/lancedb/actions/runs/37654179507/job/112904974595)
and
[Aikido](https://app.aikido.dev/featurebranch/scan/215386145?groupId=74229)
pass. Critical findings in the example lockfiles were patched: all Sharp
copies use 0.35.5, protobufjs 7.6.6, tar 7.5.22, quinn-proto 0.11.19,
zerovec 0.11.8 and zerovec-derive 0.11.6. The SDK's product dependencies
are unchanged. The revised lockfiles pass eight TypeScript examples,
HuggingFace decode/resize/crop/rescale/normalize plus AVIF roundtrip,
and Rust Quickstart. Aikido passing does not mean every advisory is
cleared; npm still reports 29 high and five moderate advisories in the
example dependency graph. No scanner bypass or suppression was added.
The Function prose correction passes combined/standalone Mint,
deterministic assembly, routes and assets. The revised 325-file site
checksum is
`175bec06864abb400dd292e667ba93448c0479b8359fd7bf6146afabf9040647`. This
PR remains open for independent review; further merges are on hold.
---------
Co-authored-by: Brendan Clement <brendan.clement@lancedb.com>
43 lines
2.0 KiB
Plaintext
43 lines
2.0 KiB
Plaintext
---
|
|
title: "Tutorials"
|
|
sidebarTitle: "Overview"
|
|
description: "Worked examples of building with LanceDB, grouped by what they build."
|
|
---
|
|
|
|
Every tutorial is one page in the sidebar, grouped by what it builds. The
|
|
documentation explains how a feature works; these show it doing something.
|
|
|
|
Examples marked as notebooks live in the
|
|
[vectordb-recipes](https://github.com/lancedb/vectordb-recipes) repository and
|
|
are runnable in Colab; the rest are written up here.
|
|
|
|
## Where to start {#start}
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Search" icon="magnifying-glass" href="/tutorials/search/hybrid-search-beir">
|
|
Vector, multi-vector, hybrid and full-text retrieval.
|
|
</Card>
|
|
<Card title="RAG" icon="robot" href="/tutorials/agents/contextual-rag">
|
|
Retrieval-augmented generation and agent applications.
|
|
</Card>
|
|
<Card title="Feature engineering" icon="wand-magic-sparkles" href="/tutorials/feature-engineering/feature-engineering-101">
|
|
Deriving columns, materialized views, experimenting on branches.
|
|
</Card>
|
|
<Card title="Training" icon="graduation-cap" href="/training/object-detection">
|
|
Curating data and training models directly on a table.
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
## The features these use {#read-the-docs}
|
|
|
|
| Feature | What it covers |
|
|
|:--------|:------------|
|
|
| [Vector search](/search/vector-search) | Similarity search, distance metrics, and tuning it. |
|
|
| [Full-text search](/search/full-text-search) | Keyword search over text columns. |
|
|
| [Hybrid search](/search/hybrid-search) | Keyword and vector search combined. |
|
|
| [Multi-vector search](/search/vector-search) | Several embeddings per document. |
|
|
| [Reranking](/reranking) | Reordering results to improve the top-k. |
|
|
| [Feature engineering](/feature-engineering) | Deriving columns and tables from data already stored. |
|
|
| [Materialized views](/management/materialized-view) | A table defined by a query, brought up to date by each refresh. |
|
|
| [Training](/training/data-loading) | Reading a table into a data loader. |
|