butsugiri / gpustat

📊 A simple command-line script (wrapper for nvidia-smi) for querying and monitoring GPU status

gpustat

Just less than nvidia-smi?

Usage

$ gpustat

Options:

• --no-color : Suppress color (by default, color is enabled)
• -u, --show-user : Display username of the process owner
• -c, --show-cmd : Display the process name
• -p, --show-pid : Display PID of the process
• --json : JSON Output (Experimental, #10)

Tips

• To periodically watch, try watch --color -n1.0 gpustat (built-in watch support will be added soon).
• Running nvidia-smi daemon (root privilege required) will make the query much faster.
• The GPU ID (index) shown by gpustat (and nvidia-smi) is PCI BUS ID, while CUDA differently assigns the fastest GPU with the lowest ID by default. Therefore, in order to make CUDA and gpustat use same GPU index, configure the CUDA_DEVICE_ORDER environment variable to PCI_BUS_ID (before setting CUDA_VISIBLE_DEVICES for your CUDA program): export CUDA_DEVICE_ORDER=PCI_BUS_ID

Quick Installation

Install from PyPI:

sudo pip install gpustat

To install the latest version (master branch) via pip:

pip install git+https://github.com/wookayin/gpustat.git@master

Alternatively, you can just download an unstable version of gpustat.py (or any stable version) into somewhere in PATH, e.g. ~/.local/bin/ (when you do not have root privilege, for example):

sudo wget https://git.io/gpustat.py -O /usr/local/bin/gpustat && sudo chmod +x /usr/local/bin/gpustat

License

MIT License