Config Registry

pyproject.toml

@@ -140,3 +140,4 @@ include = ["vis4d*"]
 [project.scripts]
 vis4d = "vis4d.engine.run:entrypoint"
 vis4d-pl = "vis4d.pl.run:entrypoint"
+vis4d-zoo = "vis4d.zoo.run:entrypoint"

tests/common/dict_test.py

@@ -2,12 +2,20 @@
 
 import unittest
 
-from vis4d.common.dict import get_dict_nested, set_dict_nested
+from vis4d.common.dict import flatten_dict, get_dict_nested, set_dict_nested
 
 
 class TestDictUtils(unittest.TestCase):
     """Test cases for array conversion ops."""
 
+    def test_flatten_dict(self) -> None:
+        """Tests the flatten_dict function."""
+        d = {"a": {"b": {"c": 10}}}
+        self.assertEqual(flatten_dict(d, "."), ["a.b.c"])
+
+        d = {"a": {"b": {"c": 10, "d": 20}}}
+        self.assertEqual(flatten_dict(d, "/"), ["a/b/c", "a/b/d"])
+
     def test_set_dict_nested(self) -> None:
         """Tests the set_dict_nested function."""
         d = {}  # type:ignore

tests/config/registry_test.py

@@ -0,0 +1,71 @@
+"""Test config registry."""
+from __future__ import annotations
+
+import unittest
+
+import pytest
+
+from tests.util import get_test_data
+from vis4d.config.util.registry import get_config_by_name, register_config
+
+
+class TestRegistry(unittest.TestCase):
+    """Test the config registry."""
+
+    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"
+        )
+
+        # Config can be resolved
+        config = get_config_by_name(file)
+        self.assertTrue(config is not None)
+
+        # Config does not exist
+        with pytest.raises(ValueError) as err:
+            config = get_config_by_name(file.replace("r50", "r91"))
+        self.assertTrue("Could not find" in str(err.value))
+
+    def test_py(self) -> None:
+        """Test reading a py config file from the model zoo."""
+        file = "/bdd100k/faster_rcnn/faster_rcnn_r50_1x_bdd100k.py"
+        cfg = get_config_by_name(file)
+        self.assertTrue(cfg is not None)
+
+        # Only by file name
+        file = "faster_rcnn_r50_1x_bdd100k.py"
+        cfg = get_config_by_name(file)
+        self.assertTrue(cfg is not None)
+
+        # Check did you mean message
+        file = "faster_rcnn_r90_1x_bdd100k"
+        with pytest.raises(ValueError) as err:
+            cfg = get_config_by_name(file)
+        self.assertTrue("faster_rcnn_r50_1x_bdd100k" in str(err.value))
+
+    def test_zoo(self) -> None:
+        """Test reading a registered config from the zoo."""
+        config = get_config_by_name("faster_rcnn_r50_1x_bdd100k")
+        self.assertTrue(config is not None)
+
+        # Full Qualified Name
+        config = get_config_by_name("bdd100k/faster_rcnn_r50_1x_bdd100k")
+        self.assertTrue(config is not None)
+
+        # Check did you mean message
+        with pytest.raises(ValueError) as err:
+            config = get_config_by_name("faster_rcnn_r90_1x_bdd100k")
+        self.assertTrue("faster_rcnn_r50_1x_bdd100k" in str(err.value))
+
+    def test_decorator(self) -> None:
+        """Test registering a config."""
+
+        @register_config("cat", "test")  # type: ignore
+        def get_config() -> dict[str, str]:
+            """Test config."""
+            return {"test": "test"}
+
+        config = get_config_by_name("cat/test")
+        self.assertTrue(config is not None)
+        self.assertEqual(config["test"], "test")

vis4d/common/dict.py

@@ -6,6 +6,35 @@
 from vis4d.common import DictStrAny
 
 
+def flatten_dict(dictionary: DictStrAny, seperator: str) -> list[str]:
+    """Flatten a nested dictionary.
+
+    Args:
+        dictionary (DictStrAny): The dictionary to flatten.
+        seperator (str): The seperator to use between keys.
+
+    Returns:
+        List[str]: A list of flattened keys.
+
+    Examples:
+        >>> d = {'a': {'b': {'c': 10}}}
+        >>> flatten_dict(d, '.')
+        ['a.b.c']
+    """
+    flattened = []
+    for key, value in dictionary.items():
+        if isinstance(value, dict):
+            flattened.extend(
+                [
+                    f"{key}{seperator}{subkey}"
+                    for subkey in flatten_dict(value, seperator)
+                ]
+            )
+        else:
+            flattened.append(key)
+    return flattened
+
+
 def get_dict_nested(  # type: ignore
     dictionary: DictStrAny, keys: list[str], allow_missing: bool = False
 ) -> Any:

vis4d/common/imports.py

@@ -37,6 +37,9 @@ def package_available(package_name: str) -> bool:
 OPEN3D_AVAILABLE = package_available("open3d")
 PLOTLY_AVAILABLE = package_available("plotly")
 
+# vis4d cuda ops
+VIS4D_CUDA_OPS_AVAILABLE = package_available("vis4d_cuda_ops")
+
 # logging
 TENSORBOARD_AVAILABLE = package_available("tensorboardX") or package_available(
     "tensorboard"

vis4d/common/util.py

@@ -1,5 +1,6 @@
 """Utility functions for common usage."""
 import random
+from difflib import get_close_matches
 
 import numpy as np
 import torch
@@ -8,6 +9,30 @@
 from .logging import rank_zero_warn
 
 
+def create_did_you_mean_msg(keys: list[str], query: str) -> str:
+    """Create a did you mean message.
+
+    Args:
+        keys (list[str]): List of available keys.
+        query (str): Query.
+
+    Returns:
+        str: Did you mean message.
+
+    Examples:
+        >>> keys = ["foo", "bar", "baz"]
+        >>> query = "fo"
+        >>> print(create_did_you_mean_msg(keys, query))
+        Did you mean:
+            foo
+    """
+    msg = ""
+    if len(keys) > 0:
+        msg = "Did you mean:\n\t"
+        msg += "\n\t".join(get_close_matches(query, keys, cutoff=0.75))
+    return msg
+
+
 def set_tf32(use_tf32: bool = False) -> None:  # pragma: no cover
     """Set torch TF32.