Refactor config for the Release.

README.md

@@ -92,4 +92,4 @@ srun --cpus-per-task=4 --gres=gpumem:20G python -m vis4d.pl.run test \
 
 ## Contribute
 
-[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)

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:

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"
    ]
   },
   {

pyproject.toml

@@ -95,6 +95,7 @@ plugins = ["numpy.typing.mypy_plugin"]
         "terminaltables.*",
         "timm.*",
         "vis4d_cuda_ops.*",
+        "fvcore.*",
     ]
     ignore_missing_imports = true
 

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

tests/config/show_connection_test.py

@@ -2,16 +2,15 @@
 
 import unittest
 
-from tests.zoo.util import content_equal, get_config_for_name
+from tests.util import content_equal, get_test_file
+from tests.zoo.util import get_config_for_name
 from vis4d.config import instantiate_classes
 from vis4d.config.show_connection import prints_datagraph_for_config
 
 
 class TestShowConfig(unittest.TestCase):
     """Tests the content of the provided configs for Show."""
 
-    gt_config_path = "tests/vis4d-test-data/config_test"
-
     def test_show_frcnn(self) -> None:
         """Test the config for faster_rcnn_coco.py.
 
@@ -36,11 +35,7 @@ def test_show_frcnn(self) -> None:
             model, train_data_connector, test_data_connector, loss, callbacks
         )
 
-        with open(
-            f"{self.gt_config_path}/connection.txt",
-            "r",
-            encoding="UTF-8",
-        ) as f:
+        with open(get_test_file("connection.txt"), "r", encoding="UTF-8") as f:
             gt_dg = f.read()
 
         self.assertTrue(content_equal(dg, gt_dg))

tests/config/sweep/sweep_test.py → tests/config/sweep_test.py

@@ -6,8 +6,8 @@
 from ml_collections import ConfigDict
 
 from vis4d.config.replicator import replicate_config
+from vis4d.config.sweep import grid_search
 from vis4d.config.typing import ExperimentConfig
-from vis4d.config.util.sweep import grid_search
 
 
 class TestSweep(unittest.TestCase):

tests/config/testcases/connection.txt

@@ -0,0 +1,62 @@
+===================================
+=          Training Loop          =
+===================================
+                    --------------                 
+        <d>-boxes2d |            | *boxes2d        
+<d>-boxes2d_classes |            | *boxes2d_classes
+         <d>-images | Train Data | *images         
+       <d>-input_hw |            | *input_hw       
+                    --------------                 
+                  --------------                           
+         boxes2d* |            | <p>-proposals             
+ boxes2d_classes* |            | <p>-roi                   
+          images* |            | *<p>-rpn                  
+        input_hw* | FasterRCNN | <p>-sampled_proposals     
+      original_hw |            | <p>-sampled_target_indices
+                  |            | <p>-sampled_targets       
+                  --------------                           
+              -----------             
+ <p>-rpn.cls* |         | cls_outs    
+ <d>-input_hw |         | images_hw   
+ <p>-rpn.box* | RPNLoss | reg_outs    
+  <d>-boxes2d |         | target_boxes
+              -----------             
+                            ------------                
+<p>-sampled_proposals.boxes |          | boxes          
+ <p>-sampled_targets.labels |          | boxes_mask     
+          <p>-roi.cls_score |          | class_outs     
+          <p>-roi.bbox_pred | RCNNLoss | regression_outs
+  <p>-sampled_targets.boxes |          | target_boxes   
+<p>-sampled_targets.classes |          | target_classes 
+                            ------------                
+===================================
+=          Testing Loop           =
+===================================
+                -------------             
+     <d>-images |           | *images     
+   <d>-input_hw | Test Data | *input_hw   
+<d>-original_hw |           | *original_hw
+                -------------             
+                --------------              
+        boxes2d |            | <p>-boxes    
+boxes2d_classes |            | <p>-class_ids
+        images* | FasterRCNN | <p>-scores   
+      input_hw* |            |              
+   original_hw* |            |              
+                --------------              
+===================================
+=            Callbacks            =
+===================================
+                    -------------------------             
+          <p>-boxes |                       | *boxes      
+      <p>-class_ids |                       | *class_ids  
+   <d>-sample_names | BoundingBoxVisualizer | *image_names
+<d>-original_images |                       | *images     
+         <p>-scores |                       | *scores     
+                    -------------------------             
+                 -----------------------              
+<d>-sample_names |                     | coco_image_id
+       <p>-boxes |                     | pred_boxes   
+   <p>-class_ids | COCODetectEvaluator | pred_classes 
+      <p>-scores |                     | pred_scores  
+                 -----------------------              

tests/engine/callbacks/evaluator_test.py

@@ -7,11 +7,11 @@
 import torch
 
 from tests.util import MockModel, get_test_data
-from vis4d.config.common.datasets.coco import CONN_COCO_MASK_EVAL
 from vis4d.data.const import CommonKeys as K
 from vis4d.engine.callbacks import EvaluatorCallback, TrainerState
 from vis4d.engine.connectors import CallbackConnector
 from vis4d.eval.coco import COCODetectEvaluator
+from vis4d.zoo.base.datasets.coco import CONN_COCO_MASK_EVAL
 
 
 class TestEvaluatorCallback(unittest.TestCase):

tests/engine/callbacks/visualizer_test.py

@@ -7,11 +7,11 @@
 import torch
 
 from tests.util import MOCKLOSS, MockModel
-from vis4d.config.default.data_connectors import CONN_BBOX_2D_VIS
 from vis4d.data.const import CommonKeys as K
 from vis4d.engine.callbacks import TrainerState, VisualizerCallback
 from vis4d.engine.connectors import CallbackConnector
 from vis4d.vis.image import BoundingBoxVisualizer
+from vis4d.zoo.base.data_connectors import CONN_BBOX_2D_VIS
 
 
 class TestVisualizerCallback(unittest.TestCase):

tests/engine/optim/optimizer_test.py

@@ -13,8 +13,8 @@
 from tests.util import MockModel
 from vis4d.config import class_config
 from vis4d.config.typing import LrSchedulerConfig, ParamGroupCfg
-from vis4d.config.util import get_lr_scheduler_cfg, get_optimizer_cfg
 from vis4d.engine.optim import LRSchedulerWrapper, PolyLR, set_up_optimizers
+from vis4d.zoo.base import get_lr_scheduler_cfg, get_optimizer_cfg
 
 
 def get_optimizer(

tests/eval/common/depth_test.py

@@ -101,6 +101,6 @@ def test_precomputed(self) -> None:
             metrics[DepthEvaluator.KEY_ABS_REL], 1.208, places=3
         )
         self.assertAlmostEqual(
-            metrics[DepthEvaluator.KEY_SQ_REL], 4.007, places=3
+            metrics[DepthEvaluator.KEY_SQ_REL], 5.635, places=3
         )
         assert isinstance(log_str, str)

tests/eval/kitti/depth_test.py

@@ -82,6 +82,6 @@ def test_precomputed(self) -> None:
             metrics[KITTIDepthEvaluator.KEY_ABS_REL], 1.208, places=3
         )
         self.assertAlmostEqual(
-            metrics[KITTIDepthEvaluator.KEY_SQ_REL], 4.007, places=3
+            metrics[KITTIDepthEvaluator.KEY_SQ_REL], 5.635, places=3
         )
         assert isinstance(log_str, str)

tests/model/detect/mask_rcnn_test.py

@@ -7,11 +7,6 @@
 
 from tests.util import get_test_data, get_test_file
 from vis4d.common.ckpt import load_model_checkpoint
-from vis4d.config.common.models.mask_rcnn import (
-    CONN_MASK_HEAD_LOSS_2D,
-    CONN_ROI_LOSS_2D,
-    CONN_RPN_LOSS_2D,
-)
 from vis4d.data.const import CommonKeys as K
 from vis4d.data.datasets import COCO
 from vis4d.engine.connectors import LossConnector
@@ -29,6 +24,11 @@
 )
 from vis4d.op.detect.rcnn import RCNNLoss, get_default_rcnn_box_codec
 from vis4d.op.detect.rpn import RPNLoss, get_default_rpn_box_codec
+from vis4d.zoo.base.models.mask_rcnn import (
+    CONN_MASK_HEAD_LOSS_2D,
+    CONN_ROI_LOSS_2D,
+    CONN_RPN_LOSS_2D,
+)
 
 from .faster_rcnn_test import get_test_dataloader, get_train_dataloader
 

tests/op/base/resnet_test.py

@@ -50,12 +50,12 @@ def test_resnet():
 
             # test norm freezed
             model.trainable_layers = 5
-            model.norm_freezed = True
+            model.norm_frozen = True
             model.train()
             for m in model.modules():
                 if isinstance(m, _BatchNorm):
                     assert not m.training
-            model.norm_freezed = False
+            model.norm_frozen = False
             model.train()
             for m in model.modules():
                 if isinstance(m, _BatchNorm):

tests/pl/data_module_test.py

@@ -7,8 +7,8 @@
 from torch.utils.data.dataloader import DataLoader
 
 from tests.util import get_test_data
-from vis4d.config.common.datasets.coco import get_coco_detection_cfg
 from vis4d.pl.data_module import DataModule
+from vis4d.zoo.base.datasets.coco import get_coco_detection_cfg
 
 
 class DataModuleTest(unittest.TestCase):

tests/pl/trainer_test.py

@@ -12,7 +12,6 @@
 
 from tests.util import get_test_data
 from vis4d.config import class_config
-from vis4d.config.util import get_optimizer_cfg
 from vis4d.data.const import CommonKeys as K
 from vis4d.data.datasets import COCO
 from vis4d.data.loader import DataPipe, build_train_dataloader
@@ -38,6 +37,7 @@
 from vis4d.pl.callbacks import CallbackWrapper, LRSchedulerCallback
 from vis4d.pl.trainer import PLTrainer
 from vis4d.pl.training_module import TrainingModule
+from vis4d.zoo.base import get_optimizer_cfg
 
 
 def seg_pipeline(data: list[DictData]) -> DictData:

tests/util.py

@@ -366,3 +366,43 @@ def forward(  # type: ignore
                 ).sum()
             }
         return {}
+
+
+def content_equal(
+    content1: str, content2: str, ignored_props: list[str] | None = None
+) -> bool:
+    """Compare two strings line by line.
+
+    Args:
+        content1 (str): First file content
+        content2 (str): Second file content
+        ignored_props (list[str], optional): List of properties to ignore.
+            All lines matching any of these properties (followed by a ':')
+            will be ignored. Defaults to [].
+    """
+    if ignored_props is None:
+        ignored_props = []
+
+    lines1 = content1.splitlines()
+    lines2 = content2.splitlines()
+    if len(lines1) != len(lines2):
+        print("File length mismatch:", len(lines1), "!=", len(lines2))
+        return False
+
+    for line_id, line1 in enumerate(lines1):
+        skip = False
+        for prop in ignored_props:
+            # Append `:` to avoid matching a property that is a substring of
+            # another property
+            prop = prop + ":"
+            if prop in line1 and prop in lines2[line_id]:
+                skip = True
+                continue  # ignore these lines
+
+        if not skip and line1 != lines2[line_id]:
+            print(
+                "Line mismatch #", line_id, ":", line1, "!=", lines2[line_id]
+            )
+            return False
+
+    return True

tests/zoo/base/__init__.py

@@ -0,0 +1 @@
+"""Model zoo base test."""

tests/config/common/datasets/bdd100k/detect_test.py → tests/zoo/base/datasets/bdd100k/detect_test.py

@@ -4,11 +4,11 @@
 
 from tests.util import get_test_data
 from vis4d.config import instantiate_classes
-from vis4d.config.common.datasets.bdd100k.detect import (
+from vis4d.data.const import CommonKeys as K
+from vis4d.zoo.base.datasets.bdd100k.detect import (
     get_test_dataloader,
     get_train_dataloader,
 )
-from vis4d.data.const import CommonKeys as K
 
 
 class TestDetPreprocessing(unittest.TestCase):