Skip to content

Commit 6b2dfb3

Browse files
committed
review
1 parent 542d3dd commit 6b2dfb3

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

docs/doc_sources/user_guides/environment_variables.rst

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,30 +51,33 @@ The value of the variable is a bit-mask, with the following supported values:
5151
* - ``-1``
5252
- Enables all levels of tracing
5353

54+
.. _env_var_ze_flat_device_hierarchy:
55+
5456
Variable ``ZE_FLAT_DEVICE_HIERARCHY``
5557
--------------------------
5658
Allows users to define the device hierarchy model exposed by Level Zero driver implementation.
59+
Keep in mind :py:mod:`dpctl.get_composite_devices` will only work while this is set to ``COMBINED``.
5760

5861
.. list-table::
5962
:header-rows: 1
6063

6164
* - Value
6265
- Description
6366
* - ``COMBINED``
64-
- Enables all levels of tracing
67+
- Level Zero devices with multiple tiles will be exposed as a set of root devices, each corresponding to an individual tile. These root devices are component devices, which can be queried for their corresponding composite device, and the composite device can in turn be queried for components. Dedicated composite device APIs will return non-trivial results.
6568
* - ``COMPOSITE``
66-
- Returns all devices that do not have a root-device.
69+
- Level Zero devices with multiple tiles will be exposed as a singular root device, with tiles accessible as sub-devices.
6770
* - ``FLAT``
68-
- Returns all devices without sub-devices in a flat hierarchy. Enabled by default.
71+
- Level Zero devices with multiple tiles will be exposed as a set of root devices, each corresponding to an individual tile. Enabled by default.
6972

70-
Read more `here <https://oneapi-src.github.io/level-zero-spec/level-zero/latest/core/PROG.html#device-hierarchy>` and `here <https://www.intel.com/content/www/us/en/developer/articles/technical/flattening-gpu-tile-hierarchy.html>`.
73+
Read more `about device hierarchy here <https://oneapi-src.github.io/level-zero-spec/level-zero/latest/core/PROG.html#device-hierarchy>`_ and `here <https://www.intel.com/content/www/us/en/developer/articles/technical/flattening-gpu-tile-hierarchy.html>`_.
7174

7275
Variable ``ZE_AFFINITY_MASK``
7376
-------------------------------
7477
Allows users to mask specific devices from being used by SYCL applications.
7578
If we have ZE_FLAT_DEVICE_HIERARCHY set to COMPOSITE, we can have an AFFINITY of “1” for our application to only see device #1 - making system devices 0, and 2+, invisible. Etc.
7679

77-
Read more `here <https://oneapi-src.github.io/level-zero-spec/level-zero/latest/core/PROG.html#affinity-mask>`.
80+
Read more about `affinity masks here <https://oneapi-src.github.io/level-zero-spec/level-zero/latest/core/PROG.html#affinity-mask>`_.
7881

7982
Variable ``ZE_ENABLE_PCI_ID_DEVICE_ORDER``
8083
-------------------------------

0 commit comments

Comments
 (0)