Skip to content

Commit c331518

Browse files
Edits to documentation per review feedback
Made intended use of event to ensure completion of submitted operation from host side of the application explicit. Removed note that lsplatform is new in dpctl 0.7 Update docs/docfiles/user_guides/QuickStart.rst Streamlined notice about GPU drivers per PR review feedback. Co-authored-by: Alexandra <[email protected]>
1 parent 9e934b2 commit c331518

File tree

2 files changed

+13
-11
lines changed

2 files changed

+13
-11
lines changed

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: 10 additions & 5 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,6 +67,11 @@ 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+
Depending on the capability of the device, USM allocations can be a "device"
71+
allocation, a "shared" allocation, or a "host" allocation. A "device"
72+
allocation is not accessible from host, while "shared" or "host" allocations
73+
are. "Host" allocation refers to an allocation in host memory that is
74+
accessible from a device.
7075

7176
Runtime manages synchronization of the host's and device's view into shared allocations.
7277
The initial placement of the shared allocations is not defined.

0 commit comments

Comments
 (0)