Skip to content

Commit 77364ab

Browse files
authored
Update README install instructions for PyPI release (#64)
* Update README install instructions for PyPI Document that deeplabcut-live-gui 2.0 is available on PyPI and remove the previous "install from source" clone instructions. Update virtualenv (uv) instructions to use -p 3.12, switch pip commands from editable installs to installing the PyPI package (deeplabcut-live-gui[pytorch] / [tf]), and add a note to the conda creation command ("# or mamba"). These changes simplify installation by directing users to the PyPI package. * Use --pre for pip installs in README
1 parent 645720b commit 77364ab

File tree

1 file changed

+8
-14
lines changed

1 file changed

+8
-14
lines changed

README.md

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -34,23 +34,17 @@ The new interface supports **multi-camera preview** with a **tiled display**, Py
3434

3535
## Installation
3636

37-
While the previous `deeplabcut-live-gui` is available on PyPI, the newest PySide6-based GUI and features **must be obtained by installing from source**.
37+
`deeplabcut-live-gui` 2.0 is now available on PyPI.
3838

3939
To get the **latest version**, please follow the **instructions below**.
4040

41-
### 1) Clone the repository
42-
43-
```bash
44-
git clone https://github.com/DeepLabCut/DeepLabCut-live-GUI.git
45-
cd DeepLabCut-live-GUI
46-
```
4741

4842
### Option A — Install with `uv`
4943

50-
#### 2) Create & activate a new virtual environment
44+
#### 1) Create & activate a new virtual environment
5145

5246
```bash
53-
uv venv dlclivegui
47+
uv venv -p 3.12 dlclivegui
5448

5549
# Linux/macOS:
5650
source dlclivegui/bin/activate
@@ -69,13 +63,13 @@ You may install **PyTorch** or **TensorFlow** extras (or both), but you must cho
6963
- **PyTorch (recommended):**
7064

7165
```bash
72-
uv pip install -e .[pytorch]
66+
uv pip install --pre deeplabcut-live-gui[pytorch]
7367
```
7468

7569
- **TensorFlow (backwards compatibility):**
7670

7771
```bash
78-
uv pip install -e .[tf]
72+
uv pip install --pre deeplabcut-live-gui[tf]
7973
```
8074

8175
---
@@ -85,7 +79,7 @@ uv pip install -e .[tf]
8579
#### 1) Create & activate a new conda environment
8680

8781
```bash
88-
conda create -n dlclivegui python=3.12
82+
conda create -n dlclivegui python=3.12 # or mamba
8983
conda activate dlclivegui
9084
```
9185

@@ -94,13 +88,13 @@ conda activate dlclivegui
9488
- **PyTorch (recommended):**
9589

9690
```bash
97-
pip install -e .[pytorch]
91+
pip install --pre deeplabcut-live-gui[pytorch]
9892
```
9993

10094
- **TensorFlow:**
10195

10296
```bash
103-
pip install -e .[tf]
97+
pip install --pre deeplabcut-live-gui[tf]
10498
```
10599

106100
## Run the application

0 commit comments

Comments
 (0)