File tree Expand file tree Collapse file tree 3 files changed +36
-10
lines changed
docs/doc_sources/api_reference/dpctl Expand file tree Collapse file tree 3 files changed +36
-10
lines changed Original file line number Diff line number Diff line change 1+ .. _dpctl_constants :
2+
3+ Constants
4+ ========================
5+
6+ The following constants are defined in :py:mod: `dpctl `:
7+
8+ .. currentmodule :: dpctl
9+
10+ .. autodata :: backend_type
11+
12+ .. autodata :: device_type
13+
14+ .. autodata :: event_status_type
15+
16+ .. autodata :: global_mem_cache_type
Original file line number Diff line number Diff line change 6464
6565.. rubric :: Enums
6666
67- .. autosummary ::
68- :toctree: generated
69- :nosignatures:
67+ .. list-table ::
68+ :widths: 10 50
7069
71- device_type
72- backend_type
73- event_status_type
74- global_mem_cache_type
70+ * - :py:class: `dpctl.device_type `
71+ - An :class: `enum.Enum ` of supported SYCL device types.
72+ * - :py:class: `dpctl.backend_type `
73+ - An :class: `enum.Enum ` of supported SYCL backends.
74+ * - :py:class: `dpctl.event_status_type `
75+ - An :class: `enum.Enum ` of SYCL event states.
76+ * - :py:class: `dpctl.global_mem_cache_type `
77+ - An :class: `enum.Enum ` of global memory cache types for a device.
7578
7679.. rubric :: Exceptions
7780
Original file line number Diff line number Diff line change @@ -31,7 +31,7 @@ class device_type(Enum):
3131
3232 Accepted enum values are
3333
34- ``all``:
34+ ``all``
3535 ``accelerator``
3636 ``automatic``
3737 ``cpu``
@@ -67,7 +67,7 @@ class backend_type(Enum):
6767
6868 Accepted enum values are
6969
70- ``all``:
70+ ``all``
7171 ``cuda``
7272 ``hip``
7373 ``level_zero``
@@ -95,6 +95,13 @@ class event_status_type(Enum):
9595 """
9696 An :class:`enum.Enum` of SYCL event states.
9797
98+ Accepted enum values are
99+
100+ ``unknown_status``
101+ ``submitted``
102+ ``running``
103+ ``complete``
104+
98105 :Example:
99106 .. code-block:: python
100107
@@ -116,7 +123,7 @@ class global_mem_cache_type(Enum):
116123
117124 Accepted enum values are
118125
119- ``indeterminate``:
126+ ``indeterminate``
120127 ``none``
121128 ``read_only``
122129 ``read_write``
You can’t perform that action at this time.
0 commit comments