[WIP] Continue work on Integration with DeepLabCut 3.0

.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:

.github/workflows/testing.yml

@@ -2,9 +2,8 @@ name: Run Tests
 
 on:
   push:
-    branches: [master]
+    branches: [main]
   pull_request:
-    branches: [master]
 
 jobs:
   build:
@@ -31,6 +30,14 @@ jobs:
         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
@@ -42,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 --extras "tf"
-          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]

README.md

@@ -73,10 +73,13 @@ same version (i.e., export a PyTorch model, then install PyTorch, export with TF
 then use TF1.13 with DlC-Live; export with TF2.3, then use TF2.3 with DLC-live).
 
 - available on pypi as: `pip install deeplabcut-live`
+
 
-Note, you can then test your installation by running:
+Note, you can then test your installation by installing poetry (`pip install poetry`), then running:
 
-`dlc-live-test`
+```python
+poetry run dlc-live-test
+```
 
 If installed properly, this script will i) create a temporary folder ii) download the
 full_dog model from the [DeepLabCut Model Zoo](

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

@@ -9,3 +9,4 @@
 from dlclive.dlclive import DLCLive
 from dlclive.processor.processor import Processor
 from dlclive.version import VERSION, __version__
+from dlclive.benchmark import benchmark_videos, download_benchmarking_data