SLEAP Connect
Remote training and inference for SLEAP: run sleap-nn on a GPU machine
from sleap-app, with no account or server in between.
Formerly
sleap-rtc(PyPIsleap-rtcstops at 0.0.7). Thesleap-rtccommand still works as an alias. An existing~/.sleap-rtcfolder (paired devices, shared folders, jobs) moves to~/.sleap-connectthe first time you runsleap-connect.
Quick start
1. Install on the GPU machine. The nn extra installs sleap-nn, which runs
the training and inference jobs, along with the worker; --torch-backend auto picks the PyTorch build
for your GPU:
uv tool install --python 3.11 "sleap-connect[nn]" --torch-backend auto
Check the machine is ready with sleap-connect doctor: it shows the GPU, and whether sleap-nn can start.
2. Start the worker in your data folder.
cd /path/to/your/data
sleap-connect serve
Or name the folder instead of cd-ing into it: sleap-connect serve /path/to/your/data (handy with
uv run). The first time, it asks whether to share this folder with the devices you pair. Answer y:
they can then browse it, and their jobs can read and write inside it. The answer is remembered.
The worker then runs in the background: you get your prompt back, and it keeps running after you
close the terminal or log out. Check on it with sleap-connect status and stop it with
sleap-connect serve --stop. So you don't forget it's running, new terminals show a one-line
reminder while it is (sleap-connect shell-hook uninstall removes it). Use --foreground to keep it
attached to the terminal instead.
3. Get a pairing code.
sleap-connect pair
It prints a one-line code starting with sleap1. It works once and expires after a few minutes.
4. Pair from sleap-app. In app.sleap.ai or the desktop app, open Connect → Pair a worker and paste the code. Then train or run inference from the Training panel or the Connect window.
The full guide (connection routes, the Connect window, troubleshooting) is in the sleap-app docs.
Commands
| Command | What it does |
|---|---|
sleap-connect serve [FOLDER] |
Start the worker in the background, sharing FOLDER (default: the current folder). --stop stops it; --foreground keeps it attached to the terminal (Ctrl-C to stop). |
sleap-connect status |
Show whether the worker is running: PID, uptime, address, shared folders, paired devices, jobs. |
sleap-connect pair |
Print a one-time pairing code for a new device. |
sleap-connect folders |
List the folders shared with paired devices. |
sleap-connect add-folder [FOLDER] |
Share another folder (relative paths are fine). |
sleap-connect remove-folder FOLDER |
Stop sharing a folder (by path or label). |
sleap-connect clients |
List paired devices: name, app, when paired, last seen. |
sleap-connect clients remove NAME |
Unpair a device (by name or ID prefix). --all unpairs every device and cancels unused pairing codes. |
sleap-connect doctor |
Check this machine is ready to run a worker: Python, dependencies, GPU, sleap-nn. |
sleap-connect shell-hook uninstall |
Remove the new-terminal reminder (install adds it back; set SLEAP_CONNECT_NO_SHELL_HOOK=1 to never add it). |
sleap-connect legacy … |
The older signaling-server workflow (accounts, rooms, train/track), being retired. The old top-level names still work. |
How it works
- The worker is the server.
servelistens for the app directly: a WebSocket on port 9631, result downloads on 9632, and an iroh endpoint. There's no signaling server, room, or login. - Pairing decides who gets in. A pairing code carries the worker's ID, its addresses and a
one-time secret. The app claims it once; after that the worker trusts that device's key, and
every connection proves it. Remove a device with
sleap-connect clients remove. - Two ways to connect. On the same network or over a VPN such as Tailscale, the app connects
to
ws://<worker>:9631. The desktop app can also connect over iroh, which goes through a relay first and then switches to a direct connection when it can, so it works across networks. Relays only see encrypted traffic. - Shared folders. Paired devices can only browse the folders the worker shares: the one
servestarted in, plus any added withadd-folder. The worker's own settings folder (~/.sleap-connect) is never shared. - Jobs live on the worker. Jobs queue and keep running if the app disconnects or the worker restarts; the app catches up on progress when it reconnects.
Installation options
Pick a PyTorch build explicitly instead of --torch-backend auto:
# CUDA GPU (here CUDA 12.8)
uv tool install --python 3.11 "sleap-connect[nn]" --torch-backend cu128
# CPU only
uv tool install --python 3.11 "sleap-connect[nn]" --torch-backend cpu
Already have sleap-nn installed on its own (uv tool install sleap-nn)? Install the worker without the
extra, uv tool install sleap-connect, and it runs the sleap-nn on your PATH. One installed with the
worker is used first.
The latest development version, from main:
uv tool install --python 3.11 "sleap-connect[nn] @ git+https://github.com/talmolab/sleap-connect" \
--torch-backend auto
To update, run the same command again with --reinstall. Upgrading from sleap-rtc 0.0.7 or
earlier? Remove it first (uv tool uninstall sleap-rtc): both install the same commands. Your paired
devices, shared folders and jobs are kept. On a fresh Linux container, sleap-nn may
also need system libraries: apt-get install -y libegl1 libgl1 libfontconfig1 (sleap-connect doctor names the one that's missing).
Legacy: rooms, dashboard and SLEAP GUI
The older workflow connects through a signaling server with GitHub login and rooms, over WebRTC.
It's still used by the dashboard, the
SLEAP GUI's Remote Training dialog, and the sleap-connect legacy train / sleap-connect legacy track commands. It
will be retired; sleap-app uses the pairing workflow above.
Legacy setup
Dashboard
-
Login — Go to the dashboard and log in with GitHub.
-
Create a room — Click Rooms → Create Room.
-
Generate an account key — Go to Account Keys and create one. Copy it for the worker.
-
Deploy a worker — On your GPU machine:
sleap-connect legacy login sleap-connect legacy config add-mount /path/to/your/data sleap-connect legacy worker --room <room-id>
-
Submit a job — In the dashboard, click Submit Job on your room card, select the worker, upload a config, and submit.
CLI
sleap-connect legacy login # GitHub login (opens browser)
sleap-connect legacy config add-mount /path/to/your/data
sleap-connect legacy worker --room <room-id> # on the GPU machine
sleap-connect legacy train --room <room-id> ... # from your machine
sleap-connect legacy track --room <room-id> ...
Docker
docker run --gpus all \
-e SLEAP_RTC_ACCOUNT_KEY=<your-account-key> \
-v /path/to/data:/app/shared_data \
ghcr.io/talmolab/sleap-rtc:latest \
worker --room <room-id>
Links
- SLEAP — pose estimation framework
- sleap-nn — neural network backend
- sleap-app — SLEAP in the browser and on the desktop
- Remote compute guide — pairing, connection routes, troubleshooting
- Dashboard — legacy rooms and jobs
Metadata
Release files for sleap-connect 0.0.8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sleap_connect-0.0.8.tar.gz | 831.9 kB | Without provenance | Details for sleap_connect-0.0.8.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sleap_connect-0.0.8-py3-none-any.whl | Python 3 | none | any | Details for sleap_connect-0.0.8-py3-none-any.whl |
Total release size: 1.3 MB
Release files / sleap_connect-0.0.8.tar.gz
| Download URL | sleap_connect-0.0.8.tar.gz |
|---|---|
| Size | 831.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c6f0cec701dfd0988c7aed3570b623e5c8aac63a570dca61a35ab64fcd353748
|
|
BLAKE2b-256 checksum How to use checksums |
3aee4ffcc1183396aa0fa1193001cad06407421b9f5d5c264b90ab9feb66521e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.7 {"installer":{"name":"uv","version":"0.13.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / sleap_connect-0.0.8-py3-none-any.whl
| Download URL | sleap_connect-0.0.8-py3-none-any.whl |
|---|---|
| Size | 514.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
36d291201c60347bc87dfe0cef5123f149c3b27611cc23d011e6931914c3b4da
|
|
BLAKE2b-256 checksum How to use checksums |
cc9995e3851ead8dcd898cff9e0897601a99a5da23ad03b38d8df454e3bb5cd7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.7 {"installer":{"name":"uv","version":"0.13.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for sleap-connect 0.0.8
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.