Skip to content

Commit

Permalink
minor docs, and version bump
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexEMG committed Aug 4, 2020
1 parent 49a0c1c commit c1fdbad
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 5 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,11 @@ Please see our instruction manual to install on a [Windows or Linux machine](doc

- available on pypi as: `pip install deeplabcut-live`

Note, you can test your installation by running:

`python /check_install/check_install.py`

This will download

### Quick Start: instructions for use:

Expand Down Expand Up @@ -121,10 +126,10 @@ This project is licensed under the GNU Lesser General Public License v3.0. Note

This is an actively developed package and we welcome community development and involvement.

- If you want to contribute to the code, please read our guide [here!](https://github.com/DeepLabCut/DeepLabCut/blob/master/CONTRIBUTING.md), which is provided at the main repository of DeepLabCut.

- We are a community partner on the [![Image.sc forum](https://img.shields.io/badge/dynamic/json.svg?label=forum&url=https%3A%2F%2Fforum.image.sc%2Ftags%2Fdeeplabcut.json&query=%24.topic_list.tags.0.topic_count&colorB=brightgreen&&suffix=%20topics&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAOCAYAAAAfSC3RAAABPklEQVR42m3SyyqFURTA8Y2BER0TDyExZ+aSPIKUlPIITFzKeQWXwhBlQrmFgUzMMFLKZeguBu5y+//17dP3nc5vuPdee6299gohUYYaDGOyyACq4JmQVoFujOMR77hNfOAGM+hBOQqB9TjHD36xhAa04RCuuXeKOvwHVWIKL9jCK2bRiV284QgL8MwEjAneeo9VNOEaBhzALGtoRy02cIcWhE34jj5YxgW+E5Z4iTPkMYpPLCNY3hdOYEfNbKYdmNngZ1jyEzw7h7AIb3fRTQ95OAZ6yQpGYHMMtOTgouktYwxuXsHgWLLl+4x++Kx1FJrjLTagA77bTPvYgw1rRqY56e+w7GNYsqX6JfPwi7aR+Y5SA+BXtKIRfkfJAYgj14tpOF6+I46c4/cAM3UhM3JxyKsxiOIhH0IO6SH/A1Kb1WBeUjbkAAAAAElFTkSuQmCC)](https://forum.image.sc/tags/deeplabcut). Please post help and support questions on the forum with the tag DeepLabCut. Check out their mission statement [Scientific Community Image Forum: A discussion forum for scientific image software](https://journals.plos.org/plosbiology/article?id=10.1371/journal.pbio.3000340).

- If you encounter a previously unreported bug/code issue, please post here (we encourage you to search issues first): https://github.com/DeepLabCut/DeepLabCut-live/issues

- For quick discussions here: [![Gitter](https://badges.gitter.im/DeepLabCut/community.svg)](https://gitter.im/DeepLabCut/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

- If you want to contribute to the code, please read our guide [here!](https://github.com/DeepLabCut/DeepLabCut/blob/master/CONTRIBUTING.md), which is provided at the main repository of DeepLabCut.
2 changes: 1 addition & 1 deletion dlclive/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@
"""


__version__ = '0.0'
__version__ = '0.0.1'
VERSION = __version__
4 changes: 4 additions & 0 deletions docs/install_desktop.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,8 @@ pip install deeplabcut-live
dlc-live-test
```

Note, you can test your installation by running:

`python /check_install/check_install.py`

If installed properly, this script will i) create a temporary folder ii) download the full_dog model from the [DeepLabCut Model Zoo](http://www.mousemotorlab.org/dlc-modelzoo), iii) download a short video clip of a dog, and iv) run inference while displaying keypoints. v) remove the temporary folder.
2 changes: 1 addition & 1 deletion reinstall.sh
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
pip uninstall deeplabcut-live
python3 setup.py sdist bdist_wheel
pip install dist/deeplabcut_live-0.0-py3-none-any.whl
pip install dist/deeplabcut_live-0.0.1-py3-none-any.whl
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@

setuptools.setup(
name="deeplabcut-live",
version="0.0",
version="0.0.1",
author="A. & M. Mathis Labs",
author_email="[email protected]",
description="Class to load exported DeepLabCut networks and perform pose estimation on single frames (from a camera feed)",
Expand Down

0 comments on commit c1fdbad

Please sign in to comment.