You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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>
Copy file name to clipboardExpand all lines: docs/docfiles/dpctl_pyapi.rst
+17-16Lines changed: 17 additions & 16 deletions
Original file line number
Diff line number
Diff line change
@@ -14,25 +14,26 @@ Sub-modules
14
14
:mod:`dpctl.memory`
15
15
USM allocators and deallocators and classes that implement Python's
16
16
`buffer protocol`_.
17
+
:mod:`dpctl.tensor`
18
+
Implementation of different types of tensor classes that use USM memory.
17
19
: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.
19
22
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``
21
24
class is going to be removed.
22
-
:mod:`dpctl.tensor`
23
-
Implementation of different types of tensor classes that use USM memory.
24
25
25
26
Classes
26
27
-------
27
28
28
29
.. toctree::
29
30
:maxdepth:1
30
31
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>
0 commit comments