Skip to content

Update installation docs for windows users with GPU #155

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

Open
deruyter92 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update installation docs for windows users with GPU #155

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,14 +77,18 @@ DeepLabCut-live can be installed from PyPI with PyTorch or Tensorflow directly:
uv pip install deeplabcut-live[pytorch] # or [tf]
```

Note: On **Windows**, the `deeplabcut-live[pytorch]` extra will not install the required CUDA-enabled wheels for PyTorch by default. For GPU support, install CUDA-enabled PyTorch first, then install `deeplabcut-live[pytorch]`.

Please see our instruction manual for more elaborate information on how to install on a [Windows or Linux machine](
docs/install_desktop.md) or on a [NVIDIA Jetson Development Board](
docs/install_jetson.md). Note, this code works with PyTorch, TensorFlow 1 or TensorFlow
docs/install_jetson.md).

This code works with PyTorch, TensorFlow 1 or TensorFlow
2 models, but whatever engine you exported your model with, you must import with the
same version (i.e., export a PyTorch model, then install PyTorch, export with TF1.13,
then use TF1.13 with DlC-Live; export with TF2.3, then use TF2.3 with DLC-live).

Note, you can test your installation by running:
You can test your installation by running:

```bash
dlc-live-test
Copy link
Collaborator

@C-Achard C-Achard Feb 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note : I think this script still needs to be fixed for pytorch

Expand Down
13 changes: 13 additions & 0 deletions docs/install_desktop.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,19 @@ Install from PyPI with PyTorch or TensorFlow:
# Or using uv
uv pip install deeplabcut-live[pytorch] # or [tf]
```

### Windows-users with GPU:
On **Windows**, the `deeplabcut-live[pytorch]` extra will not install the required CUDA-enabled wheels for PyTorch by default. Windows users with a CUDA GPU should install CUDA-enabled PyTorch first:


```bash
# First install PyTorch with CUDA support
pip install torch torchvision --index-url https://download.pytorch.org/whl/cu124

# Then install DeepLabCut-live (it will use the existing GPU-enabled PyTorch)
pip install deeplabcut-live[pytorch]
```


## 2. Install from Git Repository
If you want to install from a local clone of the repository, follow these steps:
Expand Down