Merge main into dlclive3

- Package version is copied from main for now, until finalized changes.
- don't use subset cpuinfo
- updated type hints in benchmark.py as was already implemented in main branch
- copied todo's in check_install.py

Author: deruyter92

CITATION.cff

@@ -52,4 +52,4 @@ authors:
 date-released: 2020-08-05
 doi: "10.7554/eLife.61909"
 license: "AGPL-3.0-or-later"
-version:  "1.0.3"
+version:  "1.1.0"

dlclive/benchmark.py

@@ -5,7 +5,6 @@
 Licensed under GNU Lesser General Public License v3.0
 """
 
-import csv
 import platform
 import subprocess
 import sys
@@ -261,7 +260,7 @@ def get_system_info() -> dict:
         from cpuinfo import get_cpu_info
 
         dev_type = "CPU"
-        dev = [get_cpu_info()["brand_raw"]]
+        dev = get_cpu_info()
 
     return {
         "host_name": host_name,
@@ -351,24 +350,24 @@ def benchmark(
     model_path: str,
     model_type: str,
     video_path: str,
-    tf_config=None,
+    tf_config: "tensorflow.ConfigProto | None" = None,
     device: str | None = None,
     resize: float | None = None,
     pixels: int | None = None,
     single_animal: bool = True,
-    cropping=None,
-    dynamic=(False, 0.5, 10),
-    n_frames=1000,
-    print_rate=False,
+    cropping: list[int] | None = None,
+    dynamic: tuple[bool, float, int] = (False, 0.5, 10),
+    n_frames: int =1000,
+    print_rate: bool=False,
     precision: str = "FP32",
-    display=True,
-    pcutoff=0.5,
-    display_radius=3,
-    cmap="bmy",
-    save_dir=None,
-    save_poses=False,
-    save_video=False,
-    draw_keypoint_names=False,
+    display: bool = True,
+    pcutoff: float = 0.5,
+    display_radius: int = 3,
+    cmap: str = "bmy",
+    save_dir: str | None = None,
+    save_poses: bool = False,
+    save_video: bool = False,
+    draw_keypoint_names: bool = False,
 ):
     """
     Analyzes a video to track keypoints using a DeepLabCut model, and optionally saves the keypoint data and the labeled video.

dlclive/check_install/check_install.py

@@ -46,7 +46,8 @@ def main():
     if not display:
         print("Running without displaying video")
 
-    # make temporary directory in $current
+    # make temporary directory in $HOME
+    # TODO: why create this temp directory in $HOME?
     print("\nCreating temporary directory...\n")
     tmp_dir = Path().home() / "dlc-live-tmp"
     tmp_dir.mkdir(mode=0o775, exist_ok=True)
@@ -66,7 +67,7 @@ def main():
     if Path(model_dir / SNAPSHOT_NAME).exists():
         print("Model already downloaded, using cached version")
     else:
-        print("Downloading a test model from the DeepLabCut Model Zoo...")
+        print("Downloading superanimal_quadruped model from the DeepLabCut Model Zoo...")
         download_huggingface_model(MODEL_NAME, model_dir)
 
     # assert these things exist so we can give informative error messages

dlclive/version.py

@@ -6,5 +6,6 @@
 Licensed under GNU Lesser General Public License v3.0
 """
 
-__version__ = "3.0.0a0"
+
+__version__ = "1.1.0"
 VERSION = __version__

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "deeplabcut-live"
-version = "3.0.0a0"
+version = "1.1.0"
 description = "Class to load exported DeepLabCut networks and perform pose estimation on single frames (from a camera feed)"
 authors = ["A. & M. Mathis Labs <admin@deeplabcut.org>"]
 license = "AGPL-3.0-or-later"