Merge pull request #5 from jeylau/main

Minor improvements, fixes and addition of GitHub's CI workflow

Author: AlexEMG

.github/workflows/test_package.yml

@@ -0,0 +1,33 @@
+name: Test suite
+
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: true
+      matrix:
+        os: [ubuntu-latest, macos-11, windows-latest]
+        python-version: [3.9]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install pytest
+          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+
+      - name: Run pytest tests
+        run: |
+          pytest

.gitignore

@@ -130,3 +130,4 @@ dmypy.json
 .pyre/
 
 *DS_STORE
+.vscode/*

dlclibrary/modelzoo_urls.yaml

@@ -12,8 +12,8 @@
 
 
 #Model Zoo from HuggingFace
-full_human: mwmathis/DeepLabCutModelZoo-DLC_human_fullbody_resnet_101/DLC_human_fullbody_resnet_101.tar.gz
-full_human_commit: 7438131c2ee7754a9732bef6fbf46b8189a16c48
+full_human: mwmathis/DeepLabCutModelZoo-DLC_human_fullbody_resnet_101/DLC_human_dancing_resnet_101_iteration-0_shuffle-1.tar.gz
+full_human_commit: 01acf989bfec7a25110b94677449d9e861b5ea81
 full_cat: AlexEMG/DeepLabCutModelZoo-cat/DLC_Cat_resnet_50_iteration-0_shuffle-0.tar.gz
 full_cat_commit: 972f82dc575c820ce556e140465495a32d18ee9b
 full_dog: AlexEMG/DeepLabCutModelZoo-dog/DLC_Dog_resnet_50_iteration-0_shuffle-0.tar.gz

requirements.txt

@@ -0,0 +1,2 @@
+huggingface_hub==0.11.1
+ruamel.yaml==0.17.21

setup.py

@@ -24,6 +24,7 @@
     url="https://github.com/DeepLabCut/DLClib",
     install_requires=[
         "huggingface_hub",
+        "ruamel.yaml>=0.15.0",
     ],
     packages=setuptools.find_packages(),
     data_files=[

tests/test_modeldownload.py

@@ -11,18 +11,25 @@
 import dlclibrary
 import os
 import pytest
+from dlclibrary.dlcmodelzoo.modelzoo_download import MODELOPTIONS
 
 
-def test_download_huggingface_model(tmp_path_factory):
-    folder = tmp_path_factory.mktemp("cat")
-    dlclibrary.download_huggingface_model("full_cat", str(folder))
+def test_download_huggingface_model(tmp_path_factory, model="full_cat"):
+    folder = tmp_path_factory.mktemp("temp")
+    dlclibrary.download_huggingface_model(model, str(folder))
 
     assert os.path.exists(folder / "pose_cfg.yaml")
-    assert os.path.exists(folder / "snapshot-75000.meta")
+    assert any(f.startswith("snapshot-") for f in os.listdir(folder))
     # Verify that the Hugging Face folder was removed
     assert not any(f.startswith("models--") for f in os.listdir(folder))
 
 
 def test_download_huggingface_wrong_model():
     with pytest.raises(ValueError):
         dlclibrary.download_huggingface_model("wrong_model_name")
+
+
+@pytest.mark.skip
+@pytest.mark.parametrize("model", MODELOPTIONS)
+def test_download_all_models(tmp_path_factory, model):
+    test_download_huggingface_model(tmp_path_factory, model)