Visitar URL original
DeepLabCut-live-GUI PySide6/multicamera documentation ("2.0") by C-Achard · Pull Request #3206 · DeepLabCut/DeepLabCut · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
57 commits
Select commit Hold shift + click to select a range
f3a0c4d
[WIP] Add DeepLabCut-live GUI documentation
C-Achard Feb 6, 2026
897ff8e
Revert indent changes
C-Achard Feb 6, 2026
a49939e
Update _toc.yml
C-Achard Feb 6, 2026
d3ebacc
Merge branch 'cy/fix-toc-jb1.0.4post1' into cy/dlclivegui2.0-docs
C-Achard Feb 6, 2026
a9b413e
Move dlc-live previous docs
C-Achard Feb 10, 2026
febcab8
Reorganize and update DLC-Live GUI docs
C-Achard Feb 10, 2026
bc1903c
Add conda install instructions and clarify env
C-Achard Feb 10, 2026
53dc969
Revise dlclivegui overview and UI guide
C-Achard Feb 10, 2026
b089715
Delete myst.yml
C-Achard Feb 10, 2026
d8f0cf2
Reorganize camera backend docs & update TOC
C-Achard Feb 10, 2026
9a8faaa
Update overview.md
C-Achard Feb 10, 2026
f0f6d33
Update camera backends docs and TOC
C-Achard Feb 10, 2026
139b508
Move timestamp_format into user_guide/misc
C-Achard Feb 10, 2026
60341fe
Remove dlc-live-gui README and features
C-Achard Feb 10, 2026
31b7efc
Fix camera docs link and add OpenCV note
C-Achard Feb 10, 2026
77f7dba
Docs: normalize DeepLabCut-live-GUI branding
C-Achard Feb 10, 2026
b1aad42
Merge branch 'main' into cy/dlclivegui2.0-docs
C-Achard Feb 10, 2026
b83bc3a
Docs: Aravis backend config & link updates
C-Achard Feb 11, 2026
2b6d8a4
docs: improve Aravis backend documentation
C-Achard Feb 11, 2026
dde2a84
Update camera backend docs and add install tabs
C-Achard Feb 11, 2026
4a8db74
docs: clarify video timestamps and recorder notes
C-Achard Feb 11, 2026
b77f8db
Update DeepLabCut-live-GUI install guide for DLClive 1.1.0 version
C-Achard Feb 16, 2026
e63bd17
Update install.md
C-Achard Feb 16, 2026
3f63d8d
Add Basler camera backend documentation
C-Achard Feb 17, 2026
932758e
Specify supported Python versions
C-Achard Feb 17, 2026
7a08b30
Create gentl_backend.md
C-Achard Feb 17, 2026
13f8b60
Update aravis_backend.md
C-Achard Feb 17, 2026
144c450
Add timestamp note; update visualization section
C-Achard Feb 17, 2026
fc2b7a7
Add recording path note and undock tip
C-Achard Feb 17, 2026
b90f4aa
Create opencv_backend.md
C-Achard Feb 17, 2026
ad4bad5
Tidy up camera docs
C-Achard Feb 17, 2026
0523771
Create modelzoo_downloads.md
C-Achard Feb 17, 2026
3656c89
Update opencv_backend.md
C-Achard Feb 17, 2026
5d7f554
Update modelzoo_downloads.md
C-Achard Feb 17, 2026
44182b5
Add misc landing page and update TOC & install
C-Achard Feb 17, 2026
d26b74e
Merge branch 'main' into cy/dlclivegui2.0-docs
C-Achard Feb 17, 2026
8ee492c
Fix typo
C-Achard Feb 17, 2026
fb280af
Merge branch 'cy/dlclivegui2.0-docs' of https://github.com/C-Achard/D…
C-Achard Feb 17, 2026
5c1defb
Update index.md
C-Achard Feb 20, 2026
da08158
docs(dlc-live-gui): update install quickstart
C-Achard Feb 20, 2026
7fa3488
Update main_window_100226.png
C-Achard Feb 20, 2026
a31b107
Add GPU install note and tidy backend install blocks
C-Achard Feb 20, 2026
d034450
docs(dlc-live-gui): refine docs and install quickstart
C-Achard Feb 26, 2026
f77bbf3
Add Sphinx cross-reference anchors for backends
C-Achard Feb 26, 2026
733f2bc
Docs: update camera backend guidance
C-Achard Feb 26, 2026
148e470
Improve OpenCV backend docs structure
C-Achard Feb 26, 2026
42d0d16
Refactor Aravis backend docs layout
C-Achard Feb 27, 2026
3b05b82
docs: restructure Basler backend user guide
C-Achard Feb 27, 2026
c3588a9
docs: improve GenTL backend user guide
C-Achard Feb 27, 2026
094176e
Relocate frame-size note to overview docs
C-Achard Feb 27, 2026
5cc5403
Add detector_name to modelzoo export example
C-Achard Feb 27, 2026
ebb7a55
Mention detectors and add detector_name
C-Achard Mar 2, 2026
1a9d788
Add model zoo download/export note
C-Achard Mar 3, 2026
0a0b68b
Clarify TensorFlow note in modelzoo docs
C-Achard Mar 3, 2026
a806ed9
Merge branch 'main' into cy/dlclivegui2.0-docs
deruyter92 Mar 9, 2026
968475f
Update install.md
C-Achard Mar 9, 2026
23b0275
Fix quickstart directory and package name
C-Achard Mar 9, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs(dlc-live-gui): refine docs and install quickstart
Clean up and improve DeepLabCut-Live! GUI docs: remove an inline TOC note, add a caution block and section anchor for limitations, and clarify/current-limitations wording and performance guidance. Improve quickstart and install pages with a tip, clearer hardware/backend bullet formatting, an explicit pip torch install example for CUDA, and simplify installation commands. Minor copyedits for clarity and contribution/feedback section formatting.
  • Loading branch information
C-Achard committed Feb 26, 2026
commit d0344501fa13f2ab83481b54825714cc21640c75
3 changes: 0 additions & 3 deletions _toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,6 @@ parts:
- caption: DeepLabCut-Live!
chapters:
- file: docs/dlc-live/deeplabcutlive
# NOTE @C-Achard Please move if needed, but since it is downstream of DLC-live
# I think it makes sense to have it here for now.
# TODO remove this note before merging
- file: docs/dlc-live/dlc-live-gui/index
sections:
- file: docs/dlc-live/dlc-live-gui/quickstart/install
Expand Down
21 changes: 13 additions & 8 deletions docs/dlc-live/dlc-live-gui/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ This GUI is designed for **scientists and experimenters** who want to preview, r
- {doc}`Camera setup and backends <./user_guide/cameras_backends/camera_support>`
- {doc}`Timestamp format and synchronization <./user_guide/misc/timestamp_format>`

```{caution}
Please be aware of the {ref}`sec:dlclivegui-index-limitations`
```

---

## Description
Expand Down Expand Up @@ -47,24 +51,25 @@ and *{doc}`User Guide <user_guide/overview>`* sections of this documentation.
- Anyone who wants a **GUI-first** workflow for DeepLabCut Live

---

(sec:dlclivegui-index-limitations)=
## Current limitations

Before getting started, be aware of the following constraints:

- Pose inference runs on **one selected camera at a time** (even in multi-camera mode)
- Camera synchronization depends on backend capabilities and hardware
- Camera synchronization depends on **backend capabilities and hardware**
- OpenCV controls for resolution and FPS are "best effort" and may not work with all cameras.
Expect inconsistencies when setting certain frame rates or resolutions as resolution depends on the device driver.
- DeepLabCut Live models must be **exported and compatible** with the selected backend
- Some SuperAnimal models from {ref}`file:model-zoo` may not work out of the box.<br>This is currently the case for:
- Some SuperAnimal models from {ref}`file:model-zoo` may not work out of the box.<br>This is currently a known issue for:
- SuperHuman model (missing detector)
- Performance depends on camera resolution, frame rate, GPU availability, and codec choice
- **Performance** depends on camera resolution, frame rate, GPU availability, and codec choice
- Expect bottlenecks with heavy models, multiple high-resolution cameras, or CPU-only inference.

---

## About

*This project is under active development. Feedback from real experimental use is highly valued.*
## Feedback, issues, and contributions

[Please report issues, suggest features, or contribute to the codebase on GitHub !](https://github.com/DeepLabCut/DeepLabCut-live-GUI)
> *This project is under active development. Feedback from real experimental use is highly valued.*
>
> [Please report issues, suggest features, or contribute to the codebase on GitHub !](https://github.com/DeepLabCut/DeepLabCut-live-GUI)
29 changes: 18 additions & 11 deletions docs/dlc-live/dlc-live-gui/quickstart/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ This page explains how to install **DeepLabCut-live-GUI** for interactive, real

We support various installation methods, including `uv` and `mamba`/`conda`.

```{tip}
If you feel confident you meet the requirements and you just want to get started quickly, see the {ref}`sec:dlclivegui-install-quickstart` section below.
```

---

## System requirements
Expand All @@ -25,10 +29,10 @@ We support various installation methods, including `uv` and `mamba`/`conda`.
### Hardware requirements

- Any **compatible camera** (see *{ref}`file:dlclivegui-camera-support`*):
- USB webcam, OBS virtual camera → OpenCV-compatible cameras are supported by default
- Basler
- GenTL
- Aravis
- **USB webcam, OBS virtual camera** → OpenCV-recognized cameras are accessible by default
- **Basler**
- *GenTL [^exp]*
- *Aravis [^exp]*
- Optional but recommended:
- **CUDA-capable GPU** (for real‑time inference)
- NVIDIA drivers compatible with your PyTorch/TensorFlow version
Expand All @@ -46,24 +50,25 @@ If you use an OpenCV-compatible camera (e.g. USB webcam, OBS virtual camera), yo
- A working camera backend (see *{ref}`file:dlclivegui-camera-support`*)

---

(sec:dlclivegui-install-quickstart)=
## Quickstart (recommended defaults)

```bash
git clone https://github.com/DeepLabCut/DeepLabCut-live-GUI.git
cd DeepLabCut-live-GUI
uv venv
source .venv/bin/activate # Windows: see tabs below
uv pip install torch torchvision --index-url https://download.pytorch.org/whl/cu<your-cuda-version> # e.g. cu128 for CUDA 12.8, or skip for CPU-only
uv pip install -e ".[pytorch]"
dlclivegui
```

## Choose your installation method

Below instructions cover installation with `uv` and `mamba`/`conda`, but you can also install with other package managers like `pdm` if you prefer.
Below instructions cover installation with `uv` and `mamba`/`conda`, but you may also install with other package managers like `pdm` if preferred.

```{note}
The entire DeepLabCut package and its GUI are not required to use this software, as it is designed to be a lightweight interface for real‑time pose estimation.
The main DeepLabCut package and its GUI are not required to use this software, as it is designed to be a lightweight interface for real‑time pose estimation.
```

### Install DeepLabCut-live-GUI
Expand Down Expand Up @@ -113,7 +118,7 @@ uv venv -p 3.12 # or desired Python version
##### Choose inference backend

We offer two distinct inference backends: **PyTorch** and **TensorFlow**.
You can install either or both, but you must** choose at least one** to run the pose estimation models.
You may install either or both, but you must **choose at least one** to run the pose estimation models.

`````{tab-set}

Expand Down Expand Up @@ -155,7 +160,7 @@ conda activate dlclivegui
##### Choose inference backend

We offer two distinct inference backends: **PyTorch** and **TensorFlow**.
You can install either or both, but you must** choose at least one** to run the pose estimation models.
You may install either or both, but you must **choose at least one** to run the pose estimation models.

`````{tab-set}

Expand All @@ -165,7 +170,7 @@ To **enable GPU support** and obtain detailed installation instructions,
please refer to the [official PyTorch installation guide](https://pytorch.org/get-started/locally/).
```
```bash
uv pip install -e ".[pytorch]"
pip install -e ".[pytorch]"
```
````

Expand All @@ -175,7 +180,7 @@ Please note TensorFlow is **no longer available** on **Windows** for **Python >
```

```bash
uv pip install -e ".[tf]"
pip install -e ".[tf]"
```
```{note}
For detailed installation instructions, please refer to the [official TensorFlow installation guide](https://www.tensorflow.org/install/pip).
Expand All @@ -202,3 +207,5 @@ dlclivegui # OR uv run dlclivegui
```{important}
Make sure your venv or conda environment is activated before running the application, so it can access the installed dependencies.
```

[^exp]: Support for this backend is currently experimental and may not work out of the box. Please refer to the backend-specific documentation for details and troubleshooting tips, and report any issues you encounter on GitHub to help us improve support for these backends.
2 changes: 1 addition & 1 deletion docs/dlc-live/dlc-live-gui/user_guide/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ To start running an experiment, the typical workflow is:

1. **Configure Cameras**
- Use **Configure Cameras…** to select one or more cameras and their parameters.
See {ref}`file:dlclivegui-camera-support` for details on supported camera backends and troubleshooting.
- See {ref}`file:dlclivegui-camera-support` for details on supported camera backends and troubleshooting.

2. **Start Preview**
- Click **Start Preview** to begin streaming all selected configured cameras.
Expand Down
3 changes: 3 additions & 0 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.