Browse docs
Adapters
Choose an adapter to expose a format as fields, readable payloads and an optional timeline. These readers belong to the existing schema API; check Dataset readers for the recommended new integration path.
Supported datasets
| Data layout | adapter | Main options |
|---|---|---|
| LeRobot v2.0, v2.1 or v3.0 | lerobot | episode |
| UMI-style Zarr ReplayBuffer | umi or zarr | path, episode, fps |
| Supported Zarr v3 feature-manifest directory | umi or zarr | path |
| Video and annotation sidecars | egocentric | dataset profile or explicit lists |
| Directory of media and numeric files | filesystem | dir |
Choose storage independently. A reader can use a public HuggingFace repository or your application's storage driver.
Choosing an adapter
filesystem — a folder of loose files
Lists one directory. Media fields return URLs, CSV/Parquet become numeric series, and other files remain references. The source has no timeline.
dir defaults to ''. Listing uses the storage driver's capabilities; an HTTP
folder needs index.json. This adapter's CSV reader handles simple comma-separated
numeric files, not quoted CSV fields. It loads the text before selecting a time
range or sampling rows. The richer file-preview CSV loader
is a separate API.
lerobot — a manifest-indexed episode
Uses meta/info.json for camera and numeric fields. Dimension names appear in
meta.dims; task annotations can become cues. Episode metadata supplies
duration and frame rate.
episode defaults to 0. A vector feature such as action returns named columns;
a panel can select one using field: [action, left_waist].
For v3.0 datasets, this schema adapter searches episode metadata only in
meta/episodes/chunk-000/file-000.parquet. Episodes indexed elsewhere are not
supported by this reader.
umi / zarr — a Zarr ReplayBuffer
Reads concatenated episodes from data/<name> arrays, using
meta/episode_ends for boundaries. Numeric arrays yield series; supported
camera arrays yield frame sequences.
| Option | Default | Meaning |
|---|---|---|
path | '' | Archive or directory path, or absolute URL. |
episode | 0 | Episode selected from ReplayBuffer boundaries. |
fps | 60 | Time-axis frame rate; a v3 feature manifest can override it. |
Code UmiEpisodeSpec.tsx
Archive reads locate entries through the ZIP directory and request chunks. The server must support Range requests and browser access. Camera frames are loaded on demand, including supported JPEG-XL camera chunks. This example uses a public MV-UMI recording.
Folder mode + Zarr v3
A path ending in .zip selects archive access; other paths select a directory.
The supported v3 layout uses a root zarr.json with attributes.features,
fps and total_frames, with one episode per directory. The reader supports
the sharded, zstd-compressed arrays used by the EgoVerse example; it is not a
general reader for every Zarr codec or layout.
Code EgoVerseSpec.tsx
egocentric — media + sidecar annotations
Choose ego4d, egoexo4d or rh20t to discover a supported layout through
listable storage, or supply explicit files for a custom recording.
Code EgocentricSpec.tsx
This example includes illustrative narration data. To inspect another recording, point storage at a copy you can access.
Explicit lists select the files and their meanings. Supplied lists override the corresponding profile result:
Videos become camera tiles, annotations become cues, numeric NPY sidecars become
series, and listed images become frame sequences. Pose arrays produce pose3d
payloads, which use a metadata placeholder in this schema API.
The Ego-Exo4D example uses synchronized image sequences:
Code EgoExo4dSpec.tsx
The RH20T example reads joint positions and velocities from numeric sidecars:
Code Rh20tSpec.tsx
Writing your own adapter
Register a factory returning Model. This example reads a JSON signal:
Input: { "timestamps": [0, 1], "values": [2, 3] }. Validate real inputs and
implement caching or ReadQuery hints as needed; the interface does not enforce
partial reads or sampling.
A factory returns one model per source. You can also supply factories through
extensions.adapters; see the shared registration behavior.