[CI] Tests (#10)

---------

Signed-off-by: Matteo Bettini <[email protected]>

.github/workflows/python-app.yml

@@ -0,0 +1,58 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see:
+# https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+
+name: pytest
+
+on:
+  push:
+    branches: [ $default-branch , "main" , "dev" ]
+  pull_request:
+    branches: [ $default-branch , "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.8", "3.9", "3.10"]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install flake8 pytest
+        python -m pip install vmas
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+        python -m pip install --pre torch --extra-index-url https://download.pytorch.org/whl/nightly/cpu --force-reinstall
+        
+        cd ..
+        python -m pip install git+https://github.com/pytorch-labs/tensordict.git
+        git clone https://github.com/pytorch/rl.git
+        cd rl
+        python setup.py develop
+        cd ../BenchMARL
+        
+        pip install -e .
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 benchmarl/ --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 benchmarl/ --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics --ignore=E203,W503
+    - name: Test with pytest
+      run: |
+        pip install pytest 
+        pip install pytest-cov
+        pip install tqdm
+        pytest test/ --doctest-modules --junitxml=junit/test-results.xml --cov=. --cov-report=xml --cov-report=html

benchmarl/algorithms/iddpg.py

@@ -1,8 +1,7 @@
 from dataclasses import dataclass, MISSING
-from typing import Dict, Optional, Type
+from typing import Dict, Optional, Tuple, Type
 
 import torch
-from black import Tuple
 from tensordict import TensorDictBase
 from tensordict.nn import TensorDictModule, TensorDictSequential
 from torchrl.data import (

benchmarl/algorithms/ippo.py

@@ -1,8 +1,7 @@
 from dataclasses import dataclass, MISSING
-from typing import Dict, Optional, Type
+from typing import Dict, Optional, Tuple, Type
 
 import torch
-from black import Tuple
 from tensordict import TensorDictBase
 from tensordict.nn import TensorDictModule, TensorDictSequential
 from tensordict.nn.distributions import NormalParamExtractor

benchmarl/algorithms/iql.py

@@ -1,8 +1,7 @@
 from dataclasses import dataclass, MISSING
-from typing import Dict, Optional, Type
+from typing import Dict, Optional, Type, Tuple
 
 import torch
-from black import Tuple
 from tensordict import TensorDictBase
 from tensordict.nn import TensorDictModule, TensorDictSequential
 from torchrl.data import (

benchmarl/algorithms/isac.py

@@ -1,8 +1,7 @@
 from dataclasses import dataclass, MISSING
-from typing import Dict, Optional, Type, Union
+from typing import Dict, Optional, Tuple, Type, Union
 
 import torch
-from black import Tuple
 from tensordict import TensorDictBase
 from tensordict.nn import NormalParamExtractor, TensorDictModule, TensorDictSequential
 from torch.distributions import Categorical

benchmarl/algorithms/maddpg.py

@@ -1,8 +1,7 @@
 from dataclasses import dataclass, MISSING
-from typing import Dict, Optional, Type
+from typing import Dict, Optional, Tuple, Type
 
 import torch
-from black import Tuple
 from tensordict import TensorDictBase
 from tensordict.nn import TensorDictModule, TensorDictSequential
 from torchrl.data import (

benchmarl/algorithms/mappo.py

@@ -1,8 +1,7 @@
 from dataclasses import dataclass, MISSING
-from typing import Dict, Optional, Type
+from typing import Dict, Optional, Tuple, Type
 
 import torch
-from black import Tuple
 from tensordict import TensorDictBase
 from tensordict.nn import TensorDictModule, TensorDictSequential
 from tensordict.nn.distributions import NormalParamExtractor

benchmarl/algorithms/masac.py

@@ -1,8 +1,7 @@
 from dataclasses import dataclass, MISSING
-from typing import Dict, Optional, Type, Union
+from typing import Dict, Optional, Tuple, Type, Union
 
 import torch
-from black import Tuple
 from tensordict import TensorDictBase
 from tensordict.nn import NormalParamExtractor, TensorDictModule, TensorDictSequential
 from torch.distributions import Categorical

benchmarl/algorithms/qmix.py

@@ -1,8 +1,7 @@
 from dataclasses import dataclass, MISSING
-from typing import Dict, Optional, Type
+from typing import Dict, Optional, Tuple, Type
 
 import torch
-from black import Tuple
 from tensordict import TensorDictBase
 from tensordict.nn import TensorDictModule, TensorDictSequential
 from torchrl.data import (

benchmarl/algorithms/vdn.py

@@ -1,8 +1,7 @@
 from dataclasses import dataclass, MISSING
-from typing import Dict, Optional, Type
+from typing import Dict, Optional, Tuple, Type
 
 import torch
-from black import Tuple
 from tensordict import TensorDictBase
 from tensordict.nn import TensorDictModule, TensorDictSequential
 from torchrl.data import (

benchmarl/models/__init__.py

@@ -1,3 +1,3 @@
-from models.mlp import MlpConfig
+from .mlp import MlpConfig
 
 model_config_registry = {"mlp": MlpConfig}

benchmarl/models/mlp.py

@@ -5,9 +5,9 @@
 from tensordict import TensorDictBase
 from torch import nn
 from torchrl.modules import MLP, MultiAgentMLP
-from utils import read_yaml_config
 
 from benchmarl.models.common import Model, ModelConfig, parse_model_config
+from benchmarl.utils import read_yaml_config
 
 
 class Mlp(Model):

examples/simple_hydra_run.py

@@ -2,7 +2,6 @@
 
 from benchmarl.environments import task_config_registry
 from benchmarl.experiment import Experiment
-
 from benchmarl.hydra_run import load_model_from_hydra_config
 from hydra.core.hydra_config import HydraConfig
 from omegaconf import DictConfig, OmegaConf

requirements.txt

@@ -1 +1 @@
-torchrl
+hydra-core

test/test_algorithms.py

@@ -1,12 +1,12 @@
 import pytest
-
 from benchmarl.algorithms import algorithm_config_registry
 from benchmarl.environments import VmasTask
 from benchmarl.experiment import Experiment, ExperimentConfig
 from benchmarl.hydra_run import load_experiment_from_hydra_config
 from benchmarl.models.common import SequenceModelConfig
 from benchmarl.models.mlp import MlpConfig
 from hydra import compose, initialize
+from torch import nn
 
 
 @pytest.mark.parametrize("algo_config", algorithm_config_registry.values())
@@ -15,8 +15,8 @@ def test_all_algos_balance(algo_config, continuous):
     task = VmasTask.BALANCE.get_from_yaml()
     model_config = SequenceModelConfig(
         model_configs=[
-            MlpConfig(num_cells=[8]),
-            MlpConfig(num_cells=[4]),
+            MlpConfig(num_cells=[8], activation_class=nn.Tanh, layer_class=nn.Linear),
+            MlpConfig(num_cells=[4], activation_class=nn.Tanh, layer_class=nn.Linear),
         ],
         intermediate_sizes=[5],
     )