@@ -42,28 +42,31 @@ While `deeplabcut-live-gui` is available on **PyPI**, the newest PySide6-based G
4242
4343To get the ** latest version** , please follow the ** instructions below** .
4444
45+ ### 1) Clone the repository
46+
47+ ``` bash
48+ git clone https://github.com/DeepLabCut/DeepLabCut-live-GUI.git
49+ cd DeepLabCut-live-GUI
50+ ```
51+
4552### Option A — Install with ` uv `
4653
47- #### 1 ) Create & activate a new virtual environment
54+ #### 2 ) Create & activate a new virtual environment
4855
4956``` bash
5057uv venv dlclivegui
58+
5159# Linux/macOS:
5260source dlclivegui/bin/activate
53- # Windows (Command Prompt):
54- # .\dlclivegui\Scripts\activate.bat
55- # Windows (PowerShell):
56- # .\dlclivegui\Scripts\Activate.ps1
57- ```
5861
59- #### 2) Clone the repository
62+ # Windows (Command Prompt):
63+ .\d lclivegui\S cripts\a ctivate.bat
6064
61- ``` bash
62- git clone https://github.com/DeepLabCut/DeepLabCut-live-GUI.git
63- cd DeepLabCut-live-GUI
65+ # Windows (PowerShell):
66+ .\d lclivegui\S cripts\A ctivate.ps1
6467```
6568
66- #### 3 ) Choose inference backend and install
69+ #### 2 ) Choose inference backend and install
6770
6871You may install ** PyTorch** or ** TensorFlow** extras (or both), but you must choose at least one to run inference.
6972
@@ -79,8 +82,6 @@ uv pip install -e .[pytorch]
7982uv pip install -e .[tf]
8083```
8184
82- > For GPU/CUDA specifics and framework compatibility, please follow the official PyTorch/TensorFlow install guidance for your OS.
83-
8485---
8586
8687### Option B — Install with ` mamba ` / ` conda `
@@ -92,14 +93,7 @@ conda create -n dlclivegui python=3.12
9293conda activate dlclivegui
9394```
9495
95- #### 2) Clone the repository
96-
97- ``` bash
98- git clone https://github.com/DeepLabCut/DeepLabCut-live-GUI.git
99- cd DeepLabCut-live-GUI
100- ```
101-
102- #### 3) Install with your inference backend
96+ #### 2) Install with your inference backend
10397
10498- ** PyTorch (recommended):**
10599
@@ -117,15 +111,20 @@ pip install -e .[tf]
117111
118112## Run the application
119113
114+ > [ !TIP]
115+ > For GPU/CUDA support specifics and framework compatibility, please follow the official PyTorch/TensorFlow install guidance for your OS and drivers.
116+
120117After installation, start the application with:
121118
122119``` bash
123- dlclivegui # in conda/mamba or after activating your venv
120+ dlclivegui # in conda/mamba
121+
124122# OR:
125123uv run dlclivegui
126124```
127125
128- > ** Important:** Activate your venv/conda environment before launching so the GUI can access installed dependencies.
126+ > [ !IMPORTANT]
127+ > Activate your venv/conda environment before launching so the GUI can access installed dependencies.
129128
130129---
131130
@@ -146,7 +145,8 @@ Typical workflow:
146145 - Adjust recording settings (codec, output format, etc.)
147146 - Record video and timestamps to organized session folders
148147
149- > ** Note:** OpenCV-compatible cameras (USB webcams, OBS virtual camera) work out of the box.
148+ > [ !NOTE]
149+ > OpenCV-compatible cameras (USB webcams, OBS virtual camera) work out of the box.
150150> For additional camera ecosystems (Basler, GenTL, Aravis, etc.), see the relevant documentation.
151151 <!-- TODO @C-Achard add link to docs website once available -->
152152
0 commit comments