[AMD-SMI] Export and document new fabric and process query APIs#7783
Merged
Conversation
gabrpham
approved these changes
Jun 24, 2026
dmitrii-galantsev
approved these changes
Jun 24, 2026
The 7.14 fabric (IFoE/UALoE) and PID-grouped process APIs shipped on develop but were unreachable from the package root and under-documented. Python package (py-interface/__init__.py): - Export amdsmi_get_gpu_process_list_by_pid, amdsmi_get_fabric_telemetry_data, and amdsmi_get_gpu_fabric_info; they were defined in amdsmi_interface but raised ImportError from `from amdsmi import ...` CLI guide (docs/how-to/amdsmi-cli-tool.md): - Add an `amd-smi fabric` subcommand section - Show the `--accelerator-partition` alias in the `amd-smi set` help block Python API reference (docs/reference/amdsmi-py-api.md): - Add entries for amdsmi_get_gpu_process_list_by_pid, amdsmi_get_gpu_fabric_info, and amdsmi_get_fabric_telemetry_data Changelog (CHANGELOG.md): - Add the amdsmi_get_gpu_process_list_by_pid / --sort-by-pid addition and the amdsmi_nic_link_type_t removal - List all five fabric C APIs and the two Python fabric APIs - Fix Sphinx hard breaks, collapse the wrapped static-clock entry, tighten wording Signed-off-by: Maisam Arif <Maisam.Arif@amd.com>
455f28e to
2b2221e
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
The 7.14 fabric (IFoE/UALoE) and PID-grouped process APIs already shipped on
develop, but they were not reachable from theamdsmipackage root and weremissing from the CLI guide, the Python API reference, and parts of the
changelog. This PR closes those gaps so the new APIs are usable via
from amdsmi import ...and fully documented for the release.Technical Details
Python package (
py-interface/__init__.py):amdsmi_get_gpu_process_list_by_pid,amdsmi_get_fabric_telemetry,and
amdsmi_get_gpu_fabric_info; they were defined inamdsmi_interfacebutraised
ImportErrorfrom the package rootCLI guide (
docs/how-to/amdsmi-cli-tool.md):amd-smi fabricsubcommand section--accelerator-partitionalias in theamd-smi sethelp blockPython API reference (
docs/reference/amdsmi-py-api.md):amdsmi_get_gpu_process_list_by_pid,amdsmi_get_gpu_fabric_info, andamdsmi_get_fabric_telemetryChangelog (
CHANGELOG.md):amdsmi_get_gpu_process_list_by_pid/--sort-by-pidaddition andthe
amdsmi_nic_link_type_tremovalIFoE/UALoE entry
static --clockheadline, andtighten redundant wording
The literal
amd-smi --helpcapture is intentionally left untouched:fabric(like
node/profile) is registered only when the amdgpu driver isinitialized, so it is documented as its own section rather than added to the
verbatim snapshot.
JIRA ID
N/A
Test Plan
pre-commit run --config projects/amdsmi/.pre-commit-config.yaml --files projects/amdsmi/py-interface/__init__.pypython3 -c "import ast; ast.parse(open('py-interface/__init__.py').read())"developdefect (ImportError: cannot import name 'amdsmi_get_fabric_telemetry') and confirmed the export change resolves itTest Result
__init__.pyparses; the three names are now importable fromamdsmiSubmission Checklist