Skip to content

Documentation: napari-deeplabcut CoTracker integration #3318

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

Draft
C-Achard wants to merge 10 commits into
base: cy/docs-audit-2026-toc-update
Choose a base branch
from
Draft

Documentation: napari-deeplabcut CoTracker integration #3318

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
3cb3916
Remove 'napari-DLC' prefix from headings
C-Achard May 8, 2026
98a9fbd
Add tracking controls documentation and image
C-Achard May 8, 2026
bbf30d7
Update _toc.yml
C-Achard May 8, 2026
f666cf2
chore(metadata): update docs/notebooks metadata
C-Achard May 8, 2026
7c1c768
chore(metadata): update docs/notebooks metadata
C-Achard May 8, 2026
3e1bcb2
docs: fix tracking docs typos and restructure sections
C-Achard May 8, 2026
da58038
Fix formatting and list numbering in tracking docs
C-Achard May 8, 2026
8cac078
Final consistency pass
C-Achard May 8, 2026
ea2db0e
Wording edits
C-Achard May 8, 2026
30494e8
Add GPU info, fix layer name versioning
C-Achard May 11, 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
Add GPU info, fix layer name versioning
  • Loading branch information
@C-Achard
C-Achard committed May 11, 2026
commit 30494e84191d47b706783e304453806a35ef0b97
9 changes: 7 additions & 2 deletions docs/gui/napari/tracking/basic_usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ The **Tracking Controls** widget is designed to help automate DeepLabCut annotat

## Requirements

```{tip}
We recommend **having a GPU available for tracking**, as it can be computationally intensive and slow on CPU.
Expect longer processing times on CPU, especially for longer videos or larger tracking ranges.
```

### In napari

```{important}
Expand Down Expand Up @@ -160,8 +165,8 @@ This is only available if the Keypoint controls widget has been opened.

Each tracking run creates a **new Points layer**:

- Named automatically (`[Tracking vXX] Ref. layer name - tT - Tracker name`)
- `XX` refers to the iteration number (if multiple tracking runs are performed from the same reference frame)
- Named automatically (`[Tracking v<XX>] Ref. layer name - t<T> - Tracker name`)
- `XX` refers to the iteration number (if multiple tracking runs are performed from the same reference layer and model)
- `T` refers to the reference frame index used to generate the tracking result
- Visually distinct from manual annotations:
- Cross symbol
Expand Down