Refactor config for the Release. (#136)

* feat: cleanup code for the release. * feat: Update test data. * feat: Support submission for nuscenes. * feat: Update config typing; refactor ResNet, transformer and CC-3DT related. * Updating QDTrack zoo * Remove old QDTrack config * Fix minor issue in config * Update test data * feat: Update readme and scripts. * update page * feat: Update pyproject and fix new linting. * feat: Update version. --------- Co-authored-by: Thomas Huang <[email protected]> Co-authored-by: zrene <[email protected]>
SysCV · May 15, 2024 · ab73be2 · ab73be2
1 parent b25086f
commit ab73be2
Show file tree

Hide file tree

Showing 215 changed files with 1,821 additions and 1,213 deletions.
diff --git a/.gitignore b/.gitignore
@@ -43,13 +43,9 @@ coverage/
 # downloaded repos and models
 scalabel/bot/experimental/*
 
-# python cache
-__pycache__/
-
 # python virtual environment
 env/
 
-
 # vscode workspace configuration
 *.code-workspace
 

diff --git a/README.md b/README.md
@@ -10,6 +10,12 @@
     A modular library for 4D scene understanding
 </p>
 
+## Quickstart
+
+You can checkout our [documentation](https://docs.vis.xyz/4d/index.html).
+
+You can use the [template](https://github.com/SysCV/vis4d-template) here to start your own project with Vis4D.
+
 ## Installation
 
 Installation is as easy as
@@ -26,20 +32,20 @@ python3 -m pip install vis4d
 
 ```bash
 # vis4d.engine
-python -m vis4d fit --config vis4d/zoo/faster_rcnn/faster_rcnn_coco.py --gpus 1
+vis4d fit --config vis4d/zoo/faster_rcnn/faster_rcnn_coco.py --gpus 1
 
 # vis4d.pl
-python -m vis4d.pl fit --config vis4d/zoo/faster_rcnn/faster_rcnn_coco.py --gpus 1
+vis4d-pl fit --config vis4d/zoo/faster_rcnn/faster_rcnn_coco.py --gpus 1
 ```
 
 - To test a model
 
 ```bash
 # vis4d.engine
-python -m vis4d test --config vis4d/zoo/faster_rcnn/faster_rcnn_coco.py --gpus 1
+vis4d test --config vis4d/zoo/faster_rcnn/faster_rcnn_coco.py --gpus 1
 
 # vis4d.pl
-python -m vis4d.pl test --config vis4d/zoo/faster_rcnn/faster_rcnn_coco.py --gpus 1
+vis4d-pl test --config vis4d/zoo/faster_rcnn/faster_rcnn_coco.py --gpus 1
 ```
 
 ## DDP
@@ -53,18 +59,17 @@ python -m vis4d.pl test --config vis4d/zoo/faster_rcnn/faster_rcnn_coco.py --gpu
 ./scripts/dist_train.sh <config-file> <num-gpus>
 
 # vis4d.pl
-python -m vis4d.pl fit --config <config-file> --gpus <num-gpus>
+vis4d-pl fit --config <config-file> --gpus <num-gpus>
 ```
 
-- SLURM batch job. Need to config the submission file.
+- SLURM
 
 ```bash
 # vis4d.engine
-sbatch scripts/slurm_train.sh
+srun vis4d fit --config <config-file> --gpus <num-gpus> --slurm True
 
 # vis4d.pl
-srun --cpus-per-task=4 --gres=gpumem:20G python -m vis4d.pl.run fit \
-    --config <config-file> --gpus <num-gpus>
+srun vis4d-pl fit --config <config-file> --gpus <num-gpus>
 ```
 
 ### Testing
@@ -76,20 +81,61 @@ srun --cpus-per-task=4 --gres=gpumem:20G python -m vis4d.pl.run fit \
 ./scripts/dist_test.sh <config-file> <num-gpus>
 
 # vis4d.pl
-python -m vis4d.pl test --config <config-file> --gpus <num-gpus>
+vis4d-pl test --config <config-file> --gpus <num-gpus>
 ```
 
-- SLURM batch job. Need to config the submission file.
+- SLURM
 
 ```bash
 # vis4d.engine
-sbatch scripts/slurm_test.sh
+srun vis4d test --config <config-file> --gpus <num-gpus> --slurm True
 
 # vis4d.pl
-srun --cpus-per-task=4 --gres=gpumem:20G python -m vis4d.pl.run test \
-    --config <config-file> --gpus <num-gpus>
+srun vis4d-pl test --config <config-file> --gpus <num-gpus>
 ```
 
-## Contribute
+## Acknowledgement
+Vis4D is a group effort by our team at ETH Zurich.
+[Yung-Hsu Yang](https://royyang0714.github.io/) built the current version and will be the main maintainer of the codebase.
+
+Vis4D was originally written by [Tobias Fischer](https://tobiasfshr.github.io/) during the first three years of his Ph.D. at ETH Zurich, [Thomas E. Huang](https://www.thomasehuang.com/) helped contribute many models, [Tao Sun](https://www.suniique.com/) implemented the ViT models and designed the evaluation pipeline, and[René Zurbrügg](https://github.com/renezurbruegg) designed the config system.
+
+
+## Contributors
+**Project Leads**
+- [Yung-Hsu Yang](https://royyang0714.github.io/)*
+- [Tobias Fischer](https://tobiasfshr.github.io/)*
+
+**Core Contributors**
+- [Thomas E. Huang](https://www.thomasehuang.com/)
+- [Tao Sun](https://www.suniique.com/)
+- [René Zurbrügg](https://renezurbruegg.github.io/)
+
+**Advisors**
+- [Fisher Yu](https://www.yf.io/)
+
+`*` denotes equal contribution
+
+**We are open to contributions and suggestions, feel free to reach out to us.**
 
-[Check out our contribution guidelines for this project](docs/source/contribute.rst)
+[Check out our contribution guidelines for this project](docs/source/dev_guide/contribute.rst)
+
+**Community Contributors**
+
+<a href="https://github.com/SysCV/vis4d/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=SysCV/vis4d" />
+</a>
+
+
+## Citation
+
+If you find Vis4D is useful for your research, please consider citing the following BibTeX entry.
+
+```bibtex
+@misc{vis4d_2024,
+  author = {{Yung-Hsu Yang and Tobias Fischer and Thomas E. Huang} and René Zurbrügg and Tao Sun and Fisher Yu},
+  title = {Vis4D},
+  howpublished = {\url{https://github.com/SysCV/vis4d}},
+  year = {2024}
+}
+```
diff --git a/docs/source/user_guide/faster_rcnn_example.py b/docs/source/user_guide/faster_rcnn_example.py
@@ -2,38 +2,40 @@
 """Faster RCNN COCO training example."""
 from __future__ import annotations
 
+import tempfile
+
 import lightning.pytorch as pl
 import numpy as np
-import tempfile
 from torch.optim import SGD
 from torch.optim.lr_scheduler import LinearLR, MultiStepLR
 
 from vis4d.config import class_config
-from vis4d.config.common.datasets.coco import (
-    CONN_COCO_BBOX_EVAL,
-    get_coco_detection_cfg,
-)
-from vis4d.config.common.models import get_faster_rcnn_cfg
-from vis4d.config.default import (
-    get_default_callbacks_cfg,
-    get_default_cfg,
-    get_default_pl_trainer_cfg,
-)
-from vis4d.config.default.data_connectors import (
-    CONN_BBOX_2D_TEST,
-    CONN_BBOX_2D_TRAIN,
-)
 from vis4d.config.typing import (
     ExperimentConfig,
     ExperimentParameters,
     ParameterSweepConfig,
 )
-from vis4d.config.util import get_lr_scheduler_cfg, get_optimizer_cfg
-from vis4d.config.util.sweep import grid_search
+from vis4d.config.sweep import grid_search
 from vis4d.engine.callbacks import EvaluatorCallback
 from vis4d.engine.connectors import CallbackConnector, DataConnector
 from vis4d.eval.coco import COCODetectEvaluator
 from vis4d.op.base import ResNet
+from vis4d.zoo.base import (
+    get_default_callbacks_cfg,
+    get_default_cfg,
+    get_default_pl_trainer_cfg,
+    get_lr_scheduler_cfg,
+    get_optimizer_cfg,
+)
+from vis4d.zoo.base.data_connectors import (
+    CONN_BBOX_2D_TEST,
+    CONN_BBOX_2D_TRAIN,
+)
+from vis4d.zoo.base.datasets.coco import (
+    CONN_COCO_BBOX_EVAL,
+    get_coco_detection_cfg,
+)
+from vis4d.zoo.base.models.faster_rcnn import get_faster_rcnn_cfg
 
 
 def get_config() -> ExperimentConfig:

diff --git a/docs/source/user_guide/getting_started.ipynb b/docs/source/user_guide/getting_started.ipynb
@@ -254,7 +254,7 @@
     "from vis4d.vis.functional.image import imshow_bboxes\n",
     "\n",
     "from vis4d.config import instantiate_classes\n",
-    "from vis4d.config.common.datasets.coco import get_coco_detection_cfg"
+    "from vis4d.zoo.base.datasets.coco import get_coco_detection_cfg"
    ]
   },
   {

diff --git a/docs/source/user_guide/install.rst b/docs/source/user_guide/install.rst
@@ -5,7 +5,7 @@ Installation
 =======
 Package
 =======
-We currently support Python 3.9+ and PyTorch 1.10.0+.
+We currently support Python 3.10+ and PyTorch 2.0.0+.
 
 We recommand to install in a new virtual environment, e.g. conda or virtualenv.
 
@@ -30,15 +30,24 @@ If you want to build the package from source and specify CUDA version, you can c
     git clone https://github.com/SysCV/vis4d.git
     cd vis4d
 
-    python3 -m pip install -r requirements/install.txt -f https://download.pytorch.org/whl/cu117/torch_stable.html
-    python3 -m pip install -r requirements/torch-lib.txt
+    python3 -m pip install -r requirements/install.txt -f https://download.pytorch.org/whl/cu118/torch_stable.html
     python3 -m pip install -e .
 
 More information about torch and pytorch-lightning installation
 
 - `PyTorch <https://pytorch.org/get-started/locally>`_
 - `PyTorch Lightning <https://lightning.ai/docs/pytorch/latest/>`_
 
+-----------------------
+Install CUDA Operations
+-----------------------
+
+Some functionalities in the library require CUDA operations. You can install them by running:
+
+.. code:: bash
+
+    python3 -m pip install -r requirements/torch-lib.txt
+
 ================
 Directory Layout
 ================

diff --git a/pyproject.toml b/pyproject.toml
@@ -95,6 +95,7 @@ plugins = ["numpy.typing.mypy_plugin"]
         "terminaltables.*",
         "timm.*",
         "vis4d_cuda_ops.*",
+        "fvcore.*",
     ]
     ignore_missing_imports = true
 
@@ -111,12 +112,12 @@ plugins = ["numpy.typing.mypy_plugin"]
 
 [project]
 name = "vis4d"
-version = "0.0"
+version = "0.1.2"
 authors = [{name = "VIS @ ETH", email = "[email protected]"}]
 description = "Vis4D Python package for Visual 4D scene understanding"
 readme = "README.md"
-license = { text="Apache 2.0"}
-requires-python = ">=3.9.0"
+license = {text = "Apache 2.0"}
+requires-python = ">=3.10"
 classifiers = [
     "Programming Language :: Python :: 3",
     "License :: OSI Approved :: Apache Software License",
@@ -134,7 +135,7 @@ dependencies = {file = ["requirements/install.txt"]}
 include = ["vis4d*"]
 
 [project.urls]
-"Documentation" = "https://vis.xyz/4d/"
+"Documentation" = "https://docs.vis.xyz/4d"
 "Source" = "https://github.com/syscv/vis4d"
 "Tracker" = "https://github.com/syscv/"
 

diff --git a/requirements/install.txt b/requirements/install.txt
@@ -19,8 +19,8 @@ tensorboard
 termcolor
 terminaltables
 timm>=0.6.0
-torch>=1.10
-torchvision>=0.11
+torch>=2.0.0
+torchvision>=0.15.1
 tqdm
 utm
 wheel

diff --git a/scripts/install_gpu_conda.sh b/scripts/install_gpu_conda.sh
@@ -4,7 +4,7 @@ source $CONDA_PATH/etc/profile.d/conda.sh
 
 if [ -z "$1" ]
 then
-    CUDA_VERSION=11.7
+    CUDA_VERSION=11.8
 else
     CUDA_VERSION=$1
 fi
@@ -14,4 +14,4 @@ conda activate vis4d-dev
 conda install cudatoolkit=$CUDA_VERSION -c pytorch -c nvidia
 python3 -m pip install -r requirements/install.txt -f https://download.pytorch.org/whl/cu${CUDA_VERSION//.}/torch_stable.html
 python3 -m pip install -r requirements/torch-lib.txt
-python3 setup.py develop
+pip install -e .
diff --git a/scripts/slurm_test.sh b/scripts/slurm_test.sh
diff --git a/scripts/slurm_train.sh b/scripts/slurm_train.sh
diff --git a/tests/config/common/__init__.py b/tests/config/common/__init__.py
diff --git a/tests/config/registry_test.py b/tests/config/registry_test.py
@@ -7,7 +7,7 @@
 import pytest
 
 from tests.util import get_test_data
-from vis4d.config.util.registry import get_config_by_name, register_config
+from vis4d.config.registry import get_config_by_name, register_config
 
 
 class TestRegistry(unittest.TestCase):
@@ -16,7 +16,7 @@ class TestRegistry(unittest.TestCase):
     def test_yaml(self) -> None:
         """Test reading a yaml config file."""
         file = get_test_data(
-            "config_test/bdd100k/faster_rcnn/faster_rcnn_r50_1x_bdd100k.yaml"
+            "zoo_test/bdd100k/faster_rcnn/faster_rcnn_r50_1x_bdd100k.yaml"
         )
 
         # Config can be resolved