Skip to content

Commit 6062dc2

Browse files
committed
add docstring to export_model_zoo
1 parent 9bdb018 commit 6062dc2

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

dlclive/modelzoo/pytorch_model_zoo_export.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,18 @@ def export_modelzoo_model(
1414
detector_name: str | None = None,
1515
) -> None:
1616
"""
17+
Export a DeepLabCut Model Zoo model to a single .pt file.
1718
19+
Downloads the model configuration and weights from HuggingFace, bundles them
20+
together (optionally with a detector), and saves as a single torch archive.
21+
Skips export if the output file already exists.
22+
23+
Args:
24+
export_path: Arbitrary destination path for the exported .pt file.
25+
super_animal: Super animal dataset name (e.g. "superanimal_quadruped").
26+
model_name: Pose model architecture name (e.g. "resnet_50").
27+
detector_name: Optional detector model name. If provided, detector
28+
weights are included in the export.
1829
"""
1930
Path(export_path).parent.mkdir(parents=True, exist_ok=True)
2031
if Path(export_path).exists():

0 commit comments

Comments
 (0)