Merge pull request #20 from DeepLabCut/v0.0.4

V0.0.4

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!

dlclibrary/version.py

@@ -9,5 +9,5 @@
 # Licensed under GNU Lesser General Public License v3.0
 #
 
-__version__ = "0.0.3"
+__version__ = "0.0.4"
 VERSION = __version__

setup.py

@@ -15,7 +15,7 @@
 
 setuptools.setup(
     name="dlclibrary",
-    version="0.0.3",
+    version="0.0.4",
     author="A. & M. Mathis Labs",
     author_email="alexander@deeplabcut.org",
     description="Lightweight library supporting universal functions for the DeepLabCut ecosystem",

tests/test_modeldownload.py

@@ -35,7 +35,8 @@ 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)
     test_download_huggingface_model(tmp_path_factory, model)

tools/README.md

@@ -1,4 +1,4 @@
-# Developer tools useful for maintaining the repository
+# Developer tools useful for maintaining the DeepLabCut repository
 
 ## Code headers
 
@@ -11,3 +11,10 @@ python tools/update_license_headers.py
 from the repository root (this needs `pip install licenseheaders`)
 
 You can edit the `NOTICE.yml` to update the header.
+
+
+## Running tests [with more details](https://docs.pytest.org/en/latest/how-to/capture-stdout-stderr.html)
+
+``` bash
+pytest -s
+```