Tmux-based system monitoring dashboard for ML research workstations
Project description
research-dashboard
A tmux-based system monitoring dashboard for ML research workstations. One command gives you GPU, CPU, disk I/O, network, temperatures, RAID status, and live log tailing in a single terminal.
Installation
pip install research-dashboard
Or install from source:
git clone https://github.com/ahbond/research-dashboard.git
cd research-dashboard
pip install -e .
Usage
research-dashboard
Options
| Flag | Description |
|---|---|
--session-name |
Tmux session name (default: atlas-dash) |
--no-gpu |
Skip GPU monitoring pane |
--no-net |
Skip network monitoring pane |
--no-disk |
Skip disk I/O monitoring pane |
--dry-run |
Print tmux commands without executing them |
Examples
# Launch with defaults
research-dashboard
# Custom session name, skip network pane
research-dashboard --session-name ml-monitor --no-net
# Preview commands without launching
research-dashboard --dry-run
Layout
+---------------------+----------------------+
| nvtop (GPUs) | htop (processes) |
| | |
+----------+----------+----------+------------+
| iotop | nethogs | sensors | live logs |
| (disk) | (net) | raid/df | |
+----------+----------+----------+------------+
- Top-left -- GPU monitoring via
nvtop(falls back tonvidia-smi watch) - Top-right -- Process monitoring via
htop(falls back tobtoportop) - Bottom-left -- Disk I/O via
iotop(falls back toiostat) - Bottom-mid-left -- Network via
nethogs(falls back tonloador/proc/net/dev) - Bottom-mid-right -- Temperatures, GPU stats, RAID status, disk usage
- Bottom-right -- Live log tailing from
/tmp/*.log
Requirements
- tmux (required)
- Optional monitoring tools (the dashboard adapts to what is installed):
nvtopornvidia-smi-- GPU monitoringhtop,btop, ortop-- process monitoringiotoporiostat-- disk I/Onethogsornload-- network monitoringsensors(lm-sensors) -- temperature readings
Install everything on Ubuntu/Debian:
sudo apt install tmux nvtop htop iotop nethogs lm-sensors
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file research_dashboard-0.1.0.tar.gz.
File metadata
- Download URL: research_dashboard-0.1.0.tar.gz
- Upload date:
- Size: 7.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e558daee8895e7f278087067a98fa0a41d98e12125b0ecab25468c95b68eae6e
|
|
| MD5 |
967753a4ea3a14d8c27d6bdf97754d7b
|
|
| BLAKE2b-256 |
7d3e920abfde6e20fc6fc3f5513e7f820323f6dd95d9b2ccdf3a61f4482cef60
|
File details
Details for the file research_dashboard-0.1.0-py3-none-any.whl.
File metadata
- Download URL: research_dashboard-0.1.0-py3-none-any.whl
- Upload date:
- Size: 7.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fa9c14ac70350b0eea085bbabd87920726dd0ed5bd4a969c35ecad4c7bf3637f
|
|
| MD5 |
9b64a7dde8a17e15c3af7a509c16ccf1
|
|
| BLAKE2b-256 |
60a1ba377a0ec4d15ec4e74451408a94a1341655123d12f68fb1b5fa858c2d84
|