Skip to content

DLC-live-GUI docs : Install from PyPI pre-release #3238

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
MMathisLab merged 3 commits into from
Mar 25, 2026
Merged

DLC-live-GUI docs : Install from PyPI pre-release #3238

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
692bfe6
Install from PyPI pre-release; add both-backends
C-Achard Mar 11, 2026
4fddf67
Merge branch 'main' into cy/dlc-live-gui-release-docs
C-Achard Mar 19, 2026
ab2791d
Merge branch 'main' into cy/dlc-live-gui-release-docs
C-Achard Mar 25, 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
43 changes: 28 additions & 15 deletions docs/dlc-live/dlc-live-gui/quickstart/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ cd dlclivegui
uv venv -p 3.12 # or desired Python version
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 "deeplabcut-live-gui[pytorch] @ git+https://github.com/DeepLabCut/DeepLabCut-live-GUI.git"
uv pip install --pre "deeplabcut-live-gui[pytorch]"
dlclivegui
```

Expand All @@ -78,16 +78,9 @@ The main DeepLabCut package and its GUI are not required to use this software, a

### Install DeepLabCut-live-GUI

```{danger}
This beta version of the package is not currently on PyPI.
For this reason, the install process requires cloning the repository and installing from source.
```

#### Clone the repository

```bash
git clone https://github.com/DeepLabCut/DeepLabCut-live-GUI.git
cd DeepLabCut-live-GUI
```{important}
The current release is distributed on PyPI as a **pre-release**.
Use `--pre` when installing with `pip`/`uv pip` so the release candidate can be resolved.
```

#### Install with `uv`
Expand Down Expand Up @@ -133,7 +126,7 @@ To **enable GPU support** and obtain detailed installation instructions,
please refer to the [official PyTorch installation guide](https://pytorch.org/get-started/locally/) and install PyTorch **before** installing the GUI package.
```
```bash
uv pip install -e ".[pytorch]"
uv pip install --pre "deeplabcut-live-gui[pytorch]"
```
````

Expand All @@ -143,12 +136,22 @@ Please note TensorFlow is **no longer available** on **Windows** for **Python >
```

```bash
uv pip install -e ".[tf]"
uv pip install --pre "deeplabcut-live-gui[tf]"
```
```{note}
For detailed installation instructions, please refer to the [official TensorFlow installation guide](https://www.tensorflow.org/install/pip).
```
````

````{tab-item} Both backends
```{caution}
Installing both backends may increase environment size and dependency resolution time.
```

```bash
uv pip install --pre "deeplabcut-live-gui[pytorch,tf]"
```
````
`````

#### Install with `mamba` or `conda`
Expand All @@ -175,7 +178,7 @@ To **enable GPU support** and obtain detailed installation instructions,
please refer to the [official PyTorch installation guide](https://pytorch.org/get-started/locally/) and install PyTorch **before** installing the GUI package.
```
```bash
pip install -e ".[pytorch]"
pip install --pre "deeplabcut-live-gui[pytorch]"
```
````

Expand All @@ -185,12 +188,22 @@ Please note TensorFlow is **no longer available** on **Windows** for **Python >
```

```bash
pip install -e ".[tf]"
pip install --pre "deeplabcut-live-gui[tf]"
```
```{note}
For detailed installation instructions, please refer to the [official TensorFlow installation guide](https://www.tensorflow.org/install/pip).
```
````

````{tab-item} Both backends
```{caution}
Installing both backends may increase environment size and dependency resolution time.
```

```bash
pip install --pre "deeplabcut-live-gui[pytorch,tf]"
```
````
`````

## Verify installation
Expand Down
Loading