Overview
@dreamlake/viz visualizes robot-learning datasets in the browser. One
.dreamrc file at a dataset root renders every episode in it — LeRobot /
zarr / MCAP / plain folders; cameras, depth maps, point clouds, time series,
annotations and 3D reconstructions — all read in place over HTTP range
requests, never downloaded whole.
The design in one sentence: pre-built view components each declare an input
contract, format adapters normalize whatever is on disk into those contracts,
and the .dreamrc states which fields feed which views — the program never
decides what your data means. The full story:
the architecture.
The four parts
The docs are grouped the way the library is — pick the tab in the header, or start from here:
| part | what it is | start at |
|---|---|---|
| Dataset viz | The .dreamrc engine: one file at a dataset root names which fields feed which views; validate, resolve, render. The no-code path — and the primary way in. | Start here |
| Components | The underlying episode React components — video stack, line chart, timeline, frame stack, media overlays, 3D scene — for hosts embedding views directly. | EpisodeTimeline |
| Schema viz | The previous-generation, schema-driven viewer the platform still ships: sources (adapter + storage), panels, and auto-layout from a small schema. | Overview |
| File preview | Single-file preview used by the DreamLake file browser — pure loaders (CSV, Parquet, npy, MCAP, …), pure views, and ready-made composed containers. | FilePreview |
Choose your path
| you want | read |
|---|---|
| a dataset rendered, no code | start here — five steps from data to render |
to write a .dreamrc | write the .dreamrc · view components · reference |
| to embed the viewer in an app | TypeScript API · episode components |
| to prepare a dataset | prepare your data |
| working examples | templates · gallery |
| these docs, for your agent | LLM-readable docs |
What's in this package
| export | what it is |
|---|---|
@dreamlake/viz/dataset-viz | the .dreamrc engine: validate, resolve, render (docs) |
@dreamlake/viz/episode-*, …/media-overlay | the underlying episode components — video stack, line chart, timeline, frame stack, 3D scene (docs) |
@dreamlake/viz/file-preview | single-file preview used by the DreamLake file browser (docs) |
@dreamlake/viz/schema-viz | the previous-generation, schema-driven viewer the platform still ships (docs) |
The library is YAML-free (parse upstream) and credential-free (storage
drivers carry identifiers only); hosts extend every axis at runtime —
registerStorage, registerFormat, registerComponent
(TypeScript API).