Skip to content

Commit f292953

Browse files
Update dpctl_pyapi.rst (#661)
Rearranged the order of classes and functions to make the documentation flow more logical. Provided actual links to the SYCL Reference Manual describing Programs and Kernels. Co-authored-by: samaid <sergey.maidanov@gmail.com>
1 parent 0cd7b35 commit f292953

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

docs/docfiles/dpctl_pyapi.rst

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -14,25 +14,26 @@ Sub-modules
1414
:mod:`dpctl.memory`
1515
USM allocators and deallocators and classes that implement Python's
1616
`buffer protocol`_.
17+
:mod:`dpctl.tensor`
18+
Implementation of different types of tensor classes that use USM memory.
1719
:mod:`dpctl.program`
18-
Experimental wrappers for SYCL 1.2 ``program`` and ``kernel`` classes.
20+
Experimental wrappers for SYCL 1.2 `Program`<https://sycl.readthedocs.io/en/latest/iface/program.html>
21+
and `Kernel`<https://sycl.readthedocs.io/en/latest/iface/kernel.html> classes.
1922
The module is going to be refactored in the future to support SYCL
20-
2020's ``kernel_bundle`` feature and the wrapper for the ``program``
23+
2020's ``sycl::kernel_bundle`` feature and the wrapper for the ``sycl::program``
2124
class is going to be removed.
22-
:mod:`dpctl.tensor`
23-
Implementation of different types of tensor classes that use USM memory.
2425

2526
Classes
2627
-------
2728

2829
.. toctree::
2930
:maxdepth: 1
3031

31-
dpctl.SyclContext : A Python class representing `sycl::context` <dpctl_pyapi/SyclContext>
32-
dpctl.SyclDevice : A Python class representing `sycl::device` <dpctl_pyapi/SyclDevice>
33-
dpctl.SyclEvent : A Python class representing `sycl::event` <dpctl_pyapi/SyclEvent>
34-
dpctl.SyclPlatform : A Python class representing `sycl::platform` <dpctl_pyapi/SyclPlatform>
35-
dpctl.SyclQueue : A Python class representing `sycl::queue` <dpctl_pyapi/SyclQueue>
32+
`dpctl.SyclPlatform`<dpctl_pyapi/SyclPlatform> : A Python class representing `SYCL Platforms`<https://sycl.readthedocs.io/en/latest/iface/platform.html>
33+
`dpctl.SyclDevice`<dpctl_pyapi/SyclDevice> : A Python class representing `SYCL Devices`<https://sycl.readthedocs.io/en/latest/iface/device.html>
34+
`dpctl.SyclQueue`<dpctl_pyapi/SyclQueue> : A Python class representing `SYCL Queues`<https://sycl.readthedocs.io/en/latest/iface/queue.html>
35+
`dpctl.SyclContext`<dpctl_pyapi/SyclContext> : A Python class representing `SYCL Contexts`<https://sycl.readthedocs.io/en/latest/iface/context.html>
36+
`dpctl.SyclEvent`<dpctl_pyapi/SyclEvent> : A Python class representing `SYCL Events`<https://sycl.readthedocs.io/en/latest/iface/event.html>
3637

3738
Enumerations
3839
------------
@@ -53,17 +54,17 @@ Exceptions
5354
Device Selection Functions
5455
--------------------------
5556

56-
.. autofunction:: get_devices
57-
.. autofunction:: select_accelerator_device
58-
.. autofunction:: select_cpu_device
59-
.. autofunction:: select_default_device
60-
.. autofunction:: select_gpu_device
61-
.. autofunction:: select_host_device
6257
.. autofunction:: get_num_devices
58+
.. autofunction:: get_devices
59+
.. autofunction:: has_host_device
6360
.. autofunction:: has_cpu_devices
6461
.. autofunction:: has_gpu_devices
6562
.. autofunction:: has_accelerator_devices
66-
.. autofunction:: has_host_device
63+
.. autofunction:: select_default_device
64+
.. autofunction:: select_cpu_device
65+
.. autofunction:: select_gpu_device
66+
.. autofunction:: select_host_device
67+
.. autofunction:: select_accelerator_device
6768

6869
Queue Management Functions
6970
--------------------------

0 commit comments

Comments
 (0)