PointWorld-BEHAVIOR / README.md
kmo-nvidia's picture
Add PointWorld BEHAVIOR README
331325e verified
# **PointWorld-BEHAVIOR**
## **Dataset Description:**
PointWorld-BEHAVIOR is the packaged BEHAVIOR-derived annotation release used for training and evaluating the 3D world model PointWorld. It contains precomputed 3D annotations derived from BEHAVIOR simulation episodes, organized as episode-level HDF5 files that store robot state, camera parameters, initial RGB-D observations, and rigid-body scene geometry annotations.
This Hugging Face repository hosts the packaged release, not the original BEHAVIOR raw episodes nor the prebuilt WebDataset shards. After download, users should restore the packaged archives to the canonical HDF5 layout. From there, they can either use the files directly as 3D annotations or follow the PointWorld repository workflow for integrity checking, conversion, training, and evaluation.
This dataset is for research and development only.
## **Dataset Owner(s):**
NVIDIA Corporation
## **Dataset Creation Date:**
04/15/2026
## **License/Terms of Use:**
NVIDIA License
## **Intended Usage:**
This release is intended for research and development in world modeling, 3D vision, and robotic manipulation.
It is intended for two common use cases:
1. Using the restored data with the released PointWorld codebase, and
2. Using the restored 3D annotations directly, for example to access depth, camera poses, visibility masks, or tracked 3D point trajectories without using the PointWorld training pipeline.
## **Dataset Characterization**
Data Collection Method: Synthetic
Labeling Method: Synthetic
## **Dataset Format**
The release is distributed in two layers:
1. Packaged Hugging Face download artifacts:
* Split compressed archives package.tar.zst.part-\*
* Restore helper script recover\_dataset\_from\_parts.sh
2. Restored dataset contents:
* Episode-level HDF5 files (.hdf5)
Restored canonical layout:
```
behavior/
flows/
task-0000/
episode_*.hdf5
task-0001/
episode_*.hdf5
...
```
Local conversion to WebDataset train/test shards is supported by the PointWorld repository tooling.
## **Dataset Quantification**
Current release package counts inspected from the restored release tree:
* 7,842 episode-level episode\_\*.hdf5 files
* 50 canonical task directories in the restored layout
* 43 populated task directories in the current packaged release
* Restored size on disk: Appx 1.55 TB
* Packaged download size: Appx 718 GB
Each episode file contains multiple clip groups keyed as "{start}:{end}", so the corpus contains substantially more clips than files.
Measurement of Total Data Storage: 718GB
## **Reference(s):**
* Project Website: [https://point-world.github.io/](https://point-world.github.io/)
* Paper: [https://arxiv.org/abs/2601.03782](https://arxiv.org/abs/2601.03782)
* Code: [https://github.com/NVlabs/PointWorld](https://github.com/NVlabs/PointWorld)
* Original BEHAVIOR Project: [https://behavior.stanford.edu/](https://behavior.stanford.edu/)
* BEHAVIOR raw episode reference: [https://huggingface.co/datasets/behavior-1k/2025-challenge-rawdata](https://huggingface.co/datasets/behavior-1k/2025-challenge-rawdata)
* Planned release location: NVIDIA Hugging Face PointWorld-BEHAVIOR
## **Ethical Considerations:**
NVIDIA believes Trustworthy AI is a shared responsibility and we have established policies and practices to enable development for a wide array of AI applications. When downloaded or used in accordance with the applicable terms of service, developers should work with their internal developer teams to ensure this dataset meets requirements for the relevant industry and use case and addresses unforeseen product misuse.
Please report quality, risk, security vulnerabilities or NVIDIA AI Concerns [here](https://www.nvidia.com/en-us/support/submit-security-vulnerability/).
## **Packaged Release Layout**
The packaged release is sharded by task. Typical archive paths are:
* behavior/flows/task-0000/package.tar.zst.part-\*
* behavior/flows/task-0001/package.tar.zst.part-\*
## **Restoring The Packaged Release**
```shell
huggingface-cli download nvidia/PointWorld-BEHAVIOR \
--repo-type dataset \
--local-dir /path/to/PointWorld-BEHAVIOR
cd /path/to/PointWorld-BEHAVIOR
bash recover_dataset_from_parts.sh \
--packages . \
--out /path/to/pointworld_behavior_restored \
--threads 0
```
After restoration, the canonical dataset root is:
```
/path/to/pointworld_behavior_restored/behavior
```
## **Use With The Released PointWorld Code**
For end-to-end instructions on integrity checking, HDF5-to-WebDataset conversion, training, and evaluation, please use the [PointWorld GitHub repository](https://github.com/NVlabs/PointWorld).
## **Direct Use Of The 3D Annotations**
If you only want the annotations and do not plan to use the PointWorld training code, the restored HDF5 files can be read directly.
Each BEHAVIOR file is an episode-level HDF5 file under:
```
behavior/flows/task-XXXX/episode_YYYYYYYY.hdf5
```
Clip groups are stored under keys of the form "{start}:{end}".
### **Per-clip non-camera datasets**
Typical robot-state fields include:
* world\_to\_robot: (4, 4\) float32
* base\_pose: (T, 7\) float32
* left\_gripper\_open: (T, 1\) bool
* left\_gripper\_pose: (T, 7\) float32
* left\_is\_grasping: (T, 1\) bool
* right\_gripper\_open: (T, 1\) bool
* right\_gripper\_pose: (T, 7\) float32
* right\_is\_grasping: (T, 1\) bool
* joint\_names: (J,) string array
* joint\_positions: (T, J) float32
### **Per-camera groups**
Each clip contains camera groups such as:
* camera\_head
* camera\_left
* camera\_right
Each camera group contains:
* initial\_rgb: (1,) HDF5 object dataset containing JPEG bytes
* initial\_depth: (180, 320\) uint16 depth in millimeters
* intrinsic: (3, 3\) float32
* extrinsic: (4, 4\) float32
* extrinsic\_trajectory: (T, 4, 4\) float32
* local\_scene\_points: group mapping mesh\_name \-\> (N\_i, 3\) float16
* local\_scene\_colors: group mapping mesh\_name \-\> (N\_i, 3\) uint8
* local\_scene\_normals: group mapping mesh\_name \-\> (N\_i, 3\) int8
* scene\_mesh\_trajectories: group mapping mesh\_name \-\> (T, 7\) float32
Unlike PointWorld-DROID, PointWorld-BEHAVIOR does not store one dense scene\_flows array for the whole scene. Instead, it stores mesh-local point samples plus a rigid pose trajectory for each mesh over time. This is more storage-efficient for simulated rigid-body scenes while still allowing exact reconstruction of per-frame scene geometry.
## **Reconstructing Per-Frame Scene Geometry**
To recover per-frame points for a given camera and timestep:
1. Read local\_scene\_points\[mesh\_name\]
2. Read the mesh pose from scene\_mesh\_trajectories\[mesh\_name\]\[t\]
3. Apply the pose to the local points
4. Concatenate meshes if you want a single scene point cloud
The same mesh keys are shared across:
* local\_scene\_points
* local\_scene\_colors
* local\_scene\_normals
* scene\_mesh\_trajectories
## **Reading The Files In Python**
```py
import io
import h5py
import numpy as np
from PIL import Image
def decode_jpeg_object(entry) -> np.ndarray:
if isinstance(entry, np.ndarray):
jpeg_bytes = entry.astype(np.uint8, copy=False).tobytes()
elif isinstance(entry, (bytes, bytearray, memoryview)):
jpeg_bytes = bytes(entry)
elif hasattr(entry, "tobytes"):
jpeg_bytes = entry.tobytes()
else:
jpeg_bytes = bytes(entry)
return np.array(Image.open(io.BytesIO(jpeg_bytes)).convert("RGB"))
path = "/path/to/pointworld_behavior_restored/behavior/flows/task-0000/episode_00000000.hdf5"
with h5py.File(path, "r") as f:
clip_key = sorted([k for k in f.keys() if ":" in k])[0]
clip = f[clip_key]
cam = clip["camera_head"]
rgb = decode_jpeg_object(cam["initial_rgb"][0])
depth_m = cam["initial_depth"][:].astype(np.float32) / 1000.0
mesh_name = sorted(cam["local_scene_points"].keys())[0]
local_points = cam["local_scene_points"][mesh_name][:].astype(np.float32)
local_colors = cam["local_scene_colors"][mesh_name][:]
local_normals = cam["local_scene_normals"][mesh_name][:].astype(np.float32) / 127.0
mesh_pose_traj = cam["scene_mesh_trajectories"][mesh_name][:].astype(np.float32)
```
## **Data Notes**
* initial\_rgb decodes to standard RGB image values in \[0, 255\].
* initial\_depth is stored as uint16 millimeters. Convert to meters with depth\_mm.astype(np.float32) / 1000.0.
* local\_scene\_normals are stored as int8 using \[-127, 127\] quantization. A typical decode is normals\_i8.astype(np.float32) / 127.0.
* scene\_mesh\_trajectories stores per-mesh pose trajectories over time; the same mesh names index local\_scene\_points, local\_scene\_colors, and local\_scene\_normals.
* HDF5 internal compression is transparent to readers after restoration; no extra decompression step is needed in user code.
## **Citation**
If you use this dataset, please cite the PointWorld paper and the original BEHAVIOR dataset.
```
@article{huang2026pointworld,
title={PointWorld: Scaling 3D World Models for In-The-Wild Robotic Manipulation},
author={Huang, Wenlong and Chao, Yu-Wei and Mousavian, Arsalan and Liu, Ming-Yu and Fox, Dieter and Mo, Kaichun and Li, Fei-Fei},
journal={arXiv preprint arXiv:2601.03782},
year={2026}
}
```