mirror of
https://github.com/lancedb/lancedb.git
synced 2026-11-13 22:26:53 +00:00
A broad documentation pass across the areas LanceDB Enterprise and Embedded diverge on most: **Data Curation** -- GPU Function execution, Slurm scheduling (and what Slurm is, for readers new to it), blob late materialization as its own page, joins, aggregation/profiling, sampling, near-duplicate detection, chunking, distributed shuffle, and IVF-partition clustering. **Feature Engineering** -- computed columns and materialized views, restructured to lead with the Function-based path and show the SQL form side by side with Python throughout; a single Auto Refresh page instead of duplicating scheduling details on every refresh page; adaptive execution; checkpointing; GPU and Slurm placement for refresh workers; a Training Cache page for the PyTorch data loader's automatic cache benefit. **Security & Governance** -- an Audit Log reference (schema, access, grants), Secrets promoted to an ordinary catalog object with their own SQL DDL and a vending/rotation guide, and privilege-table fixes verified against the authorization source. **Deployment & Maintenance** -- Horizontal Scaling and OpenTelemetry moved into a real Deployment area; Automated Cleanup folded into Intelligent Auto-Maintenance (every other maintenance decision already lived there); RTE Compaction and Advanced Conflict Resolution documented in depth. **Landing page** -- the Enterprise feature comparison table reorganized (several redundant or stale rows removed, several new areas added), and the "why Enterprise" bullets replaced with ones tied to a concrete page (Performance, Scale, Fault tolerance, Multicloud deployment, Simplify operations) instead of vague promises. Plus a full pass addressing lancedb-gatekeeper's review: a real test-safety bug (a quickstart test could silently overwrite and delete a deployment's own `frames` table), a fabricated SQL statement with no backing implementation, an actual dedup-guarantee bug in `take_row_ids`, and dozens of documentation-accuracy fixes verified against source rather than taken on faith -- each either fixed, or left with an explicit note on why it needs a feature or deployment owner's sign-off instead of being guessed at. 🤖 Generated with [Claude Code](https://claude.com/claude-code) https://claude.ai/code/session_018PXMCbRH6i5w47TsjeEUMT --------- Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
183 lines
6.2 KiB
Plaintext
183 lines
6.2 KiB
Plaintext
---
|
|
title: "Profiling a dataset"
|
|
sidebarTitle: "Aggregate"
|
|
description: "Measure coverage, missing values and class balance before selecting a dataset."
|
|
icon: chart-column
|
|
keywords: ["aggregate", "group by", "class balance", "count", "profiling", "distinct"]
|
|
availability:
|
|
embedded: unavailable
|
|
enterprise: available
|
|
---
|
|
|
|
Use SQL aggregates to summarize a dataset: count records, find missing values,
|
|
and compare groups. These summaries help you understand the data before
|
|
selecting records for search, evaluation or training.
|
|
|
|
## Example data {#example-data}
|
|
|
|
Connect with an [Enterprise SQL client](/basics/sql). The examples use a small
|
|
document table and a separate label table. Expand the setup below to create them.
|
|
|
|
<Accordion title="Create the example tables">
|
|
|
|
`curation_documents` has six records describing four documents.
|
|
`curation_labels` has one label for each of three documents. `row_id` identifies
|
|
a record; `doc_id` identifies the document it describes.
|
|
|
|
Run each statement separately in a scratch database or namespace. Create these
|
|
tables once for the whole section, using fresh names if they already exist.
|
|
|
|
<CodeGroup>
|
|
```sql SQL icon="database"
|
|
CREATE TABLE curation_documents (
|
|
row_id BIGINT, doc_id BIGINT, version BIGINT,
|
|
source VARCHAR, caption VARCHAR, score DOUBLE
|
|
);
|
|
INSERT INTO curation_documents VALUES
|
|
(1, 10, 1, 'web', NULL, 0.80),
|
|
(2, 10, 2, 'web', 'A cat on a chair', 0.95),
|
|
(3, 20, 1, 'books', 'A dog in a field', 0.90),
|
|
(4, 30, 1, 'web', NULL, 0.70),
|
|
(5, 30, 1, 'web', 'A cat by a window', 0.85),
|
|
(6, 40, 1, 'books', 'A bird in a tree', 0.60);
|
|
|
|
CREATE TABLE curation_labels (doc_id BIGINT, label VARCHAR);
|
|
INSERT INTO curation_labels VALUES
|
|
(10, 'cat'), (20, 'dog'), (30, 'cat');
|
|
```
|
|
</CodeGroup>
|
|
|
|
`score` is a sample quality score, not a search result score. Document 10 has
|
|
two versions. Document 30 has two records at the same version. Document 40
|
|
has no label. These cases let you check the effect of each operation.
|
|
|
|
</Accordion>
|
|
|
|
## Count records and missing values {#size}
|
|
|
|
Use `count(*)` to count rows and `count(column)` to count non-null values.
|
|
Add `DISTINCT` to count unique values:
|
|
|
|
<CodeGroup>
|
|
```sql SQL icon="database"
|
|
SELECT count(*) AS records,
|
|
count(DISTINCT doc_id) AS documents,
|
|
count(caption) AS captioned,
|
|
count(*) FILTER (WHERE caption IS NULL) AS missing_caption
|
|
FROM curation_documents;
|
|
```
|
|
</CodeGroup>
|
|
|
|
The example returns **6 records, 4 documents, 4 populated captions and 2 missing
|
|
captions**. `count(column)` excludes null values; it does not check whether a
|
|
string is empty or whether a value is useful for the task.
|
|
|
|
## Group records by label {#balance}
|
|
|
|
Use `GROUP BY` to calculate a summary for each label:
|
|
|
|
<CodeGroup>
|
|
```sql SQL icon="database"
|
|
SELECT label, count(*) AS documents
|
|
FROM curation_labels
|
|
GROUP BY label
|
|
ORDER BY documents DESC, label;
|
|
```
|
|
</CodeGroup>
|
|
|
|
There are **2 cats and 1 dog** in the label table. Document 40 is absent, so this
|
|
query does not measure labeling coverage across all source documents. Use a
|
|
[left join](/curation/join#join-type) to find documents without labels.
|
|
|
|
Decide whether the distribution matches your intended use. A uniform random
|
|
sample tends to preserve the source distribution; it does not balance classes.
|
|
To cap the number selected per label, use
|
|
[ranking within a group](/curation/windowing#per-group).
|
|
|
|
## Count records that match a condition {#conditional}
|
|
|
|
<CodeGroup>
|
|
```sql SQL icon="database"
|
|
SELECT source,
|
|
count(*) AS records,
|
|
count(*) FILTER (WHERE score >= 0.9) AS high_score,
|
|
count(*) FILTER (WHERE caption IS NULL) AS missing_caption
|
|
FROM curation_documents
|
|
GROUP BY source
|
|
ORDER BY source;
|
|
```
|
|
</CodeGroup>
|
|
|
|
`FILTER` applies a condition to one aggregate. Here, `books` has 2 records,
|
|
1 high-score record and no missing captions. `web` has 4 records, 1 high-score
|
|
record and 2 missing captions. Counts are per record, so repeated document IDs
|
|
still contribute more than once.
|
|
|
|
<span id="distinct"></span>
|
|
## Group numeric values into ranges {#buckets}
|
|
|
|
Use `count(DISTINCT column)` for the number of distinct non-null values.
|
|
For numeric fields, group by a range or summarize their distribution. For
|
|
example, this query counts records in score buckets of width 0.1:
|
|
|
|
<CodeGroup>
|
|
```sql SQL icon="database"
|
|
SELECT floor(score * 10) / 10 AS score_bucket, count(*) AS records
|
|
FROM curation_documents
|
|
GROUP BY score_bucket
|
|
ORDER BY score_bucket;
|
|
```
|
|
</CodeGroup>
|
|
|
|
For time-based data, group by the time interval relevant to the task. The
|
|
[aggregation reference](/sql/dql/aggregation) and
|
|
[scalar function reference](/sql/dql/scalar-functions) cover additional summaries,
|
|
including approximate counts and percentiles. Use an approximate aggregate when an estimate is sufficient; use an exact
|
|
count when the result must be precise.
|
|
|
|
## Aggregate over a Function's result {#functions}
|
|
|
|
An aggregate can summarize a [Function](/curation/create-function)'s
|
|
output the same as any other expression -- the engine computes the
|
|
Function once per row, then aggregates. Register `caption_quality` the
|
|
same way any other curation Function is registered:
|
|
|
|
<CodeGroup>
|
|
```python Python icon="python"
|
|
from lancedb import udf
|
|
|
|
@udf
|
|
def caption_quality(caption: str) -> float:
|
|
... # score the caption, e.g. with a lightweight heuristic or model
|
|
|
|
db.create_function_async(caption_quality).wait()
|
|
```
|
|
|
|
```sql SQL icon="database"
|
|
SELECT source, avg(caption_quality(caption)) AS avg_quality
|
|
FROM curation_documents
|
|
WHERE caption IS NOT NULL
|
|
GROUP BY source
|
|
ORDER BY source;
|
|
```
|
|
</CodeGroup>
|
|
|
|
Filtering out null captions first avoids calling the Function on rows with
|
|
nothing to score.
|
|
|
|
## Profile a sample {#sampling}
|
|
|
|
A [sample](/curation/statistical-sampling) can help you explore a large dataset before a
|
|
full scan. Report the sample size and method alongside the result. A sample can miss rare classes, and fragment sampling can reflect the order
|
|
in which records were written.
|
|
|
|
Before accepting a curated dataset, check its required fields and key
|
|
constraints directly rather than inferring them from a small sample.
|
|
|
|
## Continue curating {#reference}
|
|
|
|
Use these measurements to choose a [sample](/curation/statistical-sampling),
|
|
[attach missing metadata](/curation/join), or
|
|
[select one record per document](/curation/windowing).
|
|
See [Aggregation](/sql/dql/aggregation) for complete SQL syntax.
|