mirror of
https://github.com/lancedb/lancedb.git
synced 2026-10-15 16:22:27 +00:00
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>
82 lines
3.7 KiB
Plaintext
82 lines
3.7 KiB
Plaintext
---
|
|
title: "Meta Llama Synthetic Data Kit"
|
|
sidebarTitle: "Synthetic Data Kit"
|
|
description: "Use Meta Llama's Synthetic Data Kit with LanceDB to generate high-quality synthetic datasets for LLM fine-tuning and training."
|
|
|
|
---
|
|
|
|
|
|
|
|
[Synthetic Data Kit](https://github.com/meta-llama/synthetic-data-kit) is a tool from Meta LLAMA that helps you generate high-quality synthetic datasets for fine-tuning large language models (LLMs). It simplifies the process of preparing data for fine-tuning by providing a command-line interface (CLI) with a modular four-command flow.
|
|
|
|
One of the key features of the `synthetic-data-kit` is its use of the Lance format for storing and ingesting datasets. This allows for efficient storage and retrieval of data, which is crucial when working with large datasets.
|
|
|
|
### Key Features: {#key-features}
|
|
|
|
* **Data Ingestion:** The toolkit can ingest various file formats, including PDF, HTML, YouTube transcripts, DOCX, PPT, and TXT.
|
|
* **Fine-tuning Format Creation:** It can create different fine-tuning formats, such as question-answer (QA) pairs, QA pairs with Chain-of-Thought (CoT), and summarization formats.
|
|
* **Data Curation:** The tool uses Llama as a judge to curate high-quality examples, ensuring the quality of the generated dataset.
|
|
* **Flexible Saving Options:** You can save the generated datasets in various formats compatible with your fine-tuning workflow, including Hugging Face, JSONL, and JSON.
|
|
|
|
### How it Works: {#how-it-works}
|
|
|
|
The synthetic-data-kit follows a simple four-step process:
|
|
|
|
1. **Ingest:** Import your input files into the toolkit. The data is stored in the Lance format for efficient processing.
|
|
2. **Create:** Generate diverse fine-tuning datasets, such as reasoning, summarization, and QA pairs, from the ingested documents.
|
|
3. **Curate:** Use Llama to filter and select high-quality examples from the generated dataset.
|
|
4. **Save-as:** Export the curated dataset in your preferred format.
|
|
|
|
### Usage {#usage}
|
|
|
|
The `synthetic-data-kit` uses Lance format to store and manage the data that you ingest. The workflow is a series of commands that build on each other, starting with the `ingest` command.
|
|
|
|
Here is an example of the end-to-end workflow:
|
|
|
|
1. **Ingest Data into a LanceDB dataset**
|
|
|
|
This command takes a directory of source files and creates a LanceDB dataset from them.
|
|
|
|
```bash
|
|
synthetic-data-kit ingest docs/report.pdf --multimodal
|
|
# This will create a Lance dataset at data/parsed/report.lance
|
|
# with 'text' and 'image' columns.
|
|
|
|
#Generate multimodal-qa pairs from the ingested data
|
|
synthetic-data-kit create data/parsed/report.lance --type multimodal-qa
|
|
```
|
|
|
|
2. **Create fine-tuning data**
|
|
|
|
This command uses the LanceDB dataset created in the previous step to generate synthetic data in the desired format.
|
|
|
|
```bash
|
|
synthetic_data create data/parsed/report.lance
|
|
```
|
|
|
|
3. **Curate the data**
|
|
|
|
This step uses a language model to curate the generated data and ensure its quality.
|
|
|
|
```bash
|
|
synthetic_data curate report.json
|
|
```
|
|
|
|
4. **Save the final dataset**
|
|
|
|
Finally, save the curated data to a file in the desired format.
|
|
|
|
```bash
|
|
synthetic_data save-as report.json --save_path ./my_finetuning_data.jsonl
|
|
```
|
|
|
|
This workflow allows you to go from a collection of documents to a high-quality, fine-tuning dataset with just a few commands. The use of LanceDB in the background makes the process efficient and scalable.
|
|
|
|
### Getting Started: {#getting-started}
|
|
|
|
To get started with the synthetic-data-kit, you can clone the [GitHub Repository](https://github.com/meta-llama/synthetic-data-kit) and install the necessary dependencies.
|
|
|
|
> **Note:** You will also need access to a Llama model, either running locally or via a hosted API.
|
|
|
|
|