Improve dataset card: Add task category, links, abstract, sample usage, and citation (#1)

- Improve dataset card: Add task category, links, abstract, sample usage, and citation (349f9159035e6953f1938a0a764c0e9a62a83af1)


Co-authored-by: Niels Rogge <[email protected]>

README.md

@@ -1,3 +1,97 @@
----
-license: apache-2.0
----
+---
+license: apache-2.0
+task_categories:
+- image-to-3d
+tags:
+- 3d-occupancy-prediction
+- robotics
+- scene-understanding
+- computer-vision
+---
+
+This repository contains the EmbodiedOcc-ScanNet dataset, which is a reorganized benchmark based on local annotations, designed to facilitate the evaluation of the embodied 3D occupancy prediction task. It accompanies the paper [EmbodiedOcc: Embodied 3D Occupancy Prediction for Vision-based Online Scene Understanding](https://huggingface.co/papers/2412.04380).
+
+Project page: https://ykiwu.github.io/EmbodiedOcc/
+Code: https://github.com/YkiWu/EmbodiedOcc
+
+## Paper Abstract
+
+3D occupancy prediction provides a comprehensive description of the surrounding scenes and has become an essential task for 3D perception. Most existing methods focus on offline perception from one or a few views and cannot be applied to embodied agents that demand to gradually perceive the scene through progressive embodied exploration. In this paper, we formulate an embodied 3D occupancy prediction task to target this practical scenario and propose a Gaussian-based EmbodiedOcc framework to accomplish it. We initialize the global scene with uniform 3D semantic Gaussians and progressively update local regions observed by the embodied agent. For each update, we extract semantic and structural features from the observed image and efficiently incorporate them via deformable cross-attention to refine the regional Gaussians. Finally, we employ Gaussian-to-voxel splatting to obtain the global 3D occupancy from the updated 3D Gaussians. Our EmbodiedOcc assumes an unknown (i.e., uniformly distributed) environment and maintains an explicit global memory of it with 3D Gaussians. It gradually gains knowledge through the local refinement of regional Gaussians, which is consistent with how humans understand new scenes through embodied exploration. We reorganize an EmbodiedOcc-ScanNet benchmark based on local annotations to facilitate the evaluation of the embodied 3D occupancy prediction task. Our EmbodiedOcc outperforms existing methods by a large margin and accomplishes the embodied occupancy prediction with high accuracy and efficiency.
+
+## Getting Started
+
+To utilize this dataset with the EmbodiedOcc framework, follow the data preparation and usage instructions below, derived from the [official GitHub repository](https://github.com/YkiWu/EmbodiedOcc).
+
+### Data Preparation
+
+1.  Prepare **posed_images** and **gathered_data** following the [Occ-ScanNet dataset](https://huggingface.co/datasets/hongxiaoy/OccScanNet) and move them to **data/occscannet**.
+2.  Download **global_occ_package** and **streme_occ_new_package** from this dataset repository (`EmbodiedOcc-ScanNet`). Unzip and move them to **data/scene_occ**.
+
+The expected folder structure within your `EmbodiedOcc` project directory should be:
+
+```
+EmbodiedOcc
+├── ...
+├── data/
+│   ├── occscannet/
+│   │   ├── gathered_data/
+│   │   ├── posed_images/
+│   │   ├── train_final.txt
+│   │   ├── train_mini_final.txt
+│   │   ├── test_final.txt
+│   │   ├── test_mini_final.txt
+│   ├── scene_occ/
+│   │   ├── global_occ_package/
+│   │   ├── streme_occ_new_package/
+│   │   ├── train_online.txt
+│   │   ├── train_mini_online.txt
+│   │   ├── test_online.txt
+│   │   ├── test_mini_online.txt
+```
+
+### Train
+
+After installing the environment as described in the [GitHub repository](https://github.com/YkiWu/EmbodiedOcc), you can train the models:
+
+1.  Train local occupancy prediction module using 8 GPUs on Occ-ScanNet and Occ-ScanNet-mini2:
+    ```bash
+    $ cd EmbodiedOcc
+    $ torchrun --nproc_per_node=8 train_mono.py --py-config config/train_mono_config.py
+    $ torchrun --nproc_per_node=8 train_mono.py --py-config config/train_mono_mini_config.py
+    ```
+2.  Train EmbodiedOcc using 8 GPUs on EmbodiedOcc-ScanNet and 4 GPUs on EmbodiedOcc-ScanNet-mini:
+    ```bash
+    $ cd EmbodiedOcc
+    $ torchrun --nproc_per_node=8 train_embodied.py --py-config config/train_embodied_config.py
+    $ torchrun --nproc_per_node=4 train_embodied.py --py-config config/train_embodied_mini_config.py
+    ```
+
+### Visualize
+
+1.  Local occupancy prediction:
+    ```bash
+    $ cd EmbodiedOcc
+    $ torchrun --nproc_per_node=1 vis_mono.py --work-dir workdir/train_mono 
+    $ torchrun --nproc_per_node=1 vis_mono.py --work-dir workdir/train_mono_mini
+    ```
+
+2.  Embodied occupancy prediction:
+    ```bash
+    $ cd EmbodiedOcc
+    $ torchrun --nproc_per_node=1 vis_embodied.py --work-dir workdir/train_embodied
+    $ torchrun --nproc_per_node=1 vis_embodied.py --work-dir workdir/train_embodied_mini
+    ```
+    Please use the same workdir path with training setting.
+
+## Citation
+
+If you find this project helpful, please consider citing the following paper:
+
+```bibtex
+@article{wu2024embodiedoccembodied3doccupancy,
+      title={EmbodiedOcc: Embodied 3D Occupancy Prediction for Vision-based Online Scene Understanding}, 
+      author={Yuqi Wu and Wenzhao Zheng and Sicheng Zuo and Yuanhui Huang and Jie Zhou and Jiwen Lu},
+      journal={arXiv preprint arXiv:2412.04380},
+      year={2024}
+}
+```