SWDEV-447333 - Corrected amdsmi_init() python documentation

Signed-off-by: Maisam Arif <maisarif@amd.com>
Change-Id: If46e7236316687cd97cf1a69770f87154e2681ff


[ROCm/amdsmi commit: 8bf2bd4b89]
Este commit está contenido en:
Maisam Arif
2024-03-26 07:59:50 -05:00
cometido por Maisam Arif
padre 0079a66c5b
commit 9fcbd0f477
+27 -9
Ver fichero
@@ -73,9 +73,9 @@ except AmdSmiException as e:
### amdsmi_init
Description: Dynamically initialize amdsmi with amd_hsmp and amdgpu drivers
Description: Initialize amdsmi with AmdSmiInitFlags
Input parameters: `None`
Input parameters: AmdSmiInitFlags
Output: `None`
@@ -83,19 +83,37 @@ Exceptions that can be thrown by `amdsmi_init` function:
* `AmdSmiLibraryException`
Example:
Initialize GPUs only example:
```python
try:
# by default we initalize with AmdSmiInitFlags.INIT_AMD_GPUS
init_flag = amdsmi_init()
# Print out integer bitmask of initialized drivers
# 1 is for amd_hsmp
# 2 is for amdgpu
# 3 is for amd_hsmp and amdgpu
print(init_flag)
# continue with amdsmi
except AmdSmiException as e:
print("Init failed")
print("Init GPUs failed")
print(e)
```
Initialize CPUs only example:
```python
try:
init_flag = amdsmi_init(AmdSmiInitFlags.INIT_AMD_CPUS)
# continue with amdsmi
except AmdSmiException as e:
print("Init CPUs failed")
print(e)
```
Initialize both GPUs and CPUs example:
```python
try:
init_flag = amdsmi_init(AmdSmiInitFlags.INIT_AMD_APUS)
# continue with amdsmi
except AmdSmiException as e:
print("Init both GPUs & CPUs failed")
print(e)
```