Add ModelConfiguration class (#3)

Co-authored-by: Albert Zeyer <[email protected]>
Co-authored-by: vieting <[email protected]>
Co-authored-by: SimBe195 <[email protected]>

Author: 4 people

.github/workflows/model_tests.yml

@@ -0,0 +1,26 @@
+name: model_tests
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+jobs:
+  test-jobs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          repository: "rwth-i6/i6_models"
+          path: ""
+      - uses: actions/setup-python@v2
+        with:
+          python-version: 3.7
+          cache: 'pip'
+      - run: |
+          pip install pytest
+          pip install -r requirements.txt
+      - name: Test Models
+        run: |
+          python -m pytest tests

i6_models/config.py

@@ -0,0 +1,37 @@
+"""
+Provides the base class for configurations, model configurations can be derived from this base class e.g:
+
+@dataclass
+class ExampleConfig(ModelConfiguration):
+    hidden_dim: int = 256
+    name: str = "Example Configuration"
+
+class ExampleModule(Module):
+    __init__(self, cfg: ExampleConfig)
+        self.hidden_dim = cfg.hidden_dim
+
+This config can then be used in the construction of the model to provide parameters.
+Similar approach as done in Fairseq: https://github.com/facebookresearch/fairseq/blob/main/fairseq/dataclass/configs.py
+"""
+
+from __future__ import annotations
+from dataclasses import dataclass, fields
+import typeguard
+
+
+@dataclass
+class ModelConfiguration:
+    """
+    Base dataclass for configuration of different primitives, parts and assemblies.
+    Enforces type checking for the creation of derived configs.
+    """
+
+    def _validate_types(self) -> None:
+        for field in fields(type(self)):
+            try:
+                typeguard.check_type(getattr(self, field.name), field.type)
+            except typeguard.TypeCheckError as exc:
+                raise typeguard.TypeCheckError(f'In field "{field.name}" of "{type(self)}": {exc}')
+
+    def __post_init__(self) -> None:
+        self._validate_types()

requirements.txt

@@ -0,0 +1 @@
+typeguard

tests/test_config.py

@@ -0,0 +1,60 @@
+from dataclasses import dataclass
+import pytest
+
+from i6_models.config import ModelConfiguration
+
+
+def test_simple_configuration():
+    @dataclass
+    class TestConfiguration(ModelConfiguration):
+        num_layers: int = 5
+        hidden_dim: int = 256
+        name: str = "Cool Model Configuration"
+
+    test_cfg = TestConfiguration(num_layers=12, name="Even Cooler Model Configuration")
+    assert test_cfg.hidden_dim == 256
+    assert test_cfg.name == "Even Cooler Model Configuration"
+    assert test_cfg.num_layers == 12
+    test_cfg.num_layers = 7
+    assert test_cfg.num_layers == 7
+
+
+def test_nested_configuration():
+    @dataclass
+    class TestConfiguration(ModelConfiguration):
+        num_layers: int = 5
+        hidden_dim: int = 256
+        name: str = "Cool Model Configuration"
+
+    @dataclass
+    class TestNestedConfiguration(ModelConfiguration):
+        encoder_config: TestConfiguration = TestConfiguration(num_layers=4, hidden_dim=3, name="encoder_config")
+        decoder_config: TestConfiguration = TestConfiguration(num_layers=6, hidden_dim=5, name="decoder_config")
+
+    dec_cfg = TestConfiguration()
+    test_cfg = TestNestedConfiguration(decoder_config=dec_cfg)
+
+    assert test_cfg.encoder_config.num_layers == 4
+    assert test_cfg.encoder_config.hidden_dim == 3
+    assert test_cfg.encoder_config.name == "encoder_config"
+    assert test_cfg.decoder_config.num_layers == 5
+    assert test_cfg.decoder_config.hidden_dim == 256
+    assert test_cfg.decoder_config.name == "Cool Model Configuration"
+    test_cfg.encoder_config = TestConfiguration(num_layers=1, hidden_dim=2, name="better_encoder_config")
+    assert test_cfg.encoder_config.num_layers == 1
+    assert test_cfg.encoder_config.hidden_dim == 2
+    assert test_cfg.encoder_config.name == "better_encoder_config"
+
+
+def test_config_typing():
+    @dataclass
+    class TestConfiguration(ModelConfiguration):
+        num_layers: int = 4
+        hidden_dim: int = 13
+        name: str = "Cool Model Configuration"
+
+    from typeguard import TypeCheckError
+
+    TestConfiguration(num_layers=2, hidden_dim=1)
+    with pytest.raises(TypeCheckError):
+        TestConfiguration(num_layers=2.0, hidden_dim="One")