Skip to content

Commit 1ace543

Browse files
author
Diptorup Deb
committed
Update the Python API rst.
1 parent fb4a640 commit 1ace543

File tree

2 files changed

+19
-9
lines changed

2 files changed

+19
-9
lines changed

docs/dpctl_api.rst

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ Classes
2222
:members:
2323
:undoc-members:
2424

25+
.. autoclass:: dpctl.SyclPlatform
26+
:members:
27+
:undoc-members:
28+
2529
.. autoclass:: dpctl.SyclQueue
2630
:members:
2731
:undoc-members:
@@ -41,21 +45,27 @@ Exceptions
4145
.. autoexception:: dpctl.SyclKernelInvalidRangeError
4246
.. autoexception:: dpctl.SyclKernelSubmitError
4347
.. autoexception:: dpctl.SyclQueueCreationError
44-
.. autoexception:: dpctl.UnsupportedBackendError
45-
.. autoexception:: dpctl.UnsupportedDeviceError
4648

4749
Functions
4850
---------
4951

52+
.. autofunction:: get_devices
53+
.. autofunction:: select_accelerator_device
54+
.. autofunction:: select_cpu_device
55+
.. autofunction:: select_default_device
56+
.. autofunction:: select_gpu_device
57+
.. autofunction:: select_host_device
58+
.. autofunction:: get_num_devices
59+
.. autofunction:: has_cpu_devices
60+
.. autofunction:: has_gpu_devices
61+
.. autofunction:: has_accelerator_devices
62+
.. autofunction:: has_host_device
63+
.. autofunction:: get_platforms
64+
.. autofunction:: lsplatform
5065
.. autofunction:: device_context
51-
.. autofunction:: dump
5266
.. autofunction:: get_current_backend
5367
.. autofunction:: get_current_device_type
5468
.. autofunction:: get_current_queue
55-
.. autofunction:: get_include
5669
.. autofunction:: get_num_activated_queues
57-
.. autofunction:: get_num_platforms
58-
.. autofunction:: get_num_devices
59-
.. autofunction:: has_sycl_platforms
6070
.. autofunction:: is_in_device_context
6171
.. autofunction:: set_global_queue

dpctl/_sycl_device.pyx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@
1717
# distutils: language = c++
1818
# cython: language_level=3
1919

20-
""" Implements SyclDevice Cython extension type.
20+
"""
21+
Implements SyclDevice Cython extension type.
2122
"""
2223

2324
from ._backend cimport (
@@ -110,7 +111,6 @@ cdef class SyclDevice(_SyclDevice):
110111
:func:`dpctl.select_gpu_device()`,
111112
:func:`dpctl.select_host_device()`.
112113
113-
114114
:Example:
115115
.. code-block:: python
116116

0 commit comments

Comments
 (0)