Skip to content

Update dpctl module doc string. #395

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.

Sign up for GitHub

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 1 commit into from
Apr 18, 2021
Merged

Update dpctl module doc string. #395

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 4 additions & 12 deletions dpctl/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,10 @@
"""
**Data Parallel Control (dpctl)**

Dpctl provides a lightweight Python wrapper over a subset of
DPC++/SYCL's API. The goal of dpctl is not (yet) to provide a
abstraction for every SYCL function. Dpctl is intended to provide
a common runtime to manage specific SYCL resources, such as devices
and USM memory, for SYCL-based Python packages and extension modules.

The main features presently provided by dpctl are:

* A SYCL queue manager exposed directly inside the top-level `dpctl`
module.
* Python wrapper classes for the main SYCL runtime classes mentioned in
Section 4.6 of SYCL provisional 2020 spec (https://bit.ly/3asQx07).
Dpctl's Python API implements Python wrappers for a subset of DPC++/SYCL's
API. The Python API exposes wrappers for the SYCL runtime classes (expect
`device_selector`) described in Section 4.6 of the SYCL 2020 spec (https://www.khronos.org/registry/SYCL/specs/sycl-2020/html/sycl-2020.html#_sycl_runtime_classes).
Apart from the main SYCL runtime classes, dpctl includes a `memory` sub-module that exposes the SYCL USM allocators and deallocators.
"""
__author__ = "Intel Corp."

Expand Down