Add TsFile dataset card

README.md

@@ -1,3 +1,100 @@
----
-license: apache-2.0
----
+---
+license: apache-2.0
+authors:
+- makermods
+task_categories:
+- robotics
+tags:
+- tsfile
+- timeseries
+- tabular
+modality:
+- timeseries
+- tabular
+pretty_name: Sock 2 Only More Orange TsFile
+configs:
+- config_name: default
+  data_files:
+  - split: train
+    path: data/makermods_sock_2_only_more_orange.tsfile
+size_categories:
+- 10K<n<100K
+---
+
+# Sock 2 Only More Orange TsFile
+
+This repository presents the numeric time-series portion of
+[`makermods/sock_2_only_more_orange`](https://huggingface.co/datasets/makermods/sock_2_only_more_orange), a LeRobot v3.0
+SO follower robot dataset for putting a sock in the matching bin.
+
+## Source And Attribution
+
+- Original dataset and author: [makermods](https://huggingface.co/datasets/makermods/sock_2_only_more_orange)
+- Repository owner and uploader: [makermods](https://huggingface.co/makermods)
+- License: Apache-2.0
+- Task: `put sock in matching bin`
+- Split: `train`; 145 episodes, 49,791 frames, 1 task, sampled at 30 fps
+- Source numeric layout: `data/chunk-{chunk_index:03d}/file-{file_index:03d}.parquet`
+- The source card provides no paper, homepage, or completed citation.
+
+## Data Layout
+
+The `data/makermods_sock_2_only_more_orange.tsfile` table is `makermods_sock_2_only_more_orange`. It contains 49,791 rows
+over 145 episode devices. `Time` is `round(timestamp * 1000)` in milliseconds,
+starts at zero for each episode, and increases within each episode. The source
+`timestamp` column is omitted because it equals `Time / 1000` seconds.
+
+| Column | Role | Type | Source mapping |
+|---|---|---|---|
+| `Time` | TIME | TIMESTAMP | `round(timestamp * 1000)` ms |
+| `episode_index`, `task_index` | TAG | STRING | Original int64 columns |
+| `frame_index` | FIELD | INT64 | Preserved |
+| `sample_index` | FIELD | INT64 | Renamed from `index` |
+| `action_0` ... `action_5` | FIELD | FLOAT | Flattened from `action[6]` |
+| `observation_state_0` ... `observation_state_5` | FIELD | FLOAT | Flattened from `observation.state[6]` |
+
+The six action and state dimensions are, in order: `shoulder_pan.pos`,
+`shoulder_lift.pos`, `elbow_flex.pos`, `wrist_flex.pos`, `wrist_roll.pos`, and
+`gripper.pos`.
+
+## Storage Profile
+
+- FLOAT and DOUBLE: GORILLA + LZ4
+- INT32 and INT64: TS_2DIFF + LZ4
+- Time: TS_2DIFF + LZ4
+- BOOLEAN: RLE + LZ4
+- TAG: TsFile table/device TAG mechanism
+
+## Source Videos
+
+Videos remain exclusively in the original Hugging Face dataset and are not
+included here. The source paths are:
+
+- [`videos/observation.images.front/`](https://huggingface.co/datasets/makermods/sock_2_only_more_orange/tree/main/videos/observation.images.front)
+- [`videos/observation.images.wrist/`](https://huggingface.co/datasets/makermods/sock_2_only_more_orange/tree/main/videos/observation.images.wrist)
+
+Each stream is AV1, 640x480, 30 fps, without audio. Video files use
+`videos/{video_key}/chunk-{chunk_index:03d}/file-{file_index:03d}.mp4`.
+Use `episode_index`, `frame_index`, and the original episode metadata to align
+numeric samples with frames.
+
+## Read Example
+
+```python
+from tsfile import TsFileReader
+
+reader = TsFileReader("data/makermods_sock_2_only_more_orange.tsfile")
+with reader.query_table(
+    "makermods_sock_2_only_more_orange",
+    ["episode_index", "task_index", "frame_index", "sample_index", "action_0"],
+    batch_size=65536,
+) as result:
+    print(result.read_arrow_batch().to_pandas().head())
+reader.close()
+```
+
+## Citation
+
+The source dataset does not provide a paper or completed citation. Cite the
+original [`makermods/sock_2_only_more_orange`](https://huggingface.co/datasets/makermods/sock_2_only_more_orange) dataset and its
+repository owner, `makermods`.