[WIP] Integration with DeepLabCut 3.0 - PyTorch Engine

.github/workflows/python-package.yml

@@ -4,9 +4,9 @@ name: Python package
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
 
 
 jobs:
@@ -16,12 +16,12 @@ jobs:
     strategy:
       # You can use PyPy versions in python-version. For example, pypy2 and pypy3
       matrix:
-        python-version: [3.7, 3.8, 3.9]
+        python-version: ["3.10"]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
     # You can test your matrix by printing the current Python version

.github/workflows/testing.yml

@@ -1,8 +1,9 @@
 name: Run Tests
 
 on:
-  - push
-  - pull_request
+  push:
+    branches: [main]
+  pull_request:
 
 jobs:
   build:
@@ -11,24 +12,32 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, macos-11, windows-latest]
-        python-version: ["3.7", "3.8", "3.9", "3.10"] #3.9 only failing for tables on macos and windows; mwm 6302021
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.10"]
         include:
           - os: ubuntu-latest
             path: ~/.cache/pip
-          - os: macos-11
+          - os: macos-latest
             path: ~/Library/Caches/pip
           - os: windows-latest
             path: ~\AppData\Local\pip\Cache
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
+
+      - name: Set up Python
+        uses: conda-incubator/setup-miniconda@v3
+        with:
+          channels: conda-forge,defaults
+          channel-priority: strict
+          python-version: ${{ matrix.python-version }}
+
       - name: Install ffmpeg
         run: |
           if [ "$RUNNER_OS" == "Linux" ]; then
@@ -40,8 +49,27 @@ jobs:
             choco install ffmpeg
           fi
         shell: bash
+
       - name: Install and test
+        shell: bash -el {0}  # Important: activates the conda environment
         run: |
-          python -m pip install --upgrade pip wheel poetry
-          python -m poetry install
-          python -m poetry run dlc-live-test --nodisplay
+          conda install pytables==3.8.0 "numpy<2"
+
+      - name: Install dependencies via Conda
+        shell: bash -el {0}
+        run: conda install -y "numpy>=1.26,<2.0"
+
+      - name: Install Poetry
+        run: pip install --upgrade pip wheel poetry
+
+      - name: Regenerate Poetry lock
+        run: poetry lock --no-cache
+
+      - name: Install project dependencies
+        run: poetry install --with dev --extras "tf" --extras "pytorch"
+
+      - name: Run DLC Live Tests
+        run: poetry run dlc-live-test --nodisplay
+
+      - name: Run Functional Benchmark Test
+        run: poetry run pytest tests/test_benchmark_script.py

.gitignore

@@ -8,6 +8,8 @@ benchmarking/results*
 **DS_Store*
 *vscode*
 
+**/__MACOSX/
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -124,6 +126,10 @@ venv.bak/
 .spyderproject
 .spyproject
 
+# IDEs configurations
+.vscode/*
+.idea/*
+
 # Rope project settings
 .ropeproject
 

benchmarking/run_dlclive_benchmark.py

@@ -12,6 +12,7 @@
 import glob
 
 from dlclive import benchmark_videos, download_benchmarking_data
+from dlclive.engine import Engine
 
 datafolder = os.path.join(
     pathlib.Path(__file__).parent.absolute(), "Data-DLC-live-benchmark"
@@ -36,8 +37,22 @@
 if not os.path.isdir(out_dir):
     os.mkdir(out_dir)
 
-for m in dog_models:
-    benchmark_videos(m, dog_video, output=out_dir, n_frames=n_frames, pixels=pixels)
-
-for m in mouse_models:
-    benchmark_videos(m, mouse_video, output=out_dir, n_frames=n_frames, pixels=pixels)
+for model_path in dog_models:
+    benchmark_videos(
+        model_path=model_path,
+        model_type="base" if Engine.from_model_path(model_path) == Engine.TENSORFLOW else "pytorch",
+        video_path=dog_video,
+        output=out_dir,
+        n_frames=n_frames,
+        pixels=pixels
+    )
+
+for model_path in mouse_models:
+    benchmark_videos(
+        model_path=model_path,
+        model_type="base" if Engine.from_model_path(model_path) == Engine.TENSORFLOW else "pytorch",
+        video_path=mouse_video,
+        output=out_dir,
+        n_frames=n_frames,
+        pixels=pixels
+    )

dlclive/__init__.py

@@ -5,7 +5,8 @@
 Licensed under GNU Lesser General Public License v3.0
 """
 
-from dlclive.version import __version__, VERSION
+from dlclive.display import Display
 from dlclive.dlclive import DLCLive
-from dlclive.processor import Processor
-from dlclive.benchmark import benchmark, benchmark_videos, download_benchmarking_data
+from dlclive.processor.processor import Processor
+from dlclive.version import VERSION, __version__
+from dlclive.benchmark import benchmark_videos, download_benchmarking_data