Skip to content

Commit f455c4f

Browse files
oleksandr-pavlykDiptorup Deb
andauthored
Improved verbiage in "What?" section (#615)
* Improved verbiage in "What?" section * Added a sentence about dpctl.tensor * added link to specs of runtime classes * use style in img tag Co-authored-by: Diptorup Deb <[email protected]>
1 parent cb02b0d commit f455c4f

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

README.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,29 @@
22
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
33
[![Coverage Status](https://coveralls.io/repos/github/IntelPython/dpctl/badge.svg?branch=master)](https://coveralls.io/github/IntelPython/dpctl?branch=master)
44

5-
What?
6-
====
5+
About dpctl
6+
===========
7+
78
<img align="left" src="https://spec.oneapi.io/oneapi-logo-white-scaled.jpg" alt="oneAPI logo" />
89

9-
A lightweight Python package exposing a subset of SYCL functionalities, part of Intel(R) [oneAPI](https://oneapi.io) [Base ToolKit](https://software.intel.com/content/www/us/en/develop/tools/oneapi/base-toolkit.html).
10+
`dpctl` (data parallel control) is a lightweight [Python package](https://intelpython.github.io/dpctl) exposing a
11+
subset of the Intel(R) oneAPI DPC++ [runtime classes](https://www.khronos.org/registry/SYCL/specs/sycl-2020/html/sycl-2020.html#_sycl_runtime_classes)
12+
that is distributed as part of [Intel(R) Distribution for Python*](https://software.intel.com/content/www/us/en/develop/tools/oneapi/components/distribution-for-python.html) and
13+
is included in Intel(R) [oneAPI](https://oneapi.io) [Base ToolKit](https://software.intel.com/content/www/us/en/develop/tools/oneapi/base-toolkit.html).
14+
`dpctl` lets Python users query SYCL platforms, discover and represent SYCL devices, and construct SYCL queues to control data-parallel code execution on [Intel(R) XPUs](https://www.intel.com/content/www/us/en/newsroom/news/xpu-vision-oneapi-server-gpu.html) from Python.
15+
16+
`dpctl` features classes representing [SYCL unified shared memory](https://www.khronos.org/registry/SYCL/specs/sycl-2020/html/sycl-2020.html#sec:usm)
17+
allocations as well as higher-level objects such as [`dpctl.tensor.usm_ndarray`](https://intelpython.github.io/dpctl/latest/docfiles/dpctl.tensor_api.html#module-dpctl.tensor) on top of USM allocations.
18+
19+
`dpctl` assists authors of Python native extensions written in C,
20+
Cython, or pybind11 to use its `dpctl.SyclQueue` object to indicate the offload
21+
target as well as objects in `dpctl.memory` and `dpctl.tensor` submodules to
22+
represent USM allocations that are accessible from within data-parallel code executed
23+
on the target queue.
1024

11-
`dpctl` [provides](https://intelpython.github.io/dpctl) for discovery and selection of SYCL devices, construction of SYCL queues, as well as working with USM allocations.
12-
<br /><br />
25+
`dpctl.tensor` submodule provides an array container representing an array in a
26+
strided layout on top of a USM allocation. The submodule provides an array-API
27+
conforming oneAPI DPC++ powered library to manipulate the array container.
1328

1429
Requirements
1530
============

0 commit comments

Comments
 (0)