|
| 1 | +# TLDR |
| 2 | + |
| 3 | +**Start the TUI** to monitor AMD GPU usage |
| 4 | + |
| 5 | +```amdgpu_top``` |
| 6 | + |
| 7 | +**Launch the graphical interface** mode |
| 8 | + |
| 9 | +```amdgpu_top --gui``` |
| 10 | + |
| 11 | +**Launch simple TUI mode** similar to nvidia-smi |
| 12 | + |
| 13 | +```amdgpu_top --smi``` |
| 14 | + |
| 15 | +**Dump AMDGPU info** (specifications, VRAM, PCI, VBIOS) |
| 16 | + |
| 17 | +```amdgpu_top -d``` |
| 18 | + |
| 19 | +**Output JSON formatted data** for scripting |
| 20 | + |
| 21 | +```amdgpu_top -d --json``` |
| 22 | + |
| 23 | +**Display GPU processes** and memory usage per process |
| 24 | + |
| 25 | +```amdgpu_top -p``` |
| 26 | + |
| 27 | +**Select a specific GPU** by instance number |
| 28 | + |
| 29 | +```amdgpu_top -i [0]``` |
| 30 | + |
| 31 | +**Dump GPU metrics** for all AMD GPUs |
| 32 | + |
| 33 | +```amdgpu_top --gpu-metrics``` |
| 34 | + |
| 35 | +# SYNOPSIS |
| 36 | + |
| 37 | +**amdgpu_top** [_options_] |
| 38 | + |
| 39 | +# PARAMETERS |
| 40 | + |
| 41 | +**-d**, **--dump** |
| 42 | +> Dump AMDGPU info including specifications, VRAM, PCI, ResizableBAR, VBIOS, and video caps. |
| 43 | +
|
| 44 | +**--list** |
| 45 | +> Display a list of available AMDGPU devices. |
| 46 | +
|
| 47 | +**-J**, **--json** |
| 48 | +> Output JSON formatted data. Can be combined with the -d option. |
| 49 | +
|
| 50 | +**--gui** |
| 51 | +> Launch graphical interface mode. |
| 52 | +
|
| 53 | +**--smi** |
| 54 | +> Launch simple TUI mode similar to nvidia-smi or rocm-smi. |
| 55 | +
|
| 56 | +**-p**, **--process** |
| 57 | +> Dump all GPU processes and memory usage per process. |
| 58 | +
|
| 59 | +**-i** _INDEX_ |
| 60 | +> Select GPU instance by index number. |
| 61 | +
|
| 62 | +**--pci** _PATH_ |
| 63 | +> Specify PCI path in domain:bus:dev.func format. |
| 64 | +
|
| 65 | +**--apu**, **--select-apu** |
| 66 | +> Select APU instance. |
| 67 | +
|
| 68 | +**--single**, **--single-gpu** |
| 69 | +> Display only the selected APU/GPU. |
| 70 | +
|
| 71 | +**--no-pc** |
| 72 | +> Disable reading performance counters (GRBM, GRBM2). Useful to avoid deactivating power saving features. |
| 73 | +
|
| 74 | +**-gm**, **--gpu-metrics** |
| 75 | +> Dump gpu_metrics for all AMD GPUs. |
| 76 | +
|
| 77 | +**--pp-table** |
| 78 | +> Dump power/performance table from sysfs and VBIOS for all AMD GPUs. |
| 79 | +
|
| 80 | +**--drm-info** |
| 81 | +> Dump DRM information. |
| 82 | +
|
| 83 | +**-s** _MS_ |
| 84 | +> Set refresh interval in milliseconds for JSON mode (default: 1000ms). |
| 85 | +
|
| 86 | +**-n** _COUNT_ |
| 87 | +> Set maximum iteration count for JSON mode (0 = infinite). |
| 88 | +
|
| 89 | +**-u**, **--update-process-index** _SEC_ |
| 90 | +> Update interval in seconds for fdinfo (default: 5s). |
| 91 | +
|
| 92 | +**--dark**, **--dark-mode** |
| 93 | +> Enable dark mode for TUI/GUI. |
| 94 | +
|
| 95 | +**--light**, **--light-mode** |
| 96 | +> Enable light mode for TUI/GUI. |
| 97 | +
|
| 98 | +**--gl**, **--opengl** |
| 99 | +> Use OpenGL API for GUI backend. |
| 100 | +
|
| 101 | +**--vk**, **--vulkan** |
| 102 | +> Use Vulkan API for GUI backend. |
| 103 | +
|
| 104 | +**-V**, **--version** |
| 105 | +> Print version information. |
| 106 | +
|
| 107 | +**-h**, **--help** |
| 108 | +> Print help information. |
| 109 | +
|
| 110 | +# DESCRIPTION |
| 111 | + |
| 112 | +**amdgpu_top** is an AMD GPU monitoring tool that displays real-time utilization data similar to htop but specifically for AMD graphics hardware. It gathers information from performance counters (GRBM, GRBM2), sensors, fdinfo, and the AMDGPU driver to provide comprehensive GPU metrics. |
| 113 | + |
| 114 | +The tool offers three display modes: a full-featured TUI (default), a simplified SMI-style TUI, and a graphical interface. It monitors GPU activity, VRAM usage, temperature, power consumption, fan speed, and per-process GPU utilization. |
| 115 | + |
| 116 | +# TUI KEYBINDINGS |
| 117 | + |
| 118 | +**g** - Toggle GRBM performance counter |
| 119 | +**r** - Toggle GRBM2 performance counter |
| 120 | +**v** - Toggle VRAM/GTT usage display |
| 121 | +**f** - Toggle fdinfo display |
| 122 | +**n** - Toggle sensors display |
| 123 | +**m** - Toggle GPU metrics display |
| 124 | +**h** - Change update interval (high=100ms, low=1000ms) |
| 125 | +**P** - Sort fdinfo by PID |
| 126 | +**M** - Sort fdinfo by VRAM usage |
| 127 | +**G** - Sort fdinfo by GFX usage |
| 128 | +**R** - Reverse sort order |
| 129 | +**q** - Quit application |
| 130 | + |
| 131 | +# CAVEATS |
| 132 | + |
| 133 | +Reading performance counters (GRBM, GRBM2) may prevent the GPU from entering power-saving states on some APUs. Use **--no-pc** to disable performance counter reading if this is a concern. Requires the AMDGPU kernel driver and appropriate permissions to access GPU sysfs entries. |
| 134 | + |
| 135 | +# HISTORY |
| 136 | + |
| 137 | +**amdgpu_top** was created by Umio-Yasuno as a modern alternative to radeontop, written in **Rust**. It provides features that radeontop lacks, such as temperature monitoring, GPU metrics, and a graphical interface. The project is actively maintained and available on GitHub. |
| 138 | + |
| 139 | +# SEE ALSO |
| 140 | + |
| 141 | +[radeontop](/man/radeontop)(1), [nvtop](/man/nvtop)(1), [nvidia-smi](/man/nvidia-smi)(1), [intel_gpu_top](/man/intel_gpu_top)(1), [htop](/man/htop)(1) |
0 commit comments