Constants

The following constants are defined in dpctl:

dpctl.device_type = <enum 'device_type'>

An enum.Enum of supported SYCL device types.

all

accelerator

automatic

cpu

custom

gpu

Example:

import dpctl

# filter GPU devices amongst available SYCL devices
gpu_devs = [
    d for d in dpctl.get_devices() if (
        d.device_type == dpctl.device_type.gpu
    ) ]

# alternatively, get GPU devices directly
gpu_devs2 = dpctl.get_devices(device_type=dpctl.device_type.gpu)

dpctl.backend_type = <enum 'backend_type'>

An enum.Enum of supported SYCL backends.

all

cuda

hip

level_zero

opencl

Example:

import dpctl

# create a SYCL device with OpenCL backend using filter selector
d = dpctl.SyclDevice("opencl")
d.backend
# Possible output: <backend_type.opencl: 5>

dpctl.event_status_type = <enum 'event_status_type'>

An enum.Enum of SYCL event states.

unknown_status

submitted

running

complete

Example:

import dpctl
ev = dpctl.SyclEvent()
ev.execution_status
# Possible output: <event_status_type.complete: 4>

dpctl.global_mem_cache_type = <enum 'global_mem_cache_type'>

An enum.Enum of global memory cache types for a device.

indeterminate

none

read_only

read_write

Example:

import dpctl
dev = dpctl.SyclDevice()
dev.global_mem_cache_type
# Possible output: <global_mem_cache_type.read_write: 4>

dpctl.local_mem_type = <enum 'local_mem_type'>

An enum.Enum of local memory types for a device.

none

local

global_mem

Example:

import dpctl
dev = dpctl.SyclDevice()
dev.local_mem_type
# Possible output: <local_mem_type.local: 2>

dpctl.partition_property = <enum 'partition_property'>

An enum.Enum of partition property types.

no_partition

partition_equally

partition_by_counts

partition_by_affinity_domain

Example:

import dpctl
dev = dpctl.SyclDevice()
dev.partition_type_property
# Possible output: <partition_property.no_partition: 1>

dpctl.fp_config = <enum 'fp_config'>

An enum.Enum of floating-point capability flags.

denorm

inf_nan

round_to_nearest

round_to_zero

round_to_inf

fma

correctly_rounded_divide_sqrt

soft_float

Example:

import dpctl
dev = dpctl.SyclDevice()
dev.single_fp_config
# Possible output: (
#     <fp_config.denorm: 1>,
#     <fp_config.inf_nan: 2>,
#     ...
# )

dpctl.memory_order = <enum 'memory_order'>

An enum.Enum of memory ordering capabilities.

relaxed

acquire

release

acq_rel

seq_cst

Example:

import dpctl
dev = dpctl.SyclDevice()
dev.atomic_memory_order_capabilities
# Possible output: (
#     <memory_order.relaxed: 1>,
#     <memory_order.acquire: 2>,
#     ...
# )

dpctl.memory_scope = <enum 'memory_scope'>

An enum.Enum of memory scope capabilities.

work_item

sub_group

work_group

device

system

Example:

import dpctl
dev = dpctl.SyclDevice()
dev.atomic_memory_scope_capabilities
# Possible output: (
#     <memory_scope.work_item: 1>,
#     <memory_scope.sub_group: 2>,
#     ...
# )