Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Data Parallel Control (dpctl) 0.21.0dev0 documentation
Logo
Data Parallel Control (dpctl) 0.21.0dev0 documentation

Contents:

  • Beginner’s guides
    • Installing dpctl
    • Managing devices
    • Intro to dpctl.tensor
    • History of dpctl name
  • User guides
    • Heterogeneous Systems and Programming Concepts
    • oneAPI programming model
    • DLPack exchange of USM allocated arrays
    • Environment variables
  • API Reference
    • dpctl
      • dpctl.SyclDevice
        • dpctl.SyclDevice.addressof_ref
        • dpctl.SyclDevice.can_access_peer
        • dpctl.SyclDevice.component_devices
        • dpctl.SyclDevice.create_sub_devices
        • dpctl.SyclDevice.disable_peer_access
        • dpctl.SyclDevice.enable_peer_access
        • dpctl.SyclDevice.get_device_id
        • dpctl.SyclDevice.get_filter_string
        • dpctl.SyclDevice.get_unpartitioned_parent_device
        • dpctl.SyclDevice.print_device_info
        • dpctl.SyclDevice.backend
        • dpctl.SyclDevice.composite_device
        • dpctl.SyclDevice.default_selector_score
        • dpctl.SyclDevice.device_type
        • dpctl.SyclDevice.driver_version
        • dpctl.SyclDevice.filter_string
        • dpctl.SyclDevice.global_mem_cache_line_size
        • dpctl.SyclDevice.global_mem_cache_size
        • dpctl.SyclDevice.global_mem_cache_type
        • dpctl.SyclDevice.global_mem_size
        • dpctl.SyclDevice.has_aspect_accelerator
        • dpctl.SyclDevice.has_aspect_atomic64
        • dpctl.SyclDevice.has_aspect_cpu
        • dpctl.SyclDevice.has_aspect_custom
        • dpctl.SyclDevice.has_aspect_emulated
        • dpctl.SyclDevice.has_aspect_fp16
        • dpctl.SyclDevice.has_aspect_fp64
        • dpctl.SyclDevice.has_aspect_gpu
        • dpctl.SyclDevice.has_aspect_host_debuggable
        • dpctl.SyclDevice.has_aspect_image
        • dpctl.SyclDevice.has_aspect_is_component
        • dpctl.SyclDevice.has_aspect_is_composite
        • dpctl.SyclDevice.has_aspect_online_compiler
        • dpctl.SyclDevice.has_aspect_online_linker
        • dpctl.SyclDevice.has_aspect_queue_profiling
        • dpctl.SyclDevice.has_aspect_usm_atomic_host_allocations
        • dpctl.SyclDevice.has_aspect_usm_atomic_shared_allocations
        • dpctl.SyclDevice.has_aspect_usm_device_allocations
        • dpctl.SyclDevice.has_aspect_usm_host_allocations
        • dpctl.SyclDevice.has_aspect_usm_shared_allocations
        • dpctl.SyclDevice.has_aspect_usm_system_allocations
        • dpctl.SyclDevice.image_2d_max_height
        • dpctl.SyclDevice.image_2d_max_width
        • dpctl.SyclDevice.image_3d_max_depth
        • dpctl.SyclDevice.image_3d_max_height
        • dpctl.SyclDevice.image_3d_max_width
        • dpctl.SyclDevice.is_accelerator
        • dpctl.SyclDevice.is_cpu
        • dpctl.SyclDevice.is_gpu
        • dpctl.SyclDevice.local_mem_size
        • dpctl.SyclDevice.max_clock_frequency
        • dpctl.SyclDevice.max_compute_units
        • dpctl.SyclDevice.max_mem_alloc_size
        • dpctl.SyclDevice.max_num_sub_groups
        • dpctl.SyclDevice.max_read_image_args
        • dpctl.SyclDevice.max_work_group_size
        • dpctl.SyclDevice.max_work_item_dims
        • dpctl.SyclDevice.max_work_item_sizes
        • dpctl.SyclDevice.max_work_item_sizes1d
        • dpctl.SyclDevice.max_work_item_sizes2d
        • dpctl.SyclDevice.max_work_item_sizes3d
        • dpctl.SyclDevice.max_write_image_args
        • dpctl.SyclDevice.name
        • dpctl.SyclDevice.native_vector_width_char
        • dpctl.SyclDevice.native_vector_width_double
        • dpctl.SyclDevice.native_vector_width_float
        • dpctl.SyclDevice.native_vector_width_half
        • dpctl.SyclDevice.native_vector_width_int
        • dpctl.SyclDevice.native_vector_width_long
        • dpctl.SyclDevice.native_vector_width_short
        • dpctl.SyclDevice.parent_device
        • dpctl.SyclDevice.partition_max_sub_devices
        • dpctl.SyclDevice.preferred_vector_width_char
        • dpctl.SyclDevice.preferred_vector_width_double
        • dpctl.SyclDevice.preferred_vector_width_float
        • dpctl.SyclDevice.preferred_vector_width_half
        • dpctl.SyclDevice.preferred_vector_width_int
        • dpctl.SyclDevice.preferred_vector_width_long
        • dpctl.SyclDevice.preferred_vector_width_short
        • dpctl.SyclDevice.profiling_timer_resolution
        • dpctl.SyclDevice.sub_group_independent_forward_progress
        • dpctl.SyclDevice.sub_group_sizes
        • dpctl.SyclDevice.sycl_platform
        • dpctl.SyclDevice.vendor
      • dpctl.SyclContext
        • dpctl.SyclContext.addressof_ref
        • dpctl.SyclContext.get_devices
        • dpctl.SyclContext.device_count
      • dpctl.SyclQueue
        • dpctl.SyclQueue.addressof_ref
        • dpctl.SyclQueue.get_sycl_context
        • dpctl.SyclQueue.get_sycl_device
        • dpctl.SyclQueue.mem_advise
        • dpctl.SyclQueue.memcpy
        • dpctl.SyclQueue.memcpy_async
        • dpctl.SyclQueue.prefetch
        • dpctl.SyclQueue.print_device_info
        • dpctl.SyclQueue.submit
        • dpctl.SyclQueue.submit_async
        • dpctl.SyclQueue.submit_barrier
        • dpctl.SyclQueue.wait
        • dpctl.SyclQueue.backend
        • dpctl.SyclQueue.driver_version
        • dpctl.SyclQueue.has_enable_profiling
        • dpctl.SyclQueue.is_in_order
        • dpctl.SyclQueue.name
        • dpctl.SyclQueue.sycl_context
        • dpctl.SyclQueue.sycl_device
      • dpctl.SyclEvent
        • dpctl.SyclEvent.addressof_ref
        • dpctl.SyclEvent.get_wait_list
        • dpctl.SyclEvent.wait
        • dpctl.SyclEvent.wait_for
        • dpctl.SyclEvent.backend
        • dpctl.SyclEvent.execution_status
        • dpctl.SyclEvent.profiling_info_end
        • dpctl.SyclEvent.profiling_info_start
        • dpctl.SyclEvent.profiling_info_submit
      • dpctl.SyclPlatform
        • dpctl.SyclPlatform.get_composite_devices
        • dpctl.SyclPlatform.get_devices
        • dpctl.SyclPlatform.print_platform_info
        • dpctl.SyclPlatform.backend
        • dpctl.SyclPlatform.default_context
        • dpctl.SyclPlatform.name
        • dpctl.SyclPlatform.vendor
        • dpctl.SyclPlatform.version
      • dpctl.SyclTimer
        • dpctl.SyclTimer.__init__
        • dpctl.SyclTimer.dt
      • dpctl.select_default_device
      • dpctl.select_cpu_device
      • dpctl.select_gpu_device
      • dpctl.select_accelerator_device
      • dpctl.select_device_with_aspects
      • dpctl.get_devices
      • dpctl.lsplatform
      • dpctl.get_num_devices
      • dpctl.has_gpu_devices
      • dpctl.has_cpu_devices
      • dpctl.has_accelerator_devices
      • dpctl.get_composite_devices
      • dpctl.SyclDeviceCreationError
      • dpctl.SyclContextCreationError
      • dpctl.SyclQueueCreationError
      • dpctl.SyclSubDeviceCreationError
      • dpctl.get_include
      • Filter Selector String
    • dpctl.memory
      • dpctl.memory.MemoryUSMDevice
        • dpctl.memory.MemoryUSMDevice.copy_from_device
        • dpctl.memory.MemoryUSMDevice.copy_from_host
        • dpctl.memory.MemoryUSMDevice.copy_to_host
        • dpctl.memory.MemoryUSMDevice.get_usm_type
        • dpctl.memory.MemoryUSMDevice.get_usm_type_enum
        • dpctl.memory.MemoryUSMDevice.memset
        • dpctl.memory.MemoryUSMDevice.tobytes
        • dpctl.memory.MemoryUSMDevice.nbytes
        • dpctl.memory.MemoryUSMDevice.reference_obj
        • dpctl.memory.MemoryUSMDevice.size
        • dpctl.memory.MemoryUSMDevice.sycl_context
        • dpctl.memory.MemoryUSMDevice.sycl_device
        • dpctl.memory.MemoryUSMDevice.sycl_queue
        • dpctl.memory.MemoryUSMDevice.__sycl_usm_array_interface__
      • dpctl.memory.MemoryUSMShared
        • dpctl.memory.MemoryUSMShared.copy_from_device
        • dpctl.memory.MemoryUSMShared.copy_from_host
        • dpctl.memory.MemoryUSMShared.copy_to_host
        • dpctl.memory.MemoryUSMShared.get_usm_type
        • dpctl.memory.MemoryUSMShared.get_usm_type_enum
        • dpctl.memory.MemoryUSMShared.memset
        • dpctl.memory.MemoryUSMShared.tobytes
        • dpctl.memory.MemoryUSMShared.nbytes
        • dpctl.memory.MemoryUSMShared.reference_obj
        • dpctl.memory.MemoryUSMShared.size
        • dpctl.memory.MemoryUSMShared.sycl_context
        • dpctl.memory.MemoryUSMShared.sycl_device
        • dpctl.memory.MemoryUSMShared.sycl_queue
        • dpctl.memory.MemoryUSMShared.__sycl_usm_array_interface__
      • dpctl.memory.MemoryUSMHost
        • dpctl.memory.MemoryUSMHost.copy_from_device
        • dpctl.memory.MemoryUSMHost.copy_from_host
        • dpctl.memory.MemoryUSMHost.copy_to_host
        • dpctl.memory.MemoryUSMHost.get_usm_type
        • dpctl.memory.MemoryUSMHost.get_usm_type_enum
        • dpctl.memory.MemoryUSMHost.memset
        • dpctl.memory.MemoryUSMHost.tobytes
        • dpctl.memory.MemoryUSMHost.nbytes
        • dpctl.memory.MemoryUSMHost.reference_obj
        • dpctl.memory.MemoryUSMHost.size
        • dpctl.memory.MemoryUSMHost.sycl_context
        • dpctl.memory.MemoryUSMHost.sycl_device
        • dpctl.memory.MemoryUSMHost.sycl_queue
        • dpctl.memory.MemoryUSMHost.__sycl_usm_array_interface__
      • dpctl.memory.as_usm_memory
      • dpctl.memory.USMAllocationError
      • __sycl_usm_array_interface__ attribute
    • dpctl.program
      • dpctl.program.create_program_from_source
      • dpctl.program.create_program_from_spirv
      • dpctl.program.SyclProgram
      • dpctl.program.SyclKernel
      • dpctl.program.SyclProgramCompilationError
    • dpctl.utils
    • dpctl.tensor
      • Array creation functions
        • dpctl.tensor.arange
        • dpctl.tensor.asarray
        • dpctl.tensor.empty
        • dpctl.tensor.empty_like
        • dpctl.tensor.eye
        • dpctl.tensor.from_dlpack
        • dpctl.tensor.full
        • dpctl.tensor.full_like
        • dpctl.tensor.linspace
        • dpctl.tensor.meshgrid
        • dpctl.tensor.ones
        • dpctl.tensor.ones_like
        • dpctl.tensor.tril
        • dpctl.tensor.triu
        • dpctl.tensor.zeros
        • dpctl.tensor.zeros_like
        • dpctl.tensor.from_numpy
        • dpctl.tensor.copy
      • USM array object
        • dpctl.tensor.usm_ndarray
          • dpctl.tensor.usm_ndarray.to_device
          • dpctl.tensor.usm_ndarray.T
          • dpctl.tensor.usm_ndarray.device
          • dpctl.tensor.usm_ndarray.dtype
          • dpctl.tensor.usm_ndarray.flags
          • dpctl.tensor.usm_ndarray.imag
          • dpctl.tensor.usm_ndarray.itemsize
          • dpctl.tensor.usm_ndarray.mT
          • dpctl.tensor.usm_ndarray.nbytes
          • dpctl.tensor.usm_ndarray.ndim
          • dpctl.tensor.usm_ndarray.real
          • dpctl.tensor.usm_ndarray.shape
          • dpctl.tensor.usm_ndarray.size
          • dpctl.tensor.usm_ndarray.strides
          • dpctl.tensor.usm_ndarray.sycl_context
          • dpctl.tensor.usm_ndarray.sycl_device
          • dpctl.tensor.usm_ndarray.sycl_queue
          • dpctl.tensor.usm_ndarray.usm_data
          • dpctl.tensor.usm_ndarray.usm_type
          • dpctl.tensor.usm_ndarray.__dlpack_device__
          • dpctl.tensor.usm_ndarray.__dlpack__
          • dpctl.tensor.usm_ndarray.__sycl_usm_array_interface__
          • dpctl.tensor.usm_ndarray._pointer
          • dpctl.tensor.usm_ndarray._element_offset
          • dpctl.tensor.usm_ndarray._byte_bounds
        • Flags class
      • Data type functions
        • dpctl.tensor.astype
        • dpctl.tensor.can_cast
        • dpctl.tensor.finfo
        • dpctl.tensor.iinfo
        • dpctl.tensor.isdtype
        • dpctl.tensor.result_type
      • Data types
      • Element-wise functions
        • dpctl.tensor.abs
        • dpctl.tensor.acos
        • dpctl.tensor.acosh
        • dpctl.tensor.add
        • dpctl.tensor.angle
        • dpctl.tensor.asin
        • dpctl.tensor.asinh
        • dpctl.tensor.atan
        • dpctl.tensor.atan2
        • dpctl.tensor.atanh
        • dpctl.tensor.bitwise_and
        • dpctl.tensor.bitwise_left_shift
        • dpctl.tensor.bitwise_invert
        • dpctl.tensor.bitwise_or
        • dpctl.tensor.bitwise_right_shift
        • dpctl.tensor.bitwise_xor
        • dpctl.tensor.cbrt
        • dpctl.tensor.ceil
        • dpctl.tensor.clip
        • dpctl.tensor.conj
        • dpctl.tensor.copysign
        • dpctl.tensor.cos
        • dpctl.tensor.cosh
        • dpctl.tensor.divide
        • dpctl.tensor.equal
        • dpctl.tensor.exp
        • dpctl.tensor.exp2
        • dpctl.tensor.expm1
        • dpctl.tensor.floor
        • dpctl.tensor.floor_divide
        • dpctl.tensor.greater
        • dpctl.tensor.greater_equal
        • dpctl.tensor.hypot
        • dpctl.tensor.imag
        • dpctl.tensor.isfinite
        • dpctl.tensor.isinf
        • dpctl.tensor.isnan
        • dpctl.tensor.less
        • dpctl.tensor.less_equal
        • dpctl.tensor.log
        • dpctl.tensor.log1p
        • dpctl.tensor.log2
        • dpctl.tensor.log10
        • dpctl.tensor.logaddexp
        • dpctl.tensor.logical_and
        • dpctl.tensor.logical_not
        • dpctl.tensor.logical_or
        • dpctl.tensor.logical_xor
        • dpctl.tensor.maximum
        • dpctl.tensor.minimum
        • dpctl.tensor.multiply
        • dpctl.tensor.negative
        • dpctl.tensor.nextafter
        • dpctl.tensor.not_equal
        • dpctl.tensor.positive
        • dpctl.tensor.pow
        • dpctl.tensor.real
        • dpctl.tensor.remainder
        • dpctl.tensor.reciprocal
        • dpctl.tensor.round
        • dpctl.tensor.rsqrt
        • dpctl.tensor.sign
        • dpctl.tensor.signbit
        • dpctl.tensor.sin
        • dpctl.tensor.sinh
        • dpctl.tensor.square
        • dpctl.tensor.sqrt
        • dpctl.tensor.subtract
        • dpctl.tensor.tan
        • dpctl.tensor.tanh
        • dpctl.tensor.trunc
      • Indexing functions
        • dpctl.tensor.extract
        • dpctl.tensor.place
        • dpctl.tensor.put
        • dpctl.tensor.put_along_axis
        • dpctl.tensor.take
        • dpctl.tensor.take_along_axis
      • Inspection API
        • dpctl.tensor.__array_api_version__
        • dpctl.tensor.__array_namespace_info__
        • dpctl.tensor._array_api.Info
          • dpctl.tensor._array_api.Info.capabilities
          • dpctl.tensor._array_api.Info.default_device
          • dpctl.tensor._array_api.Info.default_dtypes
          • dpctl.tensor._array_api.Info.devices
          • dpctl.tensor._array_api.Info.dtypes
      • Linear algebra functions
        • dpctl.tensor.matmul
        • dpctl.tensor.matrix_transpose
        • dpctl.tensor.tensordot
        • dpctl.tensor.vecdot
      • Array manipulation functions
        • dpctl.tensor.broadcast_arrays
        • dpctl.tensor.broadcast_to
        • dpctl.tensor.concat
        • dpctl.tensor.expand_dims
        • dpctl.tensor.flip
        • dpctl.tensor.moveaxis
        • dpctl.tensor.permute_dims
        • dpctl.tensor.repeat
        • dpctl.tensor.reshape
        • dpctl.tensor.roll
        • dpctl.tensor.squeeze
        • dpctl.tensor.stack
        • dpctl.tensor.tile
        • dpctl.tensor.unstack
      • Searching functions
        • dpctl.tensor.argmax
        • dpctl.tensor.argmin
        • dpctl.tensor.count_nonzero
        • dpctl.tensor.nonzero
        • dpctl.tensor.searchsorted
        • dpctl.tensor.where
      • Set Functions
        • dpctl.tensor.isin
        • dpctl.tensor.unique_all
        • dpctl.tensor.unique_counts
        • dpctl.tensor.unique_inverse
        • dpctl.tensor.unique_values
      • Sorting functions
        • dpctl.tensor.argsort
        • dpctl.tensor.sort
        • dpctl.tensor.top_k
      • Statistical Functions
        • dpctl.tensor.max
        • dpctl.tensor.mean
        • dpctl.tensor.min
        • dpctl.tensor.prod
        • dpctl.tensor.std
        • dpctl.tensor.sum
        • dpctl.tensor.var
        • dpctl.tensor.logsumexp
        • dpctl.tensor.reduce_hypot
      • Utility functions
        • dpctl.tensor.all
        • dpctl.tensor.any
        • dpctl.tensor.allclose
        • dpctl.tensor.diff
      • Constants
    • C Library SyclInterface
      • libsyclinterface
        • Device class helper functions
        • Platform class helper functions
        • Todo List
        • Global Namespace
          • namespace dpctl
            • namespace dpctl::syclinterface
              • class dpctl::syclinterface::dpctl_accelerator_selector
              • class dpctl::syclinterface::dpctl_cpu_selector
              • class dpctl::syclinterface::dpctl_default_selector
              • class dpctl::syclinterface::dpctl_device_selector
              • class dpctl::syclinterface::dpctl_filter_selector
              • class dpctl::syclinterface::dpctl_gpu_selector
          • enum DPCTLGlobalMemCacheType
          • enum DPCTLKernelArgType
          • enum DPCTLPartitionAffinityDomainType
          • enum DPCTLPeerAccessType
          • enum DPCTLQueuePropertyType
          • enum DPCTLSyclAspectType
          • enum DPCTLSyclBackendType
          • enum DPCTLSyclDeviceType
          • enum DPCTLSyclEventStatusType
          • enum DPCTLSyclUSMType
          • struct MDLocalAccessorTy
          • struct RawWorkGroupMemoryTy
    • dpctl C API
    • dpctl Cython API
    • pybind11 API
    • CMake support
  • Contributing to dpctl
    • Building from the Source
    • Building the libsyclinterface Library
    • Working with DPCTLSyclInterface library
  • Licenses
Back to top
View this page

User guides¶

  • Concepts relevant to heterogeneous programming.

  • oneAPI execution model in Python

  • Protocol for exchanging USM allocations using DLPack

  • Environment variables affecting dpctl

Next
Heterogeneous Systems and Programming Concepts
Previous
History of dpctl name
Copyright © 2020-2025, Intel Corp.
Made with Sphinx and @pradyunsg's Furo