Skip to content

Commit 08c80da

Browse files
committed
Update readme's: add installation instructions for [animals] extra
1 parent 2c19b00 commit 08c80da

2 files changed

Lines changed: 15 additions & 0 deletions

File tree

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,12 @@ conda activate fmpose_3d
3636
pip install fmpose3d
3737
```
3838

39+
For the animal pipeline, install the optional DeepLabCut dependency:
40+
41+
```bash
42+
pip install "fmpose3d[animals]"
43+
```
44+
3945
## Demos
4046

4147
### Testing on in-the-wild images (humans)

fmpose3d/inference_api/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,12 @@ result = api.predict("dog.jpg")
4848
print(result.poses_3d.shape) # (1, 26, 3)
4949
```
5050

51+
Before using the animal pipeline, install the optional DeepLabCut dependency:
52+
53+
```bash
54+
pip install "fmpose3d[animals]"
55+
```
56+
5157

5258
## API Documentation
5359

@@ -221,6 +227,9 @@ Default 2D estimator for the human pipeline. Wraps HRNet + YOLO with a COCO →
221227

222228
2D estimator for the animal pipeline. Uses DeepLabCut SuperAnimal and maps quadruped80K keypoints to the 26-joint Animal3D layout.
223229

230+
If DeepLabCut is not installed, calling this estimator raises a clear `ImportError`
231+
with the recommended install command: `pip install "fmpose3d[animals]"`.
232+
224233
- `setup_runtime()` — No-op (DLC loads lazily).
225234
- `predict(frames: ndarray)``(keypoints, scores, valid_frames_mask)` — Returns Animal3D-format 2D keypoints plus a frame-level validity mask.
226235

0 commit comments

Comments
 (0)