deeplabcut

last_content_updated last_metadata_updated ignore visibility status recommendation notes 2025-02-28 2026-03-06 false online review_needed update While the content is generally accurate, repeating installation instructions is not ideal. I would suggest linking to the installation guide instead of re-suggesting commands but then still saying to read the install page... Also, the GUI is likely used by the majority of users, so I would even consider making this a full section in the TOC, and maybe even having one file per GUI tab, which would make tracking code/docs sync easier. Addendum: it seems the beginner guide section is more of a GUI step-by-step, as mentioned earlier in this comment. I would suggest merging/moving and adding links in the present doc, which would make it less of a video list and more of a proper GUI guide.

(project-manager-gui)=

Project Manager GUI

As some users may be more comfortable working with an interactive interface, we wanted to provide an easy entry point to the software. All the main functionality is available in an easy-to-use GUI interface. While several advanced features are not fully available in this Project GUI, we hope this gets more users up-and-running quickly.

Getting started

1. Install DeepLabCut following the instructions in the {ref}installation page<file:how-to-install>.
2. Open the terminal and run: python -m deeplabcut

If you use Windows, please always open the terminal with administrator privileges! Right click, and "run as administrator".

Start at the Project Management Tab and work your way through the tabs to build your customized model and deploy it on new data. We recommend to keep the terminal visible (as well as the GUI) so you can see the ongoing processes as you step through your project, or any errors that might arise.

• For specific napari-based labeling features, see the {ref}napari gui<file:napari-gui-landing> section.
• To change from dark to light mode, set appearance at the top:

User guide

See the dedicated {ref}`file:beginners-guide` section for a step-by-step walkthrough of the GUI.

Video demos

How to launch and run the Project Manager GUI

**Click on the images!**

Note that currently the video demo is the wxPython version, but the logic is the same!

Using the Project Manager GUI with the latest DLC code (single animals, plus objects)

{ref}Read more here <sec:important-info-regd-usage>

Using the Project Manager GUI with the latest DLC code (multiple identical-looking animals, plus objects)

{ref}Read more here <sec:important-info-regd-usage>

How to benchmark your data with the new networks and data augmentation pipelines

Watch the video