Add CI (#42)

Author: Benedikt Mersch

.github/workflows/pre-commit.yml

@@ -0,0 +1,18 @@
+name: Style Check
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+
+jobs:
+  pre-commit:
+    name: Pre-commit checks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+      - uses: pre-commit/[email protected]

.github/workflows/python.yml

@@ -0,0 +1,24 @@
+name: Python API
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+
+jobs:
+  python_package:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-22.04, ubuntu-20.04]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup Python3
+        uses: actions/setup-python@v3
+      - name: Install dependencies
+        run: python -m pip install --upgrade pip
+      - name: Build pip package
+        run: python -m pip install --verbose .
+      - name: Test installation
+        run: mos4d_pipeline --help

.pre-commit-config.yaml

@@ -0,0 +1,18 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+    -   id: trailing-whitespace
+        exclude: \.patch$
+    -   id: end-of-file-fixer
+        exclude: \.patch$
+    -   id: check-yaml
+    -   id: check-added-large-files
+-   repo: https://github.com/psf/black
+    rev: 23.1.0
+    hooks:
+    -   id: black
+-   repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+     - id: isort

README.md

@@ -60,7 +60,7 @@ mos4d_pipeline --help
 ```
 to see how to run 4DMOS.
 
-Check the [Download](#downloads) section for a pre-trained model. Like [KISS-ICP](https://github.com/PRBonn/kiss-icp), our pipeline runs on a variety of point cloud data formats like `bin`, `pcd`, `ply`, `xyz`, `rosbags`, and more. To visualize these, just type 
+Check the [Download](#downloads) section for a pre-trained model. Like [KISS-ICP](https://github.com/PRBonn/kiss-icp), our pipeline runs on a variety of point cloud data formats like `bin`, `pcd`, `ply`, `xyz`, `rosbags`, and more. To visualize these, just type
 
 ```bash
 mos4d_pipeline --visualize /path/to/weights.ckpt /path/to/data

config/apollo.yaml

@@ -1,5 +1,5 @@
 data:
-  deskew: False 
+  deskew: False
 
 mos:
   max_range_mos: -1.0 # No limit

config/kitti-tracking.yaml

@@ -1,5 +1,5 @@
 data:
-  deskew: True 
+  deskew: True
 
 mos:
   max_range_mos: -1.0 # No limit

config/kitti.yaml

@@ -1,5 +1,5 @@
 data:
-  deskew: False 
+  deskew: False
 
 mos:
   max_range_mos: -1.0 # No limit

scripts/cache_to_ply.py

@@ -21,19 +21,19 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-import os
-import typer
 import importlib
+import os
+from pathlib import Path
+from typing import List, Optional
 
 import numpy as np
 import torch
-from typing import List, Optional
+import typer
 from torch.utils.data import DataLoader
 from tqdm import tqdm
-from pathlib import Path
 
-from mos4d.datasets.mos4d_dataset import MOS4DDataset, collate_fn
 from mos4d.config import load_config
+from mos4d.datasets.mos4d_dataset import MOS4DDataset, collate_fn
 
 
 def cache_to_ply(

scripts/precache.py

@@ -21,10 +21,11 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-from tqdm import tqdm
 from pathlib import Path
 from typing import List, Optional
+
 import typer
+from tqdm import tqdm
 
 from mos4d.config import load_config
 
@@ -62,8 +63,9 @@ def precache(
     ),
 ):
     from torch.utils.data import DataLoader
-    from mos4d.datasets.mos4d_dataset import collate_fn
+
     from mos4d.datasets.mos4d_dataset import MOS4DDataset as Dataset
+    from mos4d.datasets.mos4d_dataset import collate_fn
 
     cfg = load_config(config)
     sequences = list(sequence) if len(sequence) > 0 else cfg.training.train + cfg.training.val

scripts/train.py

@@ -22,16 +22,17 @@
 # SOFTWARE.
 
 import os
+from pathlib import Path
+from typing import Optional
+
 import torch
 import typer
-from typing import Optional
-from pathlib import Path
 from pytorch_lightning import Trainer
 from pytorch_lightning import loggers as pl_loggers
 from pytorch_lightning.callbacks import LearningRateMonitor, ModelCheckpoint
 
-from mos4d.utils.seed import set_seed
 from mos4d.config import load_config
+from mos4d.utils.seed import set_seed
 
 
 def train(