Skip to content

Commit 074a0f0

Browse files
committed
Update README for PySide6 GUI and wording
Clarify and reflow README content for the new PySide6-based GUI: split and reword the Update paragraph, emphasize that the newest GUI must be obtained by installing from source (while the previous package remains on PyPI), strengthen formatting for the GPU/CUDA install tip, and fix a minor punctuation change in the citation request.
1 parent 5d4d572 commit 074a0f0

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ GUI to run [DeepLabCut-Live](https://github.com/DeepLabCut/DeepLabCut-live) on a
1616

1717
## Update
1818

19-
> The GUI has been modernized and is now built with **PySide6 (Qt)** (replacing tkinter). The new interface supports **multi-camera preview** with a **tiled display**, PyTorch models, and features improved interactive workflows for experimental use.
19+
The GUI has been modernized and is now built with **PySide6 (Qt)** (replacing tkinter).
20+
21+
The new interface supports **multi-camera preview** with a **tiled display**, PyTorch models, and features improved interactive workflows for experimental use.
2022

2123
---
2224

@@ -38,7 +40,7 @@ GUI to run [DeepLabCut-Live](https://github.com/DeepLabCut/DeepLabCut-live) on a
3840

3941
## Installation
4042

41-
While `deeplabcut-live-gui` is available on **PyPI**, the newest PySide6-based GUI and features are currently best obtained by installing from source.
43+
While the previous `deeplabcut-live-gui` is available on PyPI, the newest PySide6-based GUI and features **must be obtained by installing from source**.
4244

4345
To get the **latest version**, please follow the **instructions below**.
4446

@@ -112,7 +114,7 @@ pip install -e .[tf]
112114
## Run the application
113115

114116
> [!TIP]
115-
> For GPU/CUDA support specifics and framework compatibility, please follow the official PyTorch/TensorFlow install guidance for your OS and drivers.
117+
> For GPU/CUDA support specifics and framework compatibility, please follow the **official PyTorch/TensorFlow install guidance** for your OS and drivers.
116118
117119
After installation, start the application with:
118120

@@ -164,7 +166,7 @@ Typical workflow:
164166

165167
## References
166168

167-
If you use this code we kindly ask you to please cite:
169+
If you use this code, we kindly ask you to please cite:
168170

169171
- **[Kane et al., eLife 2020](https://elifesciences.org/articles/61909)**
170172
- If preferred, see the **[Preprint](https://www.biorxiv.org/content/10.1101/2020.08.04.236422v2)**

0 commit comments

Comments
 (0)