index.rst

.. currentmodule:: dpctl

:py:mod:`dpctl`

.. py:module:: dpctl

Submodules

:py:mod:`dpctl.memory`	Unified Shared Memory operations
:py:mod:`dpctl.compiler`	Support for working with SYCL kernels
:py:mod:`dpctl.program`	(deprecated, use :py:mod:`dpctl.compiler`)
:py:mod:`dpctl.utils`	A collection of utility functions

Classes

.. autosummary::
    :toctree: generated
    :nosignatures:
    :template: autosummary/cython_class.rst

    SyclDevice
    SyclContext
    SyclQueue
    SyclEvent
    SyclPlatform
    SyclTimer

Device selection

.. autosummary::
    :toctree: generated
    :nosignatures:

    select_default_device
    select_cpu_device
    select_gpu_device
    select_accelerator_device
    select_device_with_aspects

Platform discovery

.. autosummary::
    :toctree: generated
    :nosignatures:

    get_devices
    lsplatform
    get_num_devices
    has_gpu_devices
    has_cpu_devices
    has_accelerator_devices
    get_composite_devices

Enums

:py:class:`dpctl.device_type`	An :class:`enum.Enum` of supported SYCL device types.
:py:class:`dpctl.backend_type`	An :class:`enum.Enum` of supported SYCL backends.
:py:class:`dpctl.event_status_type`	An :class:`enum.Enum` of SYCL event states.
:py:class:`dpctl.global_mem_cache_type`	An :class:`enum.Enum` of global memory cache types for a device.

Exceptions

.. autosummary::
    :toctree: generated
    :nosignatures:

    SyclDeviceCreationError
    SyclContextCreationError
    SyclQueueCreationError
    SyclSubDeviceCreationError

Utilities

.. autosummary::
    :toctree: generated

    get_include

.. toctree::
    :hidden:

    filter_selector_string