Skip to content

Update dpctl_pyapi.rst #661

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 9, 2021
Merged

Update dpctl_pyapi.rst #661

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 17 additions & 16 deletions docs/docfiles/dpctl_pyapi.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,25 +14,26 @@ Sub-modules
:mod:`dpctl.memory`
USM allocators and deallocators and classes that implement Python's
`buffer protocol`_.
:mod:`dpctl.tensor`
Implementation of different types of tensor classes that use USM memory.
:mod:`dpctl.program`
Experimental wrappers for SYCL 1.2 ``program`` and ``kernel`` classes.
Experimental wrappers for SYCL 1.2 `Program`<https://sycl.readthedocs.io/en/latest/iface/program.html>
and `Kernel`<https://sycl.readthedocs.io/en/latest/iface/kernel.html> classes.
The module is going to be refactored in the future to support SYCL
2020's ``kernel_bundle`` feature and the wrapper for the ``program``
2020's ``sycl::kernel_bundle`` feature and the wrapper for the ``sycl::program``
class is going to be removed.
:mod:`dpctl.tensor`
Implementation of different types of tensor classes that use USM memory.

Classes
-------

.. toctree::
:maxdepth: 1

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

Enumerations
------------
Expand All @@ -53,17 +54,17 @@ Exceptions
Device Selection Functions
--------------------------

.. autofunction:: get_devices
.. autofunction:: select_accelerator_device
.. autofunction:: select_cpu_device
.. autofunction:: select_default_device
.. autofunction:: select_gpu_device
.. autofunction:: select_host_device
.. autofunction:: get_num_devices
.. autofunction:: get_devices
.. autofunction:: has_host_device
.. autofunction:: has_cpu_devices
.. autofunction:: has_gpu_devices
.. autofunction:: has_accelerator_devices
.. autofunction:: has_host_device
.. autofunction:: select_default_device
.. autofunction:: select_cpu_device
.. autofunction:: select_gpu_device
.. autofunction:: select_host_device
.. autofunction:: select_accelerator_device

Queue Management Functions
--------------------------
Expand Down