jlay/amdgpu_stats
Archived
1
1
Fork 0
Code Activity

reorganization

Browse source
This commit is contained in:
Josh Lay 2023-04-27 23:48:50 -05:00
parent 40bca912b4
commit a123d7117c
Signed by: jlay
GPG key ID: B265E45CACAD108A
1 changed files with 19 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

43
README.md
View file

@ -1,35 +1,22 @@
# amdgpu_stats
A simple Python module/TUI _(using [Textual](https://textual.textualize.io/))_ that shows AMD GPU statistics
A simple Python module/TUI for AMD GPU statistics
![Screenshot of main screen](https://raw.githubusercontent.com/joshlay/amdgpu_stats/master/screens/main.png "Main screen")
The GPU and temperature nodes (`edge`/`junction`/etc.) are discovered automatically.
Please see [the module section](#module) or [the docs](https://amdgpu-stats.readthedocs.io/en/latest/) for information on usage as an `import` in other tooling
Supported GPUs and temperature nodes (`edge`/`junction`/etc.) are discovered automatically.
Tested _only_ on `RX6000` series cards; APUs and more _may_ be supported. Please file an issue if finding incompatibility!
## Requirements
Only `Linux` is supported. Information is _completely_ sourced from interfaces in `sysfs`.
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.
## Installation / Usage
## Installation
```
pip install amdgpu-stats
```
Once installed, run `amdgpu-stats` in your terminal of choice
To use the _TUI_, run `amdgpu-stats` in your terminal of choice. For the _module_, see below!
## Module
*Rudimentary* support as a module exists; functions / variables offered can be found in `amdgpu_stats.utils`
Demonstration:
Introduction:
```
In [1]: import amdgpu_stats.utils
@ -39,14 +26,22 @@ Out[2]: {'card0': '/sys/class/drm/card0/device/hwmon/hwmon9'}
In [3]: amdgpu_stats.utils.get_core_stats('card0')
Out[3]: {'sclk': 640000000, 'mclk': 1000000000, 'voltage': 0.79, 'util_pct': 65}
In [4]: amdgpu_stats.utils.get_clock('card0', 'core', format_freq=True)
In [4]: amdgpu_stats.utils.get_clock('core', format_freq=True)
Out[4]: '659 MHz'
```
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)
Feature requests [are encouraged](https://github.com/joshlay/amdgpu_stats/issues) :)
## Documentation
## Requirements
Only `Linux` is supported. Information is _completely_ sourced from interfaces in `sysfs`.
For more information on the module, see:
- `help('amdgpu_stats.utils')` in your interpreter
- [ReadTheDocs](https://amdgpu-stats.readthedocs.io/en/latest/)
- [the module source](https://github.com/joshlay/amdgpu_stats/blob/master/src/amdgpu_stats/utils.py) for more info
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.