-
Notifications
You must be signed in to change notification settings - Fork 31
task: add more env var documentation #2137
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
Open
jharlow-intel
wants to merge
1
commit into
master
Choose a base branch
from
task/SAT-7838
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,6 +6,12 @@ Environment variables | |
|
||
Behavior of :py:mod:`dpctl` is affected by :dpcpp_envar:`environment variables <>` that | ||
affect DPC++ compiler runtime. | ||
Other relevant environment variables that may not be documented here can be found in: | ||
|
||
- `Level Zero <https://intel.github.io/llvm/EnvironmentVariables.html>`_ | ||
|
||
- `OneAPI <https://oneapi-src.github.io/level-zero-spec/level-zero/latest/core/PROG.html#environment-variables>`_ | ||
|
||
|
||
Variable ``ONEAPI_DEVICE_SELECTOR`` | ||
----------------------------------- | ||
|
@@ -50,3 +56,59 @@ The value of the variable is a bit-mask, with the following supported values: | |
- Enables tracing of PI calls | ||
* - ``-1`` | ||
- Enables all levels of tracing | ||
|
||
.. _env_var_ze_flat_device_hierarchy: | ||
|
||
Variable ``ZE_FLAT_DEVICE_HIERARCHY`` | ||
-------------------------- | ||
Allows users to define the device hierarchy model exposed by Level Zero driver implementation. | ||
Keep in mind :py:mod:`dpctl.get_composite_devices` will only work while this is set to ``COMBINED``. | ||
|
||
.. list-table:: | ||
:header-rows: 1 | ||
|
||
* - Value | ||
- Description | ||
* - ``COMBINED`` | ||
- 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. | ||
* - ``COMPOSITE`` | ||
- Level Zero devices with multiple tiles will be exposed as a singular root device, with tiles accessible as sub-devices. | ||
* - ``FLAT`` | ||
- Level Zero devices with multiple tiles will be exposed as a set of root devices, each corresponding to an individual tile. Enabled by default. | ||
|
||
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>`_. | ||
|
||
Variable ``ZE_AFFINITY_MASK`` | ||
------------------------------- | ||
Allows users to mask specific devices from being used by SYCL applications. | ||
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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. may be worth mentioning how it works with I'm not sure if I've tested combined with affinity mask in retrospect... |
||
|
||
Read more about `affinity masks here <https://oneapi-src.github.io/level-zero-spec/level-zero/latest/core/PROG.html#affinity-mask>`_. | ||
|
||
Variable ``ZE_ENABLE_PCI_ID_DEVICE_ORDER`` | ||
------------------------------- | ||
Forces driver to report devices from lowest to highest PCI bus ID. | ||
|
||
.. list-table:: | ||
:header-rows: 1 | ||
|
||
* - Value | ||
- Description | ||
* - ``0`` | ||
- Disabled. Default value. | ||
* - ``1`` | ||
- Enabled. | ||
|
||
Variable ``ZE_SHARED_FORCE_DEVICE_ALLOC`` | ||
------------------------------- | ||
Forces all shared allocations into device memory | ||
|
||
.. list-table:: | ||
:header-rows: 1 | ||
|
||
* - Value | ||
- Description | ||
* - ``0`` | ||
- Disabled. Default value. | ||
* - ``1`` | ||
- Enabled. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.