Lightweight library supporting universal functions for the DeepLabCut ecosystem
Project description
DLClibrary
DLClibrary is a lightweight library supporting universal functions for the DeepLabCut ecosystem.
Supported functions (at this point):
- API for downloading model weights from the model zoo
Quick start
Install
The package can be installed using pip
:
pip install dlclibrary
:warning: warning, the closely named package dlclib
is not an official DeepLabCut product. :warning:
Example Usage
Downloading a pretrained model from the model zoo:
from pathlib import Path
from dlclibrary import download_huggingface_model
# Creates a folder and downloads the model to it
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
.
-
Add the model_name with path and commit ID to: https://github.com/DeepLabCut/DLClibrary/blob/main/dlclibrary/dlcmodelzoo/modelzoo_urls.yaml
-
Add the model name to the constant: MODELOPTIONS https://github.com/DeepLabCut/DLClibrary/blob/main/dlclibrary/dlcmodelzoo/modelzoo_download.py#L15
-
For superanimal models also fill in the configs!
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for dlclibrary-0.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7c77df691013f279bbe1e4971522c6f483a0f0c272aefd3993ad4d4b53ac9748 |
|
MD5 | 5c8734b4341ea0d7750a61c0b273d8ec |
|
BLAKE2b-256 | 7fe04b394a8782f56404202ae2999849f5738c7379de18878985a40fcfbf76fb |