File tree Expand file tree Collapse file tree 3 files changed +46
-28
lines changed
docs/doc_sources/api_reference/dpctl Expand file tree Collapse file tree 3 files changed +46
-28
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 64
64
65
65
.. rubric :: Enums
66
66
67
- .. autosummary ::
68
- :toctree: generated
69
- :nosignatures:
67
+ .. list-table ::
68
+ :widths: 10 50
70
69
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.
75
78
76
79
.. rubric :: Exceptions
77
80
Original file line number Diff line number Diff line change @@ -29,14 +29,12 @@ class device_type(Enum):
29
29
"""
30
30
An :class:`enum.Enum` of supported SYCL device types.
31
31
32
- Accepted enum values are
33
-
34
- ``all``:
35
- ``accelerator``
36
- ``automatic``
37
- ``cpu``
38
- ``custom``
39
- ``gpu``
32
+ | ``all``
33
+ | ``accelerator``
34
+ | ``automatic``
35
+ | ``cpu``
36
+ | ``custom``
37
+ | ``gpu``
40
38
41
39
:Example:
42
40
.. code-block:: python
@@ -65,13 +63,11 @@ class backend_type(Enum):
65
63
"""
66
64
An :class:`enum.Enum` of supported SYCL backends.
67
65
68
- Accepted enum values are
69
-
70
- ``all``:
71
- ``cuda``
72
- ``hip``
73
- ``level_zero``
74
- ``opencl``
66
+ | ``all``
67
+ | ``cuda``
68
+ | ``hip``
69
+ | ``level_zero``
70
+ | ``opencl``
75
71
76
72
:Example:
77
73
.. code-block:: python
@@ -95,6 +91,11 @@ class event_status_type(Enum):
95
91
"""
96
92
An :class:`enum.Enum` of SYCL event states.
97
93
94
+ | ``unknown_status``
95
+ | ``submitted``
96
+ | ``running``
97
+ | ``complete``
98
+
98
99
:Example:
99
100
.. code-block:: python
100
101
@@ -114,12 +115,10 @@ class global_mem_cache_type(Enum):
114
115
"""
115
116
An :class:`enum.Enum` of global memory cache types for a device.
116
117
117
- Accepted enum values are
118
-
119
- ``indeterminate``:
120
- ``none``
121
- ``read_only``
122
- ``read_write``
118
+ | ``indeterminate``
119
+ | ``none``
120
+ | ``read_only``
121
+ | ``read_write``
123
122
124
123
:Example:
125
124
.. code-block:: python
You can’t perform that action at this time.
0 commit comments