Skip to content

[AMD-SMI] Export and document new fabric and process query APIs#7783

Merged
marifamd merged 1 commit into
developfrom
users/marifamd/release-doc-export-fixes
Jun 25, 2026
Merged

[AMD-SMI] Export and document new fabric and process query APIs#7783
marifamd merged 1 commit into
developfrom
users/marifamd/release-doc-export-fixes

Conversation

@marifamd

Copy link
Copy Markdown
Contributor

Motivation

The 7.14 fabric (IFoE/UALoE) and PID-grouped process APIs already shipped on
develop, but they were not reachable from the amdsmi package root and were
missing 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):

  • Re-export amdsmi_get_gpu_process_list_by_pid, amdsmi_get_fabric_telemetry,
    and amdsmi_get_gpu_fabric_info; they were defined in amdsmi_interface but
    raised ImportError from the package root

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

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 under the
    IFoE/UALoE entry
  • Fix Sphinx hard breaks, collapse the wrapped static --clock headline, and
    tighten redundant wording

The literal amd-smi --help capture is intentionally left untouched: fabric
(like node/profile) is registered only when the amdgpu driver is
initialized, 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__.py
  • python3 -c "import ast; ast.parse(open('py-interface/__init__.py').read())"
  • Reproduced the develop defect (ImportError: cannot import name 'amdsmi_get_fabric_telemetry') and confirmed the export change resolves it
  • Verified balanced markdown code fences in both edited docs and zero remaining Sphinx hard-break violations in the 7.14 changelog section

Test Result

  • pre-commit: all hooks passed (codespell, ruff-format, trailing-whitespace)
  • __init__.py parses; the three names are now importable from amdsmi
  • Docs fences balanced; changelog 7.14 section clean

Submission Checklist

@marifamd marifamd requested a review from a team June 24, 2026 21:47
@github-actions github-actions Bot added documentation Improvements or additions to documentation project: amdsmi labels 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>
@marifamd marifamd force-pushed the users/marifamd/release-doc-export-fixes branch from 455f28e to 2b2221e Compare June 25, 2026 00:27
@marifamd marifamd merged commit 7c20953 into develop Jun 25, 2026
33 checks passed
@marifamd marifamd deleted the users/marifamd/release-doc-export-fixes branch June 25, 2026 01:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation organization: ROCm project: amdsmi

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants