Skip to content

Commit 36c8f71

Browse files
Merge pull request #936 from IntelPython/docs-review-edits
Edits to documentation per review feedback
2 parents fcca59e + a604592 commit 36c8f71

File tree

4 files changed

+20
-18
lines changed

4 files changed

+20
-18
lines changed

docs/docfiles/intro.rst

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,21 @@ Welcome to the Data-parallel Control (dpctl) Documentation!
33

44
The data-parallel control (dpctl) library provides C and Python bindings for
55
:sycl_spec_2020:`SYCL 2020 <>`. The SYCL 2020 features supported by dpctl are
6-
limited to those included by Intel(R) DPCPP compiler and specifically cover the
6+
limited to those included by Intel(R) DPC++ compiler and specifically cover the
77
SYCL runtime classes described in :sycl_runtime_classes:`Section 4.6 <>`
88
of the SYCL 2020 specification.
99

1010
Apart from the bindings for these runtime
1111
classes, dpctl includes bindings for SYCL USM memory allocators and
1212
deallocators. Dpctl Python API provides classes that implement
1313
`Python buffer protocol <https://docs.python.org/3/c-api/buffer.html>`_
14-
using SYCL USM memory. It makes it possible to create Python objects that are
15-
backed by SYCL USM memory.
1614

17-
Dpctl also supports the DPCPP :oneapi_filter_selection:`oneapi::filter_selector <>` extension and has
18-
experimental support for SYCL's ``kernel`` and ``program`` classes.
15+
Dpctl also supports the DPC++ :oneapi_filter_selection:`ext::oneapi::filter_selector <>` extension and has
16+
experimental support for SYCL's interoperability ``kernel`` and
17+
``kernel_bundle<bundle_state::executable>`` classes.
18+
19+
Dpctl includes a reference implementation for :array_api:`array API specification <>` using
20+
DPC++ and USM memory allocation in the :class:`dpctl.tensor` sub-module.
21+
The :class:`dpctl.tensor` sub-module provides an N-dimensional array Python object
22+
:class:`dpctl.tensor.usm_ndarray` and a growing implementation of :array_api:`array API specification <>`
23+
compliant operations on instances of the array class.

docs/docfiles/urls.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,6 @@
1414
"sycl_platform": "https://sycl.readthedocs.io/en/latest/iface/platform.html",
1515
"sycl_queue": "https://sycl.readthedocs.io/en/latest/iface/queue.html",
1616
"sycl_runtime_classes": "https://www.khronos.org/registry/SYCL/specs/sycl-2020/html/sycl-2020.html#_sycl_runtime_classes",
17-
"sycl_spec_2020": "https://www.khronos.org/registry/SYCL/specs/sycl-2020/html/sycl-2020.html"
17+
"sycl_spec_2020": "https://www.khronos.org/registry/SYCL/specs/sycl-2020/html/sycl-2020.html",
18+
"array_api": "https://data-apis.org/array-api/latest/"
1819
}

docs/docfiles/user_guides/QuickStart.rst

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,9 @@ On Windows OS
3838
3939
.. note::
4040

41-
The ``dpctl.lsplatform()`` function is new in dpctl 0.7 and will be
42-
available in oneAPI 2021.3. If you are following the guide on an older
43-
oneAPI installation, use ``dpctl.dump()``. If no GPU platforms are shown,
44-
make sure your system has a supported GPU and the necessary GPU drivers
45-
installed. You can install GPU drivers by following the
46-
`GPU driver installation guide <https://dgpu-docs.intel.com/installation-guides/index.html>`_.
41+
If no GPU platforms are shown, make sure your system has a supported
42+
GPU and the necessary GPU drivers installed.
43+
See `GPU driver installation guide <https://dgpu-docs.intel.com/installation-guides/index.html>`_ to install GPU drivers.
4744

4845
Install the Wheel Package from PyPi
4946
====================================

docs/docfiles/user_guides/manual/dpctl/basic_concepts.rst

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,11 @@ This section introduces the basic concepts for XPU management used by `dpctl`.
4242
tasks are executed in the order in which they were submitted.
4343

4444
* **Event**
45-
Holds information related to computation or data movement operation
46-
scheduled for the execution on a queue. An event can store the execution status or
47-
profiling information of the queue, to which the task is submitted.
48-
Events can be used to specify task
49-
dependencies or to synchronize host and devices.
45+
An event holds information related to computation/data movement operation
46+
scheduled for execution on a queue, such as its execution status as well
47+
as profiling information if the queue the task was submitted to allowed
48+
for collection of such information. Events can be used to specify task
49+
dependencies as well as to synchronize host and devices.
5050

5151
* **USM**
5252
Unified Shared Memory (USM) refers to pointer-based device memory management.
@@ -67,7 +67,6 @@ This section introduces the basic concepts for XPU management used by `dpctl`.
6767
"Shared allocation", "Yes", "Accessible by both the host and device."
6868
"Host allocation", "Yes", "Accessible by both the host and device."
6969

70-
7170
Runtime manages synchronization of the host's and device's view into shared allocations.
7271
The initial placement of the shared allocations is not defined.
7372

0 commit comments

Comments
 (0)