XiaoHongbo-Hope commented on code in PR #9676:
URL: https://github.com/apache/paimon/pull/9676#discussion_r3951032500
##########
docs/docs/pypaimon/multimodal-api.mdx:
##########
@@ -616,32 +616,39 @@ orphan files for normal Paimon cleanup.
## Load LeRobot Dataset v3
`load_from_lerobot` imports a local directory, FileIO URI, or Hugging Face
-repository. It derives the schema from `meta/info.json`, writes one row per
-frame, and creates a LeRobot dataset backed by the frame table,
-`<table>__versions`, `<table>__episodes`, `<table>__tasks`, and an optional
-`<table>__subtasks`. Task text remains in the metadata table; frames retain
-`task_index`. After all components are committed and tagged with the same
-numeric `version_id`, one row is appended to `<table>__versions` to publish the
-version.
+repository. It derives the schema from `meta/info.json` and writes one row per
+frame. The import creates `<table>__episodes`, `<table>__tasks`,
`<table>__info`,
+and optional `<table>__stats` and `<table>__subtasks` companion tables. Task
text
+remains in the task table; frames retain `task_index`.
+
+Info and stats use `key STRING, value STRING`: each top-level info property or
+stats feature becomes one row. Each value is JSON-encoded, preserving nested
+objects, arrays, nulls, and scalar types. Decode it with `json.loads`; for
example,
+`fps` stores `30`, while `codebase_version` stores `"v3.0"` (including quotes).
+Statistics may contain `NaN` and `Infinity`, supported by Python's JSON
decoder.
+Missing or empty stats create no stats table. The frame table's
+`pypaimon.lerobot.<component>-table` options identify the components created.
```shell
pip install 'pypaimon[lerobot]'
```
```python
-version_id = conn.load_from_lerobot(
+snapshot_id = conn.load_from_lerobot(
"robot_data",
"/data/lerobot_dataset",
+ tag_name="initial-import", # Optional: tag all imported component
snapshots.
)
-print(version_id)
```
-The returned `version_id` is the common tag name for all dataset components.
+The return value is the frame table's committed snapshot ID. Omitting
`tag_name`
+imports the tables without creating tags. The one-time importer requires a new
target table and
+a non-empty source dataset; subsequent table edits use the normal Paimon APIs.
For FileIO URIs, pass credentials through `source_options`:
```python
-version_id = conn.load_from_lerobot(
+snapshot_id = conn.load_from_lerobot(
Review Comment:
Just return None?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
