Skip to content

Commit 99ad1b3

Browse files
authored
Update README.md
1 parent 54cfc2b commit 99ad1b3

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
1-
# DeepLabCut-live <img src="https://images.squarespace-cdn.com/content/v1/57f6d51c9f74566f55ecf271/1572296495650-Y4ZTJ2XP2Z9XF1AD74VW/ke17ZwdGBToddI8pDm48kMulEJPOrz9Y8HeI7oJuXxR7gQa3H78H3Y0txjaiv_0fDoOvxcdMmMKkDsyUqMSsMWxHk725yiiHCCLfrh8O1z5QPOohDIaIeljMHgDF5CVlOqpeNLcJ80NK65_fV7S1UZiU3J6AN9rgO1lHw9nGbkYQrCLTag1XBHRgOrY8YAdXW07ycm2Trb21kYhaLJjddA/DLC_logo_blk-01.png?format=1000w" width="350" title="DLC-live" alt="DLC LIVE!" align="right" vspace = "50">
1+
# DeepLabCut-live SDK<img src="https://images.squarespace-cdn.com/content/v1/57f6d51c9f74566f55ecf271/1572296495650-Y4ZTJ2XP2Z9XF1AD74VW/ke17ZwdGBToddI8pDm48kMulEJPOrz9Y8HeI7oJuXxR7gQa3H78H3Y0txjaiv_0fDoOvxcdMmMKkDsyUqMSsMWxHk725yiiHCCLfrh8O1z5QPOohDIaIeljMHgDF5CVlOqpeNLcJ80NK65_fV7S1UZiU3J6AN9rgO1lHw9nGbkYQrCLTag1XBHRgOrY8YAdXW07ycm2Trb21kYhaLJjddA/DLC_logo_blk-01.png?format=1000w" width="350" title="DLC-live" alt="DLC LIVE!" align="right" vspace = "50">
2+
3+
![PyPI - Python Version](https://img.shields.io/pypi/v/deeplabcut-live)
4+
[![License](https://img.shields.io/pypi/l/deeplabcutcore.svg)](https://github.com/DeepLabCut/deeplabcutlive/raw/master/LICENSE)
5+
![PyPI - Downloads](https://img.shields.io/pypi/dm/deeplabcut-live?color=purple)
6+
![Python package](https://github.com/DeepLabCut/DeepLabCut-live/workflows/Python%20package/badge.svg?branch=master)
27

38
This package contains a DeepLabCut inference pipeline that has minimal (software) dependencies. Thus, it is as easy to install as possible (in particular, on atypical systems like NVIDIA Jetson boards).
49

@@ -10,7 +15,7 @@ To perform processing on poses (such as predicting the future pose of an animal
1015
- The `save` method saves any valuable data created by or used by the processor
1116
For examples, please see the [processor directory](processor)
1217

13-
###### Note :: alone, this object does not record video or capture images from a camera. This must be done separately, i.e. see our DeepLabCut-live GUI.
18+
###### Note :: alone, this object does not record video or capture images from a camera. This must be done separately, i.e. see our [DeepLabCut-live GUI](https://github.com/gkane26/DeepLabCut-live-GUI).
1419

1520

1621
### Installation:
@@ -52,3 +57,16 @@ dlc_live.get_pose(<your image>)
5257

5358
- `<path to exported model directory>` = path to the folder that has the `.pb` files that you acquire after running `deeplabcut.export_model`
5459
- `<your image>` = is a numpy array of each frame
60+
61+
62+
### Citation:
63+
64+
If you find our code helpful, please consider citing:
65+
```
66+
@Article{Kane020dlclive,
67+
author = {Kane, Gary and Lopes, Gocalo and Sanders, Jonny and Mathis, Alexander and and Mathis, Mackenzie},
68+
title = {Real-time DeepLabCut for closed-loop feedback based on posture},
69+
journal = {BioRxiv},
70+
year = {2020},
71+
}
72+
```

0 commit comments

Comments
 (0)