Skip to content

Commit b8e9550

Browse files
committed
Updated README
1 parent a0cbc28 commit b8e9550

File tree

1 file changed

+26
-5
lines changed

1 file changed

+26
-5
lines changed

README.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,34 @@
33

44
# DLClibrary
55

6-
DLClibrary is a lightweight library supporting universal functions for the DeepLabCut ecosystem.
6+
DLClibrary is a lightweight library supporting universal functions for the [DeepLabCut](https://github.com/DeepLabCut/DeepLabCut) ecosystem.
77

88
Supported functions (at this point):
9-
- API for downloading model weights from the model zoo
109

11-
# Quick start
10+
- API for downloading model weights from [the model zoo](http://www.mackenziemathislab.org/dlc-modelzoo)
1211

13-
`pip install dlclibrary`
12+
# Quick start
1413

15-
- warning, the closely named package `dlclib` is not an official DeepLabCut product.
14+
## Install
15+
16+
The package can be installed using `pip`:
17+
18+
```bash
19+
pip install dlclibrary
20+
```
21+
22+
:warning: warning, the closely named package `dlclib` is not an official DeepLabCut product. :warning:
23+
24+
## Example Usage
25+
26+
Downloading a pretrained model from the model zoo:
27+
28+
```python
29+
from pathlib import Path
30+
from dlclibrary import download_huggingface_model
31+
32+
# Creates a folder and downloads the model to it
33+
model_dir = Path("./superanimal_quadruped_model")
34+
model_dir.mkdir()
35+
download_huggingface_model("superanimal_quadruped", model_dir)
36+
```

0 commit comments

Comments
 (0)