Visitar URL original
Update DLC-live-GUI docs for latest version by C-Achard · Pull Request #3455 · DeepLabCut/DeepLabCut · GitHub
Skip to content

Update DLC-live-GUI docs for latest version #3455

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
C-Achard merged 16 commits into from
Aug 25, 2026
Merged

Update DLC-live-GUI docs for latest version #3455

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
b9ab644
Expand GUI docs with camera trigger settings
C-Achard Aug 19, 2026
15d287a
Document faster FFmpeg encoding option
C-Achard Aug 19, 2026
e2e5d3e
Document expanded DLC Live timestamp schema
C-Achard Aug 19, 2026
5415f9d
chore(metadata): update docs/notebooks metadata
C-Achard Aug 19, 2026
eec5d58
Add DLC Live GUI camera config guide
C-Achard Aug 19, 2026
420646c
Update DLC Live GUI docs for new camera features
C-Achard Aug 19, 2026
4ffc7e6
Add camera config page to DLC-Live TOC
C-Achard Aug 19, 2026
774d502
chore(metadata): update docs/notebooks metadata
C-Achard Aug 19, 2026
285788b
Fix typo
C-Achard Aug 19, 2026
02f8bc9
Clarify software timestamp source in docs
C-Achard Aug 19, 2026
d831541
Refine DLC Live GUI constraints wording
C-Achard Aug 24, 2026
13d485e
Fix typo
C-Achard Aug 24, 2026
df1c560
Fix missing local ToC entry
C-Achard Aug 24, 2026
aa88702
Fix figure RST directive to be MyST
C-Achard Aug 24, 2026
6c1d99e
Use dynamically generated local ToC
C-Achard Aug 24, 2026
bf8eba1
Update main window figure
C-Achard Aug 24, 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
1 change: 1 addition & 0 deletions _toc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ parts:
- file: docs/dlc-live/dlc-live-gui/user_guide/cameras_backends/basler_backend
- file: docs/dlc-live/dlc-live-gui/user_guide/cameras_backends/aravis_backend
- file: docs/dlc-live/dlc-live-gui/user_guide/cameras_backends/gentl_backend
- file: docs/dlc-live/dlc-live-gui/user_guide/camera_config
- file: docs/dlc-live/dlc-live-gui/user_guide/misc/misc_landing
sections:
- file: docs/dlc-live/dlc-live-gui/user_guide/misc/modelzoo_downloads
Expand Down
Binary file removed docs/dlc-live/dlc-live-gui/_static/images/main_window_100226.png
View file
Open in desktop
Binary file not shown.
Binary file added docs/dlc-live/dlc-live-gui/_static/images/main_window_gui.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 8 additions & 8 deletions docs/dlc-live/dlc-live-gui/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,10 @@ A graphical application for **real-time pose estimation with DeepLabCut** using

This GUI is designed for **scientists and experimenters** who want to preview, run inference, and record synchronized video with pose overlays—without writing code.

## Table of Contents
## Table of contents

- {doc}`Installation <./quickstart/install>`
- {doc}`Overview <./user_guide/overview>`
- {doc}`Camera setup and backends <./user_guide/cameras_backends/camera_support>`
- {doc}`Timestamp format and synchronization <./user_guide/misc/timestamp_format>`
```{tableofcontents}
```

```{caution}
Please be aware of the {ref}`sec:dlclivegui-index-limitations`
Expand Down Expand Up @@ -67,13 +65,15 @@ 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**
- 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.
- 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
- Trigger settings and hardware timestamps are supported for some backends only
- 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 a known issue for:
- SuperHuman model (missing detector)
- **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.
- Use faster encoding presets and retain Mono format on supported mono cameras for best performance
- Expect bottlenecks with heavy models, multiple high-resolution cameras, or CPU-only inference

______________________________________________________________________

Expand Down
Loading
Loading