54eba4b8a8
* add API doc comments to goamdsmi.go
* update README and usage
* add sphinx directive to parse go doc
* fix walrus operator typos
* make docs more consistent
* add Go docs to index.md
---------
Signed-off-by: Arif, Maisam <Maisam.Arif@amd.com>
[ROCm/amdsmi commit: 15c32f6116]
854 B
854 B
myst
| myst | ||||||
|---|---|---|---|---|---|---|
|
AMD SMI Go API reference
The AMD SMI Go interface provides a convenient way to interact with AMD hardware through a simple and accessible API. The API is compatible with Go version 1.20 and higher and requires the AMD driver to be loaded for initialization. Review the prerequisites before getting started.
This section provides documentation for the AMD SMI Go API. Explore these sections to understand the full scope of available functionalities and how to implement them in your applications.
GPU functions
.. go-api-ref:: ../../goamdsmi.go
:section: gpu
CPU functions
.. go-api-ref:: ../../goamdsmi.go
:section: cpu