Skip to main content

Peek into slurm's resource info such as GPU avaiability, usage per user, job status, and more.

Project description

🔍 speek

speek is a suite of SLURM cluster monitoring tools — from quick one-shot snapshots to a full interactive TUI.

Installation

pip install speek

For the latest development version:

pip install --pre speek

Commands

Command Description
speek0 Classic one-shot cluster overview — GPU availability, per-user usage, job status
speek- Compact snapshot — per-model GPU bars, trends, pending pressure
speek+ Full interactive TUI — queue, nodes, users, stats, events, shell

speek0 — Classic Overview

speek0 [-u USER] [-f FILE] [-t T_AVAIL]
Option Description
-u USER Highlight a specific user (default: self)
-f FILE User info CSV file
-t T_AVAIL Time window for upcoming release, e.g. 5 m, 1 h

Shows a table of GPU usage per partition, ranked users with 🥇🥈🥉, utilization-colored counts, and your current jobs.

speek- — Compact Snapshot

speek- [-u USER]

Per-GPU-model view with utilization bars, free/total counts, pending pressure (⏸N), availability trends (↑↓), and your running/pending jobs. Detects down nodes and shows them as DEAD.

speek+ — Interactive TUI

speek+

Full-featured Textual TUI with:

  • Cluster — speek0-style usage table (tab 1)
  • Queue — all cluster jobs grouped by partition, foldable
  • Nodes — per-partition node status with usage bars
  • Users — per-user GPU usage, fairshare, per-partition breakdown
  • Stats — GPU usage charts, per-user stacked view, issue dashboard
  • Logs — session CLI output (not persisted)
  • Settings — theme, refresh rates, cache management, log scanning
  • Info — cluster probe results, scheduling factors, error detection rules
  • Help — keybindings reference

Features

  • 70+ color themes (base16 standard)
  • OOM and error detection (11 error types) with log scanning
  • Job detail popup with stdout, stderr, GPU stats, analysis
  • Built-in shell with tab completion, history, sbatch suggestions
  • Per-job log hints in the table
  • Event notifications with read/unread tracking
  • Down node detection with DEAD indicators

Requirements

  • Python 3.8+
  • SLURM cluster with squeue, scontrol, sinfo
  • Optional: sacct, sprio, sshare, sreport, scancel for full features
  • rich (all commands), textual>=0.50.0 (speek+ only)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

speek-0.0.2.tar.gz (8.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

speek-0.0.2-py3-none-any.whl (8.5 kB view details)

Uploaded Python 3

File details

Details for the file speek-0.0.2.tar.gz.

File metadata

  • Download URL: speek-0.0.2.tar.gz
  • Upload date:
  • Size: 8.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for speek-0.0.2.tar.gz
Algorithm Hash digest
SHA256 15f5c0807a1be0b6d83deca93b5242568a9400bf0708ade722aa299f8e1328ce
MD5 92aef2093d706e20141917551f0a2e30
BLAKE2b-256 52894adb8a14362cfde0dbe6370ffdb1dd79abcb875ce0152d3109dd77b09e2f

See more details on using hashes here.

Provenance

The following attestation bundles were made for speek-0.0.2.tar.gz:

Publisher: publish.yml on dongyeoplee2/speek

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file speek-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: speek-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 8.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for speek-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e72c92673e7032076731040cf1eff185103b5e1881f27a8d207abf2fbd16c4a0
MD5 afb3c577fba4ee29f3ba9f268a97eadc
BLAKE2b-256 1546f67f6262b4a4b101dc4785906880ebe80b5ceae99c19d144209bdbf21060

See more details on using hashes here.

Provenance

The following attestation bundles were made for speek-0.0.2-py3-none-any.whl:

Publisher: publish.yml on dongyeoplee2/speek

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page