From 0ae87ddf29fe60c6207858bdf3987c4ae9d4242c Mon Sep 17 00:00:00 2001 From: Mackenzie Weygandt Mathis Date: Mon, 2 Nov 2026 13:59:05 +0100 Subject: [PATCH 1/5] Update README.md --- README.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/README.md b/README.md index e0a3b42..50db5b0 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,7 @@ # DLClibrary -DLClibrary is a lightweight library supporting universal functions for the [DeepLabCut](https://github.com/DeepLabCut/DeepLabCut) ecosystem. - -Supported functions (at this point): - -- API for downloading model weights from [the model zoo](http://www.mackenziemathislab.org/dlc-modelzoo) +DLClibrary is a lightweight library supporting an API for downloading model weights from [the model zoo](http://www.mackenziemathislab.org/dlc-modelzoo) # Quick start From 74263ee760ab6dc98a9c894641b97a5f540c65de Mon Sep 17 00:00:00 2001 From: Mackenzie Weygandt Mathis Date: Mon, 2 Nov 2026 14:07:29 +0100 Subject: [PATCH 2/5] Update README.md - changed docs to be clear to original intent and current use: API for hugginface Model Zoo; released for Ye et al. 2024 --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 50db5b0..dbc2b85 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ [![Generic badge](https://img.shields.io/badge/Contributions-Welcome-brightgreen.svg)](README.md) Code style: black[![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) -# DLClibrary +# DLClibrary: the API interface for DeepLabCut ModelZoo models on HuggingFace DLClibrary is a lightweight library supporting an API for downloading model weights from [the model zoo](http://www.mackenziemathislab.org/dlc-modelzoo) @@ -89,3 +89,22 @@ To add a new model for `deeplabcut >= 3.0.0`, simply: The models will then be listed when calling `dlclibrary.get_available_detectors` or `dlclibrary.get_available_models`! You can list the datasets for which models are available using `dlclibrary.get_available_datasets`. + +## Citation + +If you use SuperAnimal, please cite: + +```bibtex +@article{ye2024superanimal, + title = {SuperAnimal pretrained pose estimation models for behavioral analysis}, + author = {Ye, Shaokai and Filippova, Anastasiia and Lauer, Jessy and Schneider, Steffen and Vidal, Maxime and Qiu, Tian and Mathis, Alexander and Mathis, Mackenzie Weygandt}, + journal = {Nature Communications}, + volume = {15}, + number = {1}, + pages = {5165}, + year = {2024}, + doi = {10.1038/s41467-024-48792-2} +} +``` + + From 28850244eb13fd61134ab2a59da8ef9725ef53cf Mon Sep 17 00:00:00 2001 From: Mackenzie Weygandt Mathis Date: Mon, 2 Nov 2026 14:21:05 +0100 Subject: [PATCH 3/5] Update README.md Co-authored-by: Jaap de Ruyter van Steveninck <32810691+deruyter92@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index dbc2b85..fc956db 100644 --- a/README.md +++ b/README.md @@ -77,7 +77,7 @@ my_cool_dataset: # name of the dataset used to train the model other_pose_model_name: path/to/huggingface-other-pose-model.pt ``` -This will allow users to download the models using the format `datatsetName_modelName`, +This will allow users to download the models using the format `datasetName_modelName`, i.e. for this example 3 models would be available: `my_cool_dataset_detector_name`, `my_cool_dataset_pose_model_name` and `my_cool_dataset_other_pose_model_name`. From cfd9e4f830729d85f6673ca2e12b57c71f818de9 Mon Sep 17 00:00:00 2001 From: Mackenzie Weygandt Mathis Date: Mon, 2 Nov 2026 14:21:16 +0100 Subject: [PATCH 4/5] Update README.md Co-authored-by: Jaap de Ruyter van Steveninck <32810691+deruyter92@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fc956db..657a098 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ [![Generic badge](https://img.shields.io/badge/Contributions-Welcome-brightgreen.svg)](README.md) Code style: black[![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) -# DLClibrary: the API interface for DeepLabCut ModelZoo models on HuggingFace +# DLClibrary: the API interface for DeepLabCut ModelZoo models on Hugging Face DLClibrary is a lightweight library supporting an API for downloading model weights from [the model zoo](http://www.mackenziemathislab.org/dlc-modelzoo) From bd9edd9bd70c8009e1de6c622943b21adbb00475 Mon Sep 17 00:00:00 2001 From: Mackenzie Weygandt Mathis Date: Mon, 2 Nov 2026 14:24:01 +0100 Subject: [PATCH 5/5] Apply suggestion from @deruyter92 Co-authored-by: Jaap de Ruyter van Steveninck <32810691+deruyter92@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 657a098..894f870 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ https://github.com/DeepLabCut/DLClibrary/blob/main/dlclibrary/dlcmodelzoo/modelz ```yaml my_cool_dataset: # name of the dataset used to train the model detectors: - detector_name: path/to/huggingface-detector.pt # add detectors under `detector` + detector_name: path/to/huggingface-detector.pt # add detectors under `detectors` pose_models: pose_model_name: path/to/huggingface-pose-model.pt # add pose models under `pose_models` other_pose_model_name: path/to/huggingface-other-pose-model.pt