Skip to content

Commit a71c9ef

Browse files
committed
docs(contribute): add instruction on how to add new network.
1 parent 78348f2 commit a71c9ef

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Task: Scene Flow Estimation in Autonomous Driving.
1111

1212
🔥 2024/07/02: Check the self-supervised version in our new ECCV'24 [SeFlow](https://github.com/KTH-RPL/SeFlow). The 1st ranking in new leaderboard among self-supervise methods.
1313

14-
Pre-trained weights for models are available in [Zenodo](https://zenodo.org/records/12632962) or [Onedrive link](https://hkustconnect-my.sharepoint.com/:f:/g/personal/qzhangcb_connect_ust_hk/Et85xv7IGMRKgqrVeJEVkMoB_vxlcXk6OZUyiPjd4AArIg?e=lqRGhx).
14+
Pre-trained weights for models are available in [Zenodo](https://zenodo.org/records/12632962).
1515
Check usage in [2. Evaluation](#2-evaluation) or [3. Visualization](#3-visualization).
1616

1717
**Scripts** quick view in our scripts:
@@ -25,6 +25,8 @@ Check usage in [2. Evaluation](#2-evaluation) or [3. Visualization](#3-visualiza
2525

2626
- `3_vis.py` : For visualization of the results with a video.
2727

28+
💡: Want to learn how to add your own network in this structure? Check [Contribute](assets/README.md#contribute) section and know more about the code.
29+
2830
## 0. Setup
2931

3032
**Environment**: Clone the repo and build the environment, check [detail installation](assets/README.md) for more information. [Conda](https://docs.conda.io/projects/miniconda/en/latest/)/[Mamba](https://github.com/mamba-org/mamba) is recommended.
@@ -81,13 +83,12 @@ python 1_train.py model=deflow lr=2e-6 epochs=50 batch_size=16
8183

8284
To help community benchmarking, we provide our weights including fastflow3d, deflow [Zendo](https://zenodo.org/records/12632962).
8385
These checkpoints also include parameters and status of that epoch inside it. If you are interested in weights of ablation studies, please contact us.
86+
8487
Note: Please use these weights by following the term of use of the trained dataset (since weights are trained on these datasets) as [Argoverse 2 Term of Use](https://www.argoverse.org/about.html) mentioned: Using it under Non-Commercially (CC BY-NC-SA 4.0).
8588

8689
## 2. Evaluation
8790

88-
You can view Wandb dashboard for the training and evaluation results or [run/submit to av2 leaderboard to get official results](assets/README.md#leaderboard-submission).
89-
90-
91+
You can view Wandb dashboard for the training and evaluation results or run/submit to av2 leaderboard to get official results follow below steps.
9192

9293
Since in training, we save all hyper-parameters and model checkpoints, the only thing you need to do is to specify the checkpoint path. Remember to set the data path correctly also.
9394
```bash

0 commit comments

Comments
 (0)