Skip to content

Update README.md #663

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Nov 9, 2021
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 17 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,23 @@ About dpctl

<img align="left" src="https://spec.oneapi.io/oneapi-logo-white-scaled.jpg" alt="oneAPI logo" />

`dpctl` (data parallel control) is a lightweight [Python package](https://intelpython.github.io/dpctl) exposing a
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)
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
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).
`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.

`dpctl` features classes representing [SYCL unified shared memory](https://www.khronos.org/registry/SYCL/specs/sycl-2020/html/sycl-2020.html#sec:usm)
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.

`dpctl` assists authors of Python native extensions written in C,
Cython, or pybind11 to use its `dpctl.SyclQueue` object to indicate the offload
target as well as objects in `dpctl.memory` and `dpctl.tensor` submodules to
represent USM allocations that are accessible from within data-parallel code executed
on the target queue.

`dpctl.tensor` submodule provides an array container representing an array in a
strided layout on top of a USM allocation. The submodule provides an array-API
conforming oneAPI DPC++ powered library to manipulate the array container.
Data Parallel Control `dpctl` is the Python library that controls multiple devices of a platform, features classes for
unified shared memory (USM) management, and implements tensor array API on top of it. It is a foundational part of
a larger family of libraries and tools for Data Parallel Python (DPPY) aimed to program XPUs the same way as CPUs.

The library is available via [conda](https://anaconda.org/intel/dpctl) and [pip](https://pypi.org/project/dpctl/).
It also comes with [Intel(R) Distribution for Python*](https://software.intel.com/content/www/us/en/develop/tools/oneapi/components/distribution-for-python.html)

The `dpctl` library is built upon [SYCL standard](https://www.khronos.org/sycl/) and implements a subset of [runtime
classes specifications](https://www.khronos.org/registry/SYCL/specs/sycl-2020/html/sycl-2020.html#_sycl_runtime_classes),
which allow users to query SYCL platforms, discover and represent SYCL devices, and construct SYCL queues for execution
of data-parallel code.

The library also assists authors of Python native extensions written in C, Cython, or pybind11 to access objects
representing devices, queues, memory, and tensor array APIs.

Please refer to [Getting Started and API Reference documentation](https://intelpython.github.io/dpctl) for more
information.

Requirements
============
Expand Down