Getting started

Installation

DeepPoseKit installs as a Python package on Linux, macOS and Windows. Ubuntu 18.04 with a CUDA-capable GPU is the recommended setup.

Requirements

  • Python 3.6 or newer.
  • TensorFlow ≥ 1.13.0 (TensorFlow 2.x is supported).
  • A CUDA-capable GPU is strongly recommended for training.

Install from PyPI

The recommended way to install the latest stable release is via pip:

pip install --update deepposekit

Install the development version

To install directly from the GitHub master branch:

pip install --update git+https://github.com/jgraving/deepposekit.git

Windows extras

On Windows you should install shapely from conda-forge before installing DeepPoseKit:

conda install -c conda-forge shapely pip install --update deepposekit

Verifying the install

Open a Python REPL and import the package. If the import succeeds, you are ready to move on to the Quickstart.

import deepposekit
print(deepposekit.__version__)