Update README with LanceDB examples

README.md

@@ -3,6 +3,7 @@ license: cc-by-sa-4.0
 task_categories:
 - question-answering
 - text-retrieval
+- lance
 language:
 - en
 tags:
@@ -17,14 +18,14 @@ size_categories:
 ---
 # SQuAD v2 (Lance Format)
 
-Lance-formatted version of [SQuAD v2](https://huggingface.co/datasets/rajpurkar/squad_v2) — Stanford Question Answering Dataset, version 2 — with **MiniLM sentence embeddings** stored inline alongside the questions, contexts, and answers.
+A Lance-formatted version of [SQuAD v2](https://huggingface.co/datasets/rajpurkar/squad_v2) — the Stanford Question Answering Dataset with both answerable and deliberately unanswerable questions over Wikipedia passages — with MiniLM question embeddings stored inline and ready for retrieval at `hf://datasets/lance-format/squad-v2-lance/data`.
 
-## Why this version?
+## Key features
 
-- **One self-contained Lance dataset** with 130k+ Wikipedia-grounded questions and reference answers.
-- **Pre-computed text embeddings** (`sentence-transformers/all-MiniLM-L6-v2`, 384-dim, L2-normalized) on the question column with an `IVF_PQ` index — instant semantic question retrieval.
-- **Full-text inverted indices** on both `question` and `context` for keyword search.
-- **BITMAP** on `is_impossible` for fast filtering between answerable and unanswerable questions.
+- **Span-extraction QA over Wikipedia** with 130k+ training questions and an `is_impossible` flag that cleanly separates answerable from unanswerable items.
+- **Pre-computed 384-dim question embeddings** (`question_emb`, `sentence-transformers/all-MiniLM-L6-v2`, cosine-normalized) with a bundled `IVF_PQ` index for semantic question retrieval.
+- **Full-text inverted indices** on both `question` and `context` for keyword search alongside dense retrieval.
+- **One columnar dataset** carrying questions, contexts, answer spans, and embeddings together — project only the columns each query needs.
 
 ## Splits
 
@@ -37,7 +38,7 @@ Lance-formatted version of [SQuAD v2](https://huggingface.co/datasets/rajpurkar/
 
 | Column | Type | Notes |
 |---|---|---|
-| `id` | `string` | SQuAD question id |
+| `id` | `string` | SQuAD question id (natural join key for merges) |
 | `title` | `string` | Wikipedia article title |
 | `context` | `string` | Paragraph the question was generated from |
 | `question` | `string` | The question text |
@@ -48,85 +49,113 @@ Lance-formatted version of [SQuAD v2](https://huggingface.co/datasets/rajpurkar/
 
 ## Pre-built indices
 
-- `IVF_PQ` on `question_emb` — `metric=cosine`
-- `INVERTED` on `question` and `context`
-- `BTREE` on `id` and `title`
-- `BITMAP` on `is_impossible`
+- `IVF_PQ` on `question_emb` — `metric=cosine`, vector similarity search
+- `INVERTED` on `question` and `context` — full-text search
+- `BTREE` on `id` and `title` — point lookups and prefix scans
+- `BITMAP` on `is_impossible` — fast filtering between answerable and unanswerable
+
+## Why Lance?
+
+1. **Blazing Fast Random Access**: Optimized for fetching scattered rows, making it ideal for random sampling, real-time ML serving, and interactive applications without performance degradation.
+2. **Native Multimodal Support**: Store text, embeddings, and other data types together in a single file. Large binary objects are loaded lazily, and vectors are optimized for fast similarity search.
+3. **Native Index Support**: Lance comes with fast, on-disk, scalable vector and FTS indexes that sit right alongside the dataset on the Hub, so you can share not only your data but also your embeddings and indexes without your users needing to recompute them.
+4. **Efficient Data Evolution**: Add new columns and backfill data without rewriting the entire dataset. This is perfect for evolving ML features, adding new embeddings, or introducing moderation tags over time.
+5. **Versatile Querying**: Supports combining vector similarity search, full-text search, and SQL-style filtering in a single query, accelerated by on-disk indexes.
+6. **Data Versioning**: Every mutation commits a new version; previous versions remain intact on disk. Tags pin a snapshot by name, so retrieval systems and training runs can reproduce against an exact slice of history.
+
+## Load with `datasets.load_dataset`
 
-## Quick start
+You can load Lance datasets via the standard HuggingFace `datasets` interface, suitable when your pipeline already speaks `Dataset` / `IterableDataset` or you want a quick streaming sample.
 
 ```python
-import lance
+import datasets
 
-ds = lance.dataset("hf://datasets/lance-format/squad-v2-lance/data/validation.lance")
-print(ds.count_rows(), ds.schema.names, ds.list_indices())
+hf_ds = datasets.load_dataset("lance-format/squad-v2-lance", split="validation", streaming=True)
+for row in hf_ds.take(3):
+    print(row["question"], "->", row["answers"])
 ```
 
 ## Load with LanceDB
 
-These tables can also be consumed by [LanceDB](https://lancedb.github.io/lancedb/), the multimodal lakehouse and embedded search library built on top of Lance, for simplified vector search and other queries.
+LanceDB is the embedded retrieval library built on top of the Lance format ([docs](https://lancedb.com/docs)), and is the interface most users interact with. It wraps the dataset as a queryable table with search and filter builders, and is the entry point used by the Search, Curate, Evolve, Versioning, and Materialize-a-subset sections below.
 
 ```python
 import lancedb
 
 db = lancedb.connect("hf://datasets/lance-format/squad-v2-lance/data")
-tbl = db.open_table("validation")
-print(f"LanceDB table opened with {len(tbl)} questions")
+tbl = db.open_table("train")
+print(len(tbl))
 ```
 
-## Semantic question retrieval
+## Load with Lance
+
+`pylance` is the Python binding for the Lance format and works directly with the format's lower-level APIs. Reach for it when you want to inspect dataset internals — schema, scanner, fragments, the list of pre-built indices.
 
 ```python
 import lance
-import pyarrow as pa
-from sentence_transformers import SentenceTransformer
-
-encoder = SentenceTransformer("sentence-transformers/all-MiniLM-L6-v2", device="cuda")
-q_vec = encoder.encode(["what year was the eiffel tower built?"], normalize_embeddings=True)[0]
 
 ds = lance.dataset("hf://datasets/lance-format/squad-v2-lance/data/train.lance")
-emb_field = ds.schema.field("question_emb")
-query = pa.array([q_vec.tolist()], type=emb_field.type)
-
-hits = ds.scanner(
-    nearest={"column": "question_emb", "q": query[0], "k": 10, "nprobes": 16, "refine_factor": 30},
-    columns=["id", "title", "question", "answers"],
-).to_table().to_pylist()
+print(ds.count_rows(), ds.schema.names)
+print(ds.list_indices())
 ```
 
-### LanceDB semantic question retrieval
+> **Tip — for production use, download locally first.** Streaming from the Hub works for exploration, but heavy random access and ANN search are far faster against a local copy:
+> ```bash
+> hf download lance-format/squad-v2-lance --repo-type dataset --local-dir ./squad-v2-lance
+> ```
+> Then point Lance or LanceDB at `./squad-v2-lance/data`.
+
+## Search
+
+The bundled `IVF_PQ` index on `question_emb` turns semantic question retrieval into a single call. In production you would encode an incoming question through the same MiniLM encoder used at ingest and pass the resulting 384-dim vector to `tbl.search(...)`. The example below uses the embedding from row 42 as a runnable stand-in, then restricts the result to answerable items so the response always carries a usable span.
 
 ```python
 import lancedb
-from sentence_transformers import SentenceTransformer
-
-encoder = SentenceTransformer("sentence-transformers/all-MiniLM-L6-v2", device="cuda")
-q_vec = encoder.encode(["what year was the eiffel tower built?"], normalize_embeddings=True)[0]
 
 db = lancedb.connect("hf://datasets/lance-format/squad-v2-lance/data")
 tbl = db.open_table("train")
 
-results = (
-    tbl.search(q_vec.tolist(), vector_column_name="question_emb")
+seed = (
+    tbl.search()
+    .select(["question_emb", "question"])
+    .limit(1)
+    .offset(42)
+    .to_list()[0]
+)
+
+hits = (
+    tbl.search(seed["question_emb"], vector_column_name="question_emb")
     .metric("cosine")
+    .where("is_impossible = false", prefilter=True)
     .select(["id", "title", "question", "answers"])
     .limit(10)
     .to_list()
 )
+for r in hits:
+    print(f"{r['title']:30s} | {r['question'][:80]}")
 ```
 
-## Full-text search on contexts
+Because the recommended setup also builds an `INVERTED` index on both `question` and `context`, the same query can be issued as a hybrid search that combines the dense vector with a keyword query. LanceDB merges and reranks the two result lists in a single call, which is useful when a literal phrase must appear in the passage but the dense side should still drive ranking.
 
 ```python
-ds = lance.dataset("hf://datasets/lance-format/squad-v2-lance/data/train.lance")
-hits = ds.scanner(
-    full_text_query="great pyramid of giza",
-    columns=["title", "question", "context"],
-    limit=5,
-).to_table().to_pylist()
+hybrid_hits = (
+    tbl.search(query_type="hybrid")
+    .vector(seed["question_emb"])
+    .text("eiffel tower")
+    .where("is_impossible = false", prefilter=True)
+    .select(["id", "title", "question", "context", "answers"])
+    .limit(10)
+    .to_list()
+)
+for r in hybrid_hits:
+    print(f"{r['title']:30s} | {r['question'][:80]}")
 ```
 
-### LanceDB full-text search
+Tune `metric`, `nprobes`, and `refine_factor` on the vector side to trade recall against latency.
+
+## Curate
+
+SQuAD v2 has a natural split between answerable and unanswerable questions, and the `is_impossible` boolean — backed by a `BITMAP` index — makes either subset cheap to extract. Stacking predicates inside a single filtered scan keeps the result small and explicit, and the bounded `.limit(1000)` makes it easy to inspect or hand off.
 
 ```python
 import lancedb
@@ -134,46 +163,134 @@ import lancedb
 db = lancedb.connect("hf://datasets/lance-format/squad-v2-lance/data")
 tbl = db.open_table("train")
 
-results = (
-    tbl.search("great pyramid of giza")
-    .select(["title", "question", "context"])
-    .limit(5)
+impossible = (
+    tbl.search()
+    .where("is_impossible = true AND length(question) >= 40", prefilter=True)
+    .select(["id", "title", "question", "context"])
+    .limit(1000)
     .to_list()
 )
+print(f"{len(impossible)} hard unanswerable questions; first title: {impossible[0]['title']}")
 ```
 
-## Filter answerable vs impossible questions
+The mirror query — long, well-grounded answerable questions — looks identical with the boolean flipped, and the `question_emb` vector is never read by either scan. The result is a plain list of dictionaries, ready to inspect, persist as a manifest of question ids, or hand to the Materialize-a-subset section below for export to a writable local copy.
+
+## Evolve
+
+Lance stores each column independently, so a new column can be appended without rewriting the existing data. The lightest form is a SQL expression: derive the new column from columns that already exist, and Lance computes it once and persists it. The example below adds a `question_length`, a `num_answers` count, and a `has_answer` flag — any of which can then be used directly in `where` clauses without recomputing the predicate on every query.
+
+> **Note:** Mutations require a local copy of the dataset, since the Hub mount is read-only. See the Materialize-a-subset section at the end of this card for a streaming pattern that downloads only the rows and columns you need, or use `hf download` to pull the full corpus.
 
 ```python
-ds = lance.dataset("hf://datasets/lance-format/squad-v2-lance/data/validation.lance")
-impossible = ds.scanner(filter="is_impossible = true", columns=["question"], limit=5).to_table()
+import lancedb
+
+db = lancedb.connect("./squad-v2-lance/data")  # local copy required for writes
+tbl = db.open_table("train")
+
+tbl.add_columns({
+    "question_length": "length(question)",
+    "num_answers": "array_length(answers)",
+    "has_answer": "NOT is_impossible",
+})
+```
+
+If the values you want to attach already live in another table (offline reader-model predictions, alternate embeddings, span-level labels), merge them in by joining on `id`:
+
+```python
+import pyarrow as pa
+
+scores = pa.table({
+    "id": pa.array(["56be4db0acb8001400a502ec", "56be4db0acb8001400a502ed"]),
+    "reader_score": pa.array([0.91, 0.42]),
+})
+tbl.merge(scores, on="id")
 ```
 
-### Filter with LanceDB
+The original columns and indices are untouched, so existing code that does not reference the new columns continues to work unchanged. New columns become visible to every reader as soon as the operation commits. For column values that require a Python computation (e.g., running a different embedding model over the questions), Lance provides a batch-UDF API — see the [Lance data evolution docs](https://lance.org/guide/data_evolution/).
+
+## Train
+
+Projection lets a training loop read only the columns each step actually needs. LanceDB tables expose this through `Permutation.identity(tbl).select_columns([...])`, which plugs straight into the standard `torch.utils.data.DataLoader` so prefetching, shuffling, and batching behave as in any PyTorch pipeline. For a reading-comprehension model the natural projection is the question, the context, and the answer spans together; for a retriever or reranker on top of frozen features, project the precomputed embedding instead.
 
 ```python
 import lancedb
+from lancedb.permutation import Permutation
+from torch.utils.data import DataLoader
 
 db = lancedb.connect("hf://datasets/lance-format/squad-v2-lance/data")
-tbl = db.open_table("validation")
-impossible = (
-    tbl.search()
-    .where("is_impossible = true")
-    .select(["question"])
-    .limit(5)
-    .to_list()
+tbl = db.open_table("train")
+
+train_ds = Permutation.identity(tbl).select_columns(
+    ["question", "context", "answers", "answer_starts", "is_impossible"]
 )
+loader = DataLoader(train_ds, batch_size=32, shuffle=True, num_workers=4)
+
+for batch in loader:
+    # batch carries only the projected columns; question_emb stays on disk.
+    # tokenize question+context, build span labels from answer_starts, forward, backward...
+    ...
 ```
 
-## Why Lance?
+Switching feature sets is a configuration change: passing `["question_emb"]` (optionally with `["answers"]` for hard-negative mining) to `select_columns(...)` on the next run reads only the 384-d vectors and skips the bulky `context` strings entirely, which is the right shape for training a retrieval head or reranker on cached embeddings. Columns added in Evolve cost nothing per batch until they are explicitly projected.
+
+## Versioning
+
+Every mutation to a Lance dataset, whether it adds a column, merges labels, or builds an index, commits a new version. Previous versions remain intact on disk. You can list versions and inspect the history directly from the Hub copy; creating new tags requires a local copy since tags are writes.
+
+```python
+import lancedb
+
+db = lancedb.connect("hf://datasets/lance-format/squad-v2-lance/data")
+tbl = db.open_table("train")
+
+print("Current version:", tbl.version)
+print("History:", tbl.list_versions())
+print("Tags:", tbl.tags.list())
+```
+
+Once you have a local copy, tag a version for reproducibility:
+
+```python
+local_db = lancedb.connect("./squad-v2-lance/data")
+local_tbl = local_db.open_table("train")
+local_tbl.tags.create("baseline-v1", local_tbl.version)
+```
+
+A tagged version can be opened by name, or any version reopened by its number, against either the Hub copy or a local one:
+
+```python
+tbl_v1 = db.open_table("train", version="baseline-v1")
+tbl_v5 = db.open_table("train", version=5)
+```
+
+Pinning supports two workflows. A retrieval system locked to `baseline-v1` keeps returning stable results while the dataset evolves in parallel — newly added reader scores or labels do not change what the tag resolves to. A training experiment pinned to the same tag can be rerun later against the exact same questions and contexts, so changes in metrics reflect model changes rather than data drift. Neither workflow needs shadow copies or external manifest tracking.
+
+## Materialize a subset
+
+Reads from the Hub are lazy, so exploratory queries only transfer the columns and row groups they touch. Mutating operations (Evolve, tag creation) need a writable backing store, and a training loop benefits from a local copy with fast random access. Both can be served by a subset of the dataset rather than the full corpus. The pattern is to stream a filtered query through `.to_batches()` into a new local table; only the projected columns and matching row groups cross the wire, and the bytes never fully materialize in Python memory.
+
+```python
+import lancedb
+
+remote_db = lancedb.connect("hf://datasets/lance-format/squad-v2-lance/data")
+remote_tbl = remote_db.open_table("train")
+
+batches = (
+    remote_tbl.search()
+    .where("is_impossible = false AND length(question) >= 30")
+    .select(["id", "title", "context", "question", "answers", "answer_starts", "question_emb"])
+    .to_batches()
+)
+
+local_db = lancedb.connect("./squad-v2-answerable")
+local_db.create_table("train", batches)
+```
 
-- One dataset carries questions + contexts + answers + embeddings + indices — no sidecar files.
-- On-disk vector and full-text indices live next to the data, so search works on local copies and on the Hub.
-- Schema evolution: add columns (alternate embeddings, model predictions, task labels) without rewriting the data.
+The resulting `./squad-v2-answerable` is a first-class LanceDB database. Every snippet in the Search, Evolve, Train, and Versioning sections above works against it by swapping `hf://datasets/lance-format/squad-v2-lance/data` for `./squad-v2-answerable`.
 
 ## Source & license
 
-Converted from [`rajpurkar/squad_v2`](https://huggingface.co/datasets/rajpurkar/squad_v2). SQuAD v2 is released under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/).
+Converted from [`rajpurkar/squad_v2`](https://huggingface.co/datasets/rajpurkar/squad_v2). SQuAD v2 is distributed under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/).
 
 ## Citation
 
@@ -182,6 +299,6 @@ Converted from [`rajpurkar/squad_v2`](https://huggingface.co/datasets/rajpurkar/
   title={Know What You Don't Know: Unanswerable Questions for SQuAD},
   author={Rajpurkar, Pranav and Jia, Robin and Liang, Percy},
   journal={Proceedings of the 56th Annual Meeting of the Association for Computational Linguistics (Short Papers)},
-  year={2018},
+  year={2018}
 }
 ```