-[](CONTRIBUTING.md)
-[](https://www.gnu.org/licenses/lgpl-3.0)
-[](https://forum.image.sc/tags/deeplabcut)
-[](https://gitter.im/DeepLabCut/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
-[](https://twitter.com/DeepLabCut)
-
-
-
- www.deeplabcut.org
+
-
-
-
-
-
-DeepLabCut is a toolbox for markerless pose estimation of animals performing various tasks. [Read a short development and application summary below](https://github.com/AlexEMG/DeepLabCut#why-use-deeplabcut).
-:purple_heart: DeepLabCut now supports multi-animal pose estimation (beta release).
+

+
+
+

+
+
+

+
+
+[📚Documentation](https://deeplabcut.github.io/DeepLabCut/README.html) |
+[🛠️ Installation](https://deeplabcut.github.io/DeepLabCut/docs/installation.html) |
+[🌎 Home Page](https://www.deeplabcut.org) |
+[🐿🐴🐁🐘🐆 Model Zoo](http://www.mackenziemathislab.org/deeplabcut/) |
+[🚨 News](https://deeplabcut.github.io/DeepLabCut/README.html#news-and-in-the-news) |
+[🪲 Reporting Issues](https://github.com/DeepLabCut/DeepLabCut/issues)
+
+
+[🫶 Getting Assistance](https://deeplabcut.github.io/DeepLabCut/README.html#be-part-of-the-dlc-community) |
+[∞ DeepLabCut Online Course](https://github.com/DeepLabCut/DeepLabCut-Workshop-Materials/blob/master/DLCcourse.md) |
+[📝 Publications](https://deeplabcut.github.io/DeepLabCut/README.html#references) |
+[👩🏾💻👨💻 DeepLabCut AI Residency](https://www.deeplabcutairesidency.org/)
+
+
+
+[](https://pepy.tech/project/deeplabcut)
+[](https://pepy.tech/project/deeplabcut)
+[](https://badge.fury.io/py/deeplabcut)
+[](https://www.gnu.org/licenses/lgpl-3.0)
+

+[](https://github.com/DeepLabCut/DeepLabCut)
+[](http://isitmaintained.com/project/deeplabcut/deeplabcut "Average time to resolve an issue")
+[](http://isitmaintained.com/project/deeplabcut/deeplabcut "Percentage of issues still open")
+[](https://forum.image.sc/tag/deeplabcut)
+[](https://gitter.im/DeepLabCut/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+[](https://x.com/DeepLabCut)
+[](CONTRIBUTING.md)
+[](https://czi.co/EOSS)
+
+
-# [Installation: how to install DeepLabCut](docs/installation.md)
+# Welcome! 👋
-# [Documentation: The DeepLabCut Process](docs/UseOverviewGuide.md)
+**DeepLabCut™️** is a toolbox for state-of-the-art markerless pose estimation of animals performing various behaviors. As long as you can see (label) what you want to track, you can use this toolbox, as it is animal and object agnostic. [Read a short development and application summary below](https://github.com/DeepLabCut/DeepLabCut#why-use-deeplabcut).
-An overview of the pipeline and workflow for project management. For a step-by-step user guide, please also read the [Nature Protocols paper](https://doi.org/10.1038/s41596-019-0176-0)!
+# [Installation](https://deeplabcut.github.io/DeepLabCut/docs/installation.html)
+
+Please click the link above for all the information you need to get started! Please note that currently we support only Python 3.10+ (see conda files for guidance).
+
+## Quick start
+
+Developers Stable Release: very quick start (Python 3.10+ required) to install
+DeepLabCut with the PyTorch engine
+
+- [1] [Install PyTorch](https://pytorch.org/get-started/locally/) (**install and then select the desired
+CUDA version if you want to use a GPU**): `pip install torch torchvision`.
+Or as an example for GPU support (please check pytorch docs to get the perfect version for your CUDA):
+```bash
+conda install pytorch cudatoolkit=11.3 -c pytorch
+```
+- [2] Then, install `DeepLabCut` (with all functions + the GUI):
+
+```bash
+pip install --pre "deeplabcut[gui]"
+```
+or `pip install --pre "deeplabcut"` (headless
+version with PyTorch)!
+
+To use the TensorFlow (TF) engine: you'll need to run `pip install "deeplabcut[gui,tf]"` or `pip install "deeplabcut[tf]"` (headless version with TF). Alternatively, we also offer more targeted optional TensorFlow installs for specific CUDA setups, e.g. `deeplabcut[tf-cu11]` or `deeplabcut[tf-cu12]`. Please refer to our [installation instructions](https://deeplabcut.github.io/DeepLabCut/docs/installation.html) for more detailed information on Python version, CUDA compatibility, etc.
+We aim to **deprecate the tensorflow backend** in version 3.2 (release date TBD).
+
+
+
+# Documentation: The DeepLabCut Process
+
+Our docs walk you through using DeepLabCut, and key API points. For an overview of the toolbox and workflow for project management, see our step-by-step at [Nature Protocols paper](https://doi.org/10.1038/s41596-019-0176-0).
+
+
+