dpctl 0.20.2

A lightweight Python wrapper for a subset of SYCL.

Data Parallel Control

Data Parallel Control or dpctl is a Python library that allows users to control the execution placement of a compute kernel on an XPU.

The compute kernel can be a code:

• written by the user, e.g., using numba-dpex
• that is part of a library, such as oneMKL

The dpctl library is built upon the SYCL standard. It implements Python bindings for a subset of the standard runtime classes that allow users to:

• query platforms
• discover and represent devices and sub-devices
• construct contexts and queues

dpctl features classes for SYCL Unified Shared Memory (USM) management and implements a tensor library conforming to Python Array API standard.

The library helps authors of Python native extensions written in C, Cython, or pybind11 to access dpctl objects representing SYCL devices, queues, memory, and tensors.

Dpctl is the core part of a larger family of data-parallel Python libraries and tools to program on XPUs.

Installing

You can install the library using conda (from Intel's channel - see instructions below) or pip package managers. It is also available in the Intel(R) Distribution for Python (IDP).

Intel(R) oneAPI

You can find the most recent release of dpctl every quarter as part of the Intel(R) oneAPI releases.

To get the library from the latest oneAPI release, follow the instructions from Intel(R) oneAPI installation guide.

NOTE: You need to install the Intel(R) oneAPI AI Analytics Tookit to get IDP and dpctl.

Conda

To install dpctl from the Intel(R) conda channel, use the following command:

conda install dpctl -c https://software.repos.intel.com/python/conda/ -c conda-forge --override-channels

Pip

The dpctl can be installed using pip obtaining wheel packages either from PyPi or from Intel(R) channel. To install dpctl wheel package from Intel(R) channel, run the following command:

python -m pip install --index-url https://software.repos.intel.com/python/pypi dpctl

Installing the bleeding edge

To try out the latest features, install dpctl from our development channel on Anaconda cloud:

conda install dpctl -c dppy/label/dev -c conda-forge --override-channels

Building

Refer to our Documentation for more information on setting up a development environment and building dpctl from the source.

Examples

Our examples are located in the examples/ folder and are organized in sub-folders. Examples in the Python/ folder demonstrate how to inspect the heterogeneous platform, select a device, create an execution queue, and how to control device memory allocation and execution placement.

Examples in Cython/, C/, and Pybind11 folders demonstrate creation of SYCL-powered native Python extensions. Please refer to each folder's README document for directions on how to build and use each example.

Running Tests

Tests are located in folder dpctl/tests.

To run the tests, use:

pytest --pyargs dpctl

Running full test suite requires working C/C++ compiler and installed Cython package. To run the test suite without these, use:

pytest --pyargs dpctl -k "not test_cython_api and not test_c_headers"