Skip to content

Commit 9c465a2

Browse files
committed
docs(README): update commands for submit result to leaderboard.
* prepare flow4d info also.
1 parent dd377fa commit 9c465a2

2 files changed

Lines changed: 36 additions & 5 deletions

File tree

README.md

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,11 @@
1313
OpenSceneFlow is a codebase for point cloud scene flow estimation.
1414
It is also an official implementation of the following paper (sored by the time of publication):
1515

16+
<!-- - **Flow4D: Leveraging 4D Voxel Network for LiDAR Scene Flow Estimation**
17+
*Jaeyeul Kim, Jungwan Woo, Ukcheol Shin, Jean Oh, Sunghoon Im*
18+
IEEE Robotics and Automation Letters (**RA-L**) 2025
19+
[ Backbone ] [ Supervised ] - [ [arXiv](https://arxiv.org/abs/2407.07995) ] [ [Project](https://github.com/dgist-cvlab/Flow4D) ] &rarr; [here](#flow4d) -->
20+
1621
- **SSF: Sparse Long-Range Scene Flow for Autonomous Driving**
1722
*Ajinkya Khoche, Qingwen Zhang, Laura Pereira Sánchez, Aron Asefaw, Sina Sharif Mansouri and Patric Jensfelt*
1823
International Conference on Robotics and Automation (**ICRA**) 2025
@@ -105,11 +110,11 @@ docker run -it --gpus all -v /dev/shm:/dev/shm -v /home/kin/data:/home/kin/data
105110

106111
## 1. Data Preparation
107112

108-
Check [dataprocess/README.md](dataprocess/README.md#argoverse-20) for downloading tips for the raw Argoverse 2 dataset.
109-
Or maybe you want to have the **mini processed dataset** to try the code quickly, We directly provide one scene inside `train` and `val`.
113+
Check [dataprocess/README.md](dataprocess/README.md#argoverse-20) for downloading tips for the raw Argoverse 2 dataset and [data preprocessed to h5 files commands](dataprocess/README.md#process).
114+
Another good way to try code quickly is using **mini processed dataset**, we directly provide one scene inside `train` and `val`.
110115
It already converted to `.h5` format and processed with the label data.
111116
You can download it from [Zenodo](https://zenodo.org/records/13744999/files/demo_data.zip)/[HuggingFace](https://huggingface.co/kin-zhang/OpenSceneFlow/blob/main/demo_data.zip) and extract it to the data folder.
112-
Then you can directly use demo data to run the [training script](#2-quick-start).
117+
Then you can directly use this mini processed demo data to run the [training script](#2-quick-start).
113118

114119
```bash
115120
wget https://huggingface.co/kin-zhang/OpenSceneFlow/resolve/main/demo_data.zip
@@ -118,6 +123,10 @@ unzip demo_data.zip -p /home/kin/data/av2
118123

119124
## 2. Quick Start
120125

126+
<!-- ### Flow4D -->
127+
128+
<!-- ### SSF -->
129+
121130
### SeFlow
122131

123132
Train SeFlow needed to specify the loss function, we set the config of our best model in the leaderboard. [Runtime: Around 11 hours in 4x A100 GPUs.]
@@ -159,9 +168,22 @@ python eval.py checkpoint=/home/kin/seflow_best.ckpt av2_mode=test leaderboard_v
159168
python eval.py checkpoint=/home/kin/seflow_best.ckpt av2_mode=test leaderboard_version=2
160169
```
161170

162-
<!-- And the terminal will output the command for you to submit the result to the online leaderboard. You can follow [this section for evalai](https://github.com/KTH-RPL/DeFlow?tab=readme-ov-file#2-evaluation).
171+
To submit to the Online Leaderboard, if you select `av2_mode=test`, it should be a zip file for you to submit to the leaderboard.
172+
Note: The leaderboard result in DeFlow&SeFlow main paper is [version 1](https://eval.ai/web/challenges/challenge-page/2010/evaluation), as [version 2](https://eval.ai/web/challenges/challenge-page/2210/overview) is updated after DeFlow&SeFlow.
163173

164-
Check all detailed result files (presented in our paper Table 1) in [this discussion](https://github.com/KTH-RPL/DeFlow/discussions/2). -->
174+
```bash
175+
# since the env may conflict we set new on deflow, we directly create new one:
176+
mamba create -n py37 python=3.7
177+
mamba activate py37
178+
pip install "evalai"
179+
180+
# Step 2: login in eval and register your team
181+
evalai set-token <your token>
182+
183+
# Step 3: Copy the command pop above and submit to leaderboard
184+
evalai challenge 2010 phase 4018 submit --file av2_submit.zip --large --private
185+
evalai challenge 2210 phase 4396 submit --file av2_submit_v2.zip --large --private
186+
```
165187

166188
## 4. Visualization
167189

dataprocess/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,15 @@ python dataprocess/extract_av2.py --av2_type sensor --data_mode train --argo_dir
123123
python dataprocess/extract_waymo.py --mode train --flow_data_dir /home/kin/data/waymo/flowlabel --map_dir /home/kin/data/waymo/flowlabel/map --output_dir /home/kin/data/waymo/preprocess --nproc 48
124124
```
125125

126+
127+
Extract all Argoverse 2.0 data to unified `.h5` format.
128+
[Runtime: Normally need 45 mins finished run following commands totally in setup mentioned in our paper]
129+
```bash
130+
python dataprocess/extract_av2.py --av2_type sensor --data_mode train --argo_dir /home/kin/data/av2 --output_dir /home/kin/data/av2/preprocess_v2
131+
python dataprocess/extract_av2.py --av2_type sensor --data_mode val --mask_dir /home/kin/data/av2/3d_scene_flow
132+
python dataprocess/extract_av2.py --av2_type sensor --data_mode test --mask_dir /home/kin/data/av2/3d_scene_flow
133+
```
134+
126135
All these preprocess scripts will generate the same format `.h5` file. The file contains the following in codes:
127136

128137
File: `[*:logid].h5` file named in logid. Every timestamp is the key of group (f[key]).

0 commit comments

Comments
 (0)