Skip to content

Commit a36e9a1

Browse files
Copilotmawad-amd
andcommitted
Document only user-facing hip APIs used in examples/tests
Co-authored-by: mawad-amd <[email protected]>
1 parent b8778e6 commit a36e9a1

File tree

1 file changed

+3
-32
lines changed

1 file changed

+3
-32
lines changed

docs/reference/api-hip-module.md

Lines changed: 3 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -2,46 +2,17 @@
22

33
Low-level HIP runtime integration for AMD GPU device management and memory operations.
44

5-
This module provides public APIs for device management, device attribute queries, and IPC memory operations.
6-
7-
## Device Management
8-
9-
### count_devices
10-
```{eval-rst}
11-
.. autofunction:: iris.hip.count_devices
12-
```
13-
14-
### set_device
15-
```{eval-rst}
16-
.. autofunction:: iris.hip.set_device
17-
```
5+
This module provides public APIs for querying device attributes.
186

197
## Device Attributes
208

21-
### get_cu_count
22-
```{eval-rst}
23-
.. autofunction:: iris.hip.get_cu_count
24-
```
25-
26-
### get_num_xcc
27-
```{eval-rst}
28-
.. autofunction:: iris.hip.get_num_xcc
29-
```
30-
319
### get_wall_clock_rate
3210
```{eval-rst}
3311
.. autofunction:: iris.hip.get_wall_clock_rate
3412
```
3513

36-
## IPC Memory Operations
37-
38-
### get_ipc_handle
39-
```{eval-rst}
40-
.. autofunction:: iris.hip.get_ipc_handle
41-
```
42-
43-
### open_ipc_handle
14+
### get_num_xcc
4415
```{eval-rst}
45-
.. autofunction:: iris.hip.open_ipc_handle
16+
.. autofunction:: iris.hip.get_num_xcc
4617
```
4718

0 commit comments

Comments
 (0)