Skip to content

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.

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

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

task: add more env var documentation #2137

wants to merge 1 commit into from

Conversation

jharlow-intel
Copy link
Contributor

@jharlow-intel jharlow-intel commented Aug 19, 2025 •
edited
Loading

  • Have you provided a meaningful PR description?
  • Have you added a test, reproducer or referred to an issue with a reproducer?
  • Have you tested your changes locally for CPU and GPU devices?
  • Have you made sure that new changes do not introduce compiler warnings?
  • Have you checked performance impact of proposed changes?
  • Have you added documentation for your changes, if necessary?
  • Have you added your changes to the changelog?
  • If this PR is a work in progress, are you opening the PR as a draft?

This PR adds some needed environment variable documentation to the git pages.

@jharlow-intel jharlow-intel self-assigned this Aug 19, 2025
ndgrigorian
ndgrigorian reviewed Aug 19, 2025
View reviewed changes
ndgrigorian
ndgrigorian reviewed Aug 19, 2025
View reviewed changes
ndgrigorian
ndgrigorian reviewed Aug 19, 2025
View reviewed changes
@github-actions GitHub Actions
Copy link

View rendered docs @ https://intelpython.github.io/dpctl/pulls/2137/index.html

@github-actions GitHub Actions
Copy link

Array API standard conformance tests for dpctl=0.21.0dev0=py310h93fe807_105 ran successfully.
Passed: 1115
Failed: 6
Skipped: 119

@coveralls
Copy link
Collaborator

coveralls commented Aug 19, 2025 •
edited
Loading

Coverage Status

coverage: 85.902%. remained the same
when pulling a25c161 on task/SAT-7838
into a6a0fdd on master.

@jharlow-intel jharlow-intel force-pushed the task/SAT-7838 branch 2 times, most recently from e346c8f to 6ad1f1b Compare August 20, 2025 15:21
@github-actions GitHub Actions
Copy link

Array API standard conformance tests for dpctl=0.21.0dev0=py310h93fe807_105 ran successfully.
Passed: 1115
Failed: 6
Skipped: 119

@github-actions GitHub Actions
Copy link

Array API standard conformance tests for dpctl=0.21.0dev0=py310h93fe807_107 ran successfully.
Passed: 1114
Failed: 7
Skipped: 119

@github-actions GitHub Actions
Copy link

Array API standard conformance tests for dpctl=0.21.0dev0=py310h93fe807_105 ran successfully.
Passed: 1114
Failed: 7
Skipped: 119

1 similar comment
@github-actions GitHub Actions
Copy link

Array API standard conformance tests for dpctl=0.21.0dev0=py310h93fe807_105 ran successfully.
Passed: 1114
Failed: 7
Skipped: 119

@github-actions GitHub Actions
Copy link

Array API standard conformance tests for dpctl=0.21.0dev0=py310h93fe807_105 ran successfully.
Passed: 1114
Failed: 7
Skipped: 119

@github-actions GitHub Actions
Copy link

Array API standard conformance tests for dpctl=0.21.0dev0=py310h93fe807_105 ran successfully.
Passed: 1115
Failed: 6
Skipped: 119

@jharlow-intel
Copy link
Contributor Author

@ndgrigorian ready for another review

@ndgrigorian
Copy link
Collaborator

Noting:
Closes #2037

ndgrigorian
ndgrigorian reviewed Aug 26, 2025
View reviewed changes
docs/doc_sources/user_guides/environment_variables.rst Outdated
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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

may be worth mentioning how it works with FLAT and COMBINED
see: https://www.intel.com/content/www/us/en/developer/articles/technical/flattening-gpu-tile-hierarchy.html

I'm not sure if I've tested combined with affinity mask in retrospect...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I already linked that for the ZE_DEVICE_HIERARCHY docs, and I can't find any mention of how exactly ZE_AFFINITY_MASK interacts with COMBINED.

I will include the blurb about FLAT here as well, but I see nothing for COMBINED documented here: https://oneapi-src.github.io/level-zero-spec/level-zero/latest/core/PROG.html#affinity-mask

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah I'm going to go ahead and test it myself, since it's not documented in the compiler composite device extension either

@github-actions GitHub Actions
Copy link

Array API standard conformance tests for dpctl=0.21.0dev0=py310h93fe807_111 ran successfully.
Passed: 1114
Failed: 7
Skipped: 119

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@antonwolfy antonwolfy Awaiting requested review from antonwolfy antonwolfy is a code owner

@vlad-perevezentsev vlad-perevezentsev Awaiting requested review from vlad-perevezentsev vlad-perevezentsev is a code owner

@vtavana vtavana Awaiting requested review from vtavana vtavana is a code owner

@ndgrigorian ndgrigorian Awaiting requested review from ndgrigorian ndgrigorian is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

@jharlow-intel jharlow-intel

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jharlow-intel @coveralls @ndgrigorian