nvidia-smi-remote 0.1.2

CLI tool to query GPU status remotely (based on nvidia-smi)

nvidia-smi-remote

A CLI tool to display remote GPU status via SSH with colorful terminal output – showing GPU temperature, utilization, memory usage, and per-user process memory details. It’s like a remote version of nvidia-smi with enhanced readability!

This project is inspired by gpustat.

Quick Installation

Install from PyPI:

pip install nvidia-smi-remote

If you don’t have root privileges, try installing it in your user namespace:

pip install --user nvidia-smi-remote

To install the latest version from the master branch:

pip install git+https://github.com/ive2go/nvidia-smi-remote.git@master

NVIDIA Driver, nvidia-smi, and Python Requirements

• NVIDIA Requirement: This tool requires NVIDIA GPUs and the nvidia-smi utility to be installed on the target systems.
• Python Version: Python 3.8 or higher is recommended.
• Dependencies:
  • paramiko – For SSH connectivity.
  • blessed – For terminal styling.
  • The nvidia-smi command (bundled with the NVIDIA driver installation).

Usage

nvidia-smi-remote is designed to query GPU information from remote servers via SSH. You can supply the remote server configuration either via a JSON configuration file or by setting the environment variable NVIDIA_SMI_REMOTE_CONFIG.

Basic Usage with Configuration File:

nvidia-smi-remote -r config.json

Basic Usage with Environment Variable:

export NVIDIA_SMI_REMOTE_CONFIG=/path/to/config.json
nvidia-smi-remote

Command-line Options:

• -r, --remote-config : Path to the remote GPU server configuration JSON file (expects a list of server definitions).
• -i, --interval : Update interval in seconds (watch mode). Set to 0 for a single output.
• --no-header : Do not display the header (host, driver version, and time).
• --no-color : Disable colored terminal output.
• --used-only : Display only GPUs that have running processes.
• --unused-only : Display only GPUs without any running processes.

Remote Configuration JSON Example:

[
  {
    "host": "remote.server.com",
    "port": 22,
    "username": "user",
    "password": "password"
  },
  {
    "host": "another.server.com",
    "username": "user",
    "key_filename": "/path/to/private/key"
  }
]

Default Display Example:

remote.server.com  2025-04-03 12:34:56  450.80.02
[0] GeForce RTX 3080   | 65°C,  50 % | 4000/10000 MB | user (1500MiB)
--------------------------------------------------------------------------------

• Header: Displays the hostname, current timestamp, and driver version.
• GPU Line: Shows GPU index, name, temperature, utilization, memory usage, and the aggregated memory usage per user.

Changelog

See CHANGELOG.md for a complete list of changes.

License

MIT License

Contact

For questions or suggestions, please contact the author at [e-mail].