Merge branch 'main' into maxim/dlclive3

Author: maximpavliv

.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,9 @@ name: Run Tests
 
 on:
   push:
-    branches: [master]
+    branches: [main]
   pull_request:
-    branches: [master]
+    branches: [main]
 
 jobs:
   build:
@@ -14,7 +14,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: ["3.10"]
+        python-version: ["3.9", "3.10"]
         include:
           - os: ubuntu-latest
             path: ~/.cache/pip
@@ -31,6 +31,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,7 +50,9 @@ jobs:
             choco install ffmpeg
           fi
         shell: bash
-      - name: Install and test
+        
+      - name: Install PyTables through Conda
+        shell: bash -el {0}  # Important: activates the conda environment
         run: |
           python -m pip install --upgrade pip wheel poetry
           python -m poetry install --extras "tf"

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](

dlclive/check_install/check_install.py

@@ -5,6 +5,8 @@
 Licensed under GNU Lesser General Public License v3.0
 """
 
+import os
+import urllib.request
 import argparse
 import shutil
 import sys
@@ -43,8 +45,7 @@ def main():
     if not display:
         print("Running without displaying video")
 
-    # make temporary directory in $HOME
-    # TODO: why create this temp directory in $HOME?
+    # make temporary directory in $current
     print("\nCreating temporary directory...\n")
     tmp_dir = Path().home() / "dlc-live-tmp"
     tmp_dir.mkdir(mode=0o775, exist_ok=True)
@@ -53,16 +54,18 @@ def main():
     model_dir = tmp_dir / "DLC_Dog_resnet_50_iteration-0_shuffle-0"
 
     # download dog test video from github:
-    # TODO: Should check if the video's already there before downloading it (should have been cloned with the files)
-    print(f"Downloading Video to {video_file}")
-    url_link = "https://github.com/DeepLabCut/DeepLabCut-live/blob/master/check_install/dog_clip.avi?raw=True"
-    urllib.request.urlretrieve(url_link, video_file, reporthook=urllib_pbar)
+    if not os.path.exists(video_file):
+        print(f"Downloading Video to {video_file}")
+        url_link = "https://github.com/DeepLabCut/DeepLabCut-live/blob/main/check_install/dog_clip.avi?raw=True"
+        urllib.request.urlretrieve(url_link, video_file, reporthook=urllib_pbar)
+    else:
+        print(f"Video already exists at {video_file}")
 
     # download model from the DeepLabCut Model Zoo
     if Path(model_dir / SNAPSHOT_NAME).exists():
         print("Model already downloaded, using cached version")
     else:
-        print("Downloading full_dog model from the DeepLabCut Model Zoo...")
+        print("Downloading a test model from the DeepLabCut Model Zoo...")
         download_huggingface_model(MODEL_NAME, model_dir)
 
     # assert these things exist so we can give informative error messages