Skip to content

Commit 85d4e18

Browse files
committed
public IPC class and update the docs
Signed-off-by: Zhan Xue <zhan.xue@intel.com>
1 parent 356ee5e commit 85d4e18

3 files changed

Lines changed: 24 additions & 0 deletions

File tree

docs/doc_sources/api_reference/dpctl/memory.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,27 @@ Should the USM allocation fail, the following Python exception will be raised:
6666

6767
USMAllocationError
6868

69+
.. rubric:: IPC (Inter-Process Communication) Memory
70+
71+
Classes and functions for sharing USM device allocations across processes
72+
using IPC memory handles.
73+
74+
.. autosummary::
75+
:toctree: generated
76+
:template: autosummary/usmmemory.rst
77+
:nosignatures:
78+
79+
IPCMemoryHandle
80+
MemoryIPCDevice
81+
82+
.. autosummary::
83+
:toctree: generated
84+
:nosignatures:
85+
86+
SyclIPCGetMemHandle
87+
SyclIPCOpenMemHandle
88+
SyclIPCCloseMemHandle
89+
6990
.. toctree::
7091
:hidden:
7192

dpctl/memory/__init__.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
"""
3131

3232
from ._memory import (
33+
IPCMemoryHandle,
3334
MemoryIPCDevice,
3435
MemoryUSMDevice,
3536
MemoryUSMHost,
@@ -42,6 +43,7 @@
4243
)
4344

4445
__all__ = [
46+
"IPCMemoryHandle",
4547
"MemoryIPCDevice",
4648
"MemoryUSMDevice",
4749
"MemoryUSMHost",

dpctl/memory/_memory.pyx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ __all__ = [
7979
"MemoryUSMHost",
8080
"MemoryUSMDevice",
8181
"MemoryIPCDevice",
82+
"IPCMemoryHandle",
8283
"USMAllocationError",
8384
"SyclIPCGetMemHandle",
8485
"SyclIPCOpenMemHandle",

0 commit comments

Comments
 (0)