download function with test

Author: AlexEMG

.gitignore

@@ -2,6 +2,7 @@
 __pycache__/
 *.py[cod]
 *$py.class
+.DS_store
 
 # C extensions
 *.so

dlclibrary/__init__.py

@@ -8,4 +8,5 @@
 Licensed under GNU Lesser General Public License v3.0
 """
 
-from dlclibrary.metrics import pairwisedistances
+from dlclibrary.dlcmodelzoo.modelzoo_download import download_hugginface_model
+from dlclibrary.version import __version__, VERSION

dlclibrary/dlcmodelzoo/__init__.py

@@ -0,0 +1,24 @@
+# just expand this list with new projects
+
+Modeloptions = [
+    "full_human",
+    "full_cat",
+    "primate_face",
+    "mouse_pupil_vclose",
+    "horse_sideview",
+    "full_macaque",
+    "superanimal_mouse",
+]
+
+"""
+Modeloptions = [
+    "full_human",
+    "full_cat",
+    "full_dog",
+    "primate_face",
+    "mouse_pupil_vclose",
+    "horse_sideview",
+    "full_macaque",
+    "full_cheetah",
+]  # just expand this list with new projects
+"""

dlclibrary/dlcmodelzoo/modelzoo_download.py

@@ -0,0 +1,88 @@
+import os
+
+# just expand this list when adding new models:
+MODELOPTIONS = [
+    "full_human",
+    "full_cat",
+    "primate_face",
+    "mouse_pupil_vclose",
+    "horse_sideview",
+    "full_macaque",
+    "superanimal_mouse",
+]
+
+
+def get_dlclibrary_path():
+    """Get path of where dlclibrary (this repo) is currently running"""
+    import importlib.util
+    return os.path.split(importlib.util.find_spec("dlclibrary").origin)[0]
+
+
+def loadmodelnames():
+    """Load URLs and commits for available models"""
+    from ruamel.yaml import YAML
+    fn = os.path.join(get_dlclibrary_path(),"modelzoo_urls.yaml")
+    with open(fn) as file:
+        return YAML().load(file)
+
+
+def download_hugginface_model(modelname, target_dir,removeHFfolder=True):
+    """
+    Downloads a DeepLabCut Model Zoo Project from Hugging Face
+    """
+    from huggingface_hub import hf_hub_download
+    import tarfile, os
+    from pathlib import Path
+
+    neturls = loadmodelnames()
+
+    if modelname in neturls.keys():
+        print("Loading....", modelname)
+        url = neturls[modelname].split("/")
+        repo_id, targzfn = url[0] + "/" + url[1], str(url[-1])
+
+        hf_hub_download(repo_id, targzfn, cache_dir=str(target_dir))
+        # creates a new subfolder as indicated below, unzipping from there and deleting this folder
+
+        # Building the HuggingFaceHub download path:
+        hf_path = (
+            "models--"
+            + url[0]
+            + "--"
+            + url[1]
+            + "/snapshots/"
+            + str(neturls[modelname + "_commit"])
+            + "/"
+            + targzfn
+        )
+
+        filename = os.path.join(target_dir, hf_path)
+        with tarfile.open(filename, mode="r:gz") as tar:
+            for member in tar:
+                if not member.isdir():
+                    fname = Path(member.name).name  # getting the filename
+                    tar.makefile(member, target_dir + "/" + fname)
+                    # tar.extractall(target_dir, members=tarfilenamecutting(tar))
+
+        if removeHFfolder:
+            # Removing folder
+            import shutil
+            shutil.rmtree(
+                Path(os.path.join(target_dir, "models--" + url[0] + "--" + url[1]))
+            )
+
+    else:
+        models = [fn for fn in neturls.keys()]
+        print("Model does not exist: ", modelname)
+        print("Pick one of the following: ", MODELOPTIONS)
+
+
+if __name__ == "__main__":
+    print("Randomly downloading a model for testing...")
+
+    import random
+    #modelname = 'full_cat'
+    modelname = random.choice(MODELOPTIONS)
+
+    target_dir = '/Users/alex/Downloads' # folder has to exist!
+    download_hugginface_model(modelname, target_dir)

dlclibrary/metrics/distances.py

@@ -0,0 +1,22 @@
+
+#Model Zoo from HuggingFace
+full_human: mwmathis/DeepLabCutModelZoo-DLC_human_fullbody_resnet_101/DLC_human_fullbody_resnet_101.tar.gz
+full_human_commit: 7438131c2ee7754a9732bef6fbf46b8189a16c48
+
+primate_face: mwmathis/DeepLabCutModelZoo-primate_face/DLC_primate_face_resnet_50_iteration-1_shuffle-1.tar.gz
+primate_face_commit: df7e8f6ad38899489758e5a890b58905cfb4d893
+
+mouse_pupil_vclose: mwmathis/DeepLabCutModelZoo-mouse_pupil_vclose/DLC_mouse_pupil_vclose_resnet_50_iteration-0_shuffle-1.tar.gz
+mouse_pupil_vclose_commit: 93557f0e74390596a2b9fddaab7628a1cc79fb2d
+
+horse_sideview: mwmathis/DeepLabCutModelZoo-horse_sideview/DLC_Horses_resnet_50_iteration-1_shuffle-1.tar.gz
+horse_sideview_commit: fd0329b2ffc8fe7a5e6eb3d4850ebca75987e92c
+
+full_macaque: mwmathis/DeepLabCutModelZoo-macaque_full/DLC_macaque_full_resnet50.tar.gz
+full_macaque_commit: 4c7ebf2628d5b7eb0483356595256fb01b7e1a9e
+
+superanimal_mouse: mwmathis/DeepLabCutModelZoo-SuperAnimal-TopViewMouse/DLC_ma_supertopview5k_resnet_50_iteration-0_shuffle-1.tar.gz
+superanimal_mouse_commit: a7d7df40c3307a3c7a0ceeb2593d46a783235b28
+
+full_cat: AlexEMG/DeepLabCutModelZoo-cat/DLC_Cat_resnet_50_iteration-0_shuffle-0.tar.gz
+full_cat_commit: 972f82dc575c820ce556e140465495a32d18ee9b