Skip to content

Add docs link to README #63

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
C-Achard merged 3 commits into from
Mar 10, 2026
Merged

Add docs link to README #63

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
08ad3b3
Remove outdated docs
C-Achard Mar 10, 2026
8848c0e
Add link to docs website
C-Achard Mar 10, 2026
759e706
Remove separators in README
C-Achard Mar 10, 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
16 changes: 2 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,9 @@ The GUI has been modernized and is now built with **PySide6 (Qt)** (replacing tk

The new interface supports **multi-camera preview** with a **tiled display**, PyTorch models, and features improved interactive workflows for experimental use.

---

## Documentation

> Full documentation is a work in progress and will be posted to DeepLabCut's official docs site when ready.

---
> Find the full documentation at the [DeepLabCut docs website](https://deeplabcut.github.io/DeepLabCut/docs/dlc-live/dlc-live-gui/index.html)

## System requirements (quick summary)

Expand All @@ -36,8 +32,6 @@ The new interface supports **multi-camera preview** with a **tiled display**, Py
- **TensorFlow** *(for backwards compatibility with existing models; Windows installs are no longer available for Python > 3.10)*
- A supported camera backend (OpenCV webcams by default; additional backends supported)

---

## Installation

While the previous `deeplabcut-live-gui` is available on PyPI, the newest PySide6-based GUI and features **must be obtained by installing from source**.
Expand Down Expand Up @@ -109,8 +103,6 @@ pip install -e .[pytorch]
pip install -e .[tf]
```

---

## Run the application

> [!TIP]
Expand All @@ -128,8 +120,6 @@ uv run dlclivegui
> [!IMPORTANT]
> Activate your venv/conda environment before launching so the GUI can access installed dependencies.

---

## Typical workflow

The new GUI supports **one or more cameras**.
Expand All @@ -152,8 +142,6 @@ Typical workflow:
> For additional camera ecosystems (Basler, GenTL, Aravis, etc.), see the relevant documentation.
<!-- TODO @C-Achard add link to docs website once available -->

---

## Current limitations

- Pose inference runs on **one selected camera at a time** (even in multi-camera mode)
Expand All @@ -177,4 +165,4 @@ If you use this code, we kindly ask you to please cite:

This project is under active development — feedback from real experimental use is highly valued.

Please report issues, suggest features, or contribute on [GitHub](https://github.com/DeepLabCut/DeepLabCut-live-GUI).
Please report issues, suggest features, or contribute here on [GitHub](https://github.com/DeepLabCut/DeepLabCut-live-GUI/issues).
261 changes: 0 additions & 261 deletions docs/README.md
View file
Open in desktop

This file was deleted.

Loading