Archived
1
1
Fork 0
This repository has been archived on 2024-03-02. You can view files and clone it, but cannot push or open issues or pull requests.
amdgpu_stats/README.md

48 lines
1.6 KiB
Markdown
Raw Normal View History

2023-04-21 05:42:38 +00:00
# amdgpu_stats
2023-04-30 02:17:28 +00:00
A Python module/TUI for AMD GPU statistics
2023-04-23 16:07:06 +00:00
![Screenshot of main screen](https://raw.githubusercontent.com/joshlay/amdgpu_stats/master/screens/main.png "Main screen")
2023-04-23 16:07:06 +00:00
2023-04-28 04:48:50 +00:00
Supported GPUs and temperature nodes (`edge`/`junction`/etc.) are discovered automatically.
2023-04-23 16:07:06 +00:00
2023-04-25 02:41:50 +00:00
Tested _only_ on `RX6000` series cards; APUs and more _may_ be supported. Please file an issue if finding incompatibility!
2023-04-28 04:48:50 +00:00
## Installation
2023-04-25 02:41:50 +00:00
```
pip install amdgpu-stats
```
2023-04-28 04:48:50 +00:00
To use the _TUI_, run `amdgpu-stats` in your terminal of choice. For the _module_, see below!
2023-04-25 02:41:50 +00:00
## Module
2023-04-28 04:48:50 +00:00
Introduction:
2023-04-25 02:41:50 +00:00
```
2023-04-25 06:20:12 +00:00
In [1]: import amdgpu_stats.utils
2023-04-27 04:00:51 +00:00
In [2]: amdgpu_stats.utils.AMDGPU_CARDS
Out[2]: {'card0': '/sys/class/drm/card0/device/hwmon/hwmon9'}
2023-04-25 02:41:50 +00:00
2023-04-27 04:00:51 +00:00
In [3]: amdgpu_stats.utils.get_core_stats('card0')
Out[3]: {'sclk': 640000000, 'mclk': 1000000000, 'voltage': 0.79, 'util_pct': 65}
2023-04-25 02:41:50 +00:00
2023-04-28 04:48:50 +00:00
In [4]: amdgpu_stats.utils.get_clock('core', format_freq=True)
2023-04-27 04:00:51 +00:00
Out[4]: '659 MHz'
2023-04-25 02:41:50 +00:00
```
2023-04-28 04:48:50 +00:00
For more information on what the module provides, please see:
- [ReadTheDocs](https://amdgpu-stats.readthedocs.io/en/latest/)
- `help('amdgpu_stats.utils')` in your interpreter
- [The module source](https://github.com/joshlay/amdgpu_stats/blob/master/src/amdgpu_stats/utils.py)
2023-04-30 02:17:28 +00:00
Feature requests [are encouraged](https://github.com/joshlay/amdgpu_stats/issues) 😀
2023-04-27 04:00:51 +00:00
2023-04-28 04:48:50 +00:00
## Requirements
Only `Linux` is supported. Information is _completely_ sourced from interfaces in `sysfs`.
2023-04-26 03:34:42 +00:00
2023-04-28 04:48:50 +00:00
It _may_ be necessary to update the `amdgpu.ppfeaturemask` parameter to enable metrics.
This is assumed present for *control* over the elements being monitored. Untested without.
See [this Arch Wiki entry](https://wiki.archlinux.org/title/AMDGPU#Boot_parameter) for context.