instructions for adding a model; unskip tests to download all

Author: AlexEMG

README.md

@@ -34,3 +34,14 @@ model_dir = Path("./superanimal_quadruped_model")
 model_dir.mkdir()
 download_huggingface_model("superanimal_quadruped", model_dir)
 ```
+
+## How to add a new model?
+
+Pick a good model_name. Follow the (novel) naming convention (modeltype_species), e.g. ```superanimal_topviewmouse```.  
+
+1. Add the model_name with path and commit ID to: https://github.com/DeepLabCut/DLClibrary/blob/main/dlclibrary/dlcmodelzoo/modelzoo_urls.yaml
+
+2. Add the model name to the constant: MODELOPTIONS
+https://github.com/DeepLabCut/DLClibrary/blob/main/dlclibrary/dlcmodelzoo/modelzoo_download.py#L15
+
+3. For superanimal models also fill in the configs!

tests/test_modeldownload.py

@@ -23,24 +23,6 @@ def test_download_huggingface_model(tmp_path_factory, model="full_cat"):
     # Verify that the Hugging Face folder was removed
     assert not any(f.startswith("models--") for f in os.listdir(folder))
 
-def test_download_huggingface_superanimalmousemodel(tmp_path_factory, model="superanimal_topviewmouse"):
-    folder = tmp_path_factory.mktemp("temp")
-    dlclibrary.download_huggingface_model(model, str(folder))
-
-    assert os.path.exists(folder / "pose_cfg.yaml")
-    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_superquadrupedmodel(tmp_path_factory, model="superanimal_quadruped"):
-    folder = tmp_path_factory.mktemp("temp")
-    dlclibrary.download_huggingface_model(model, str(folder))
-
-    assert os.path.exists(folder / "pose_cfg.yaml")
-    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):
@@ -53,7 +35,7 @@ def test_parse_superanimal_models():
     assert "superanimal_topviewmouse" in dict_
 
 
-@pytest.mark.skip
+#@pytest.mark.skip # Not skipping as rarely run!
 @pytest.mark.parametrize("model", MODELOPTIONS)
 def test_download_all_models(tmp_path_factory, model):
     print("Downloading ...", model)