From 0dc8750ee038c1976f6123f5dfab9d9f9a98722d Mon Sep 17 00:00:00 2001 From: Anton Volkov Date: Wed, 8 Jul 2026 19:19:20 +0200 Subject: [PATCH 1/6] Updated utils documentation to remove obsolete functions and to document SequentialOrderManager --- docs/doc_sources/api_reference/dpctl/utils.rst | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/doc_sources/api_reference/dpctl/utils.rst b/docs/doc_sources/api_reference/dpctl/utils.rst index b9fdad5051..551a34fa88 100644 --- a/docs/doc_sources/api_reference/dpctl/utils.rst +++ b/docs/doc_sources/api_reference/dpctl/utils.rst @@ -7,14 +7,15 @@ .. currentmodule:: dpctl.utils -.. autofunction:: get_execution_queue - -.. autofunction:: get_coerced_usm_type - -.. autofunction:: validate_usm_type - .. autofunction:: onetrace_enabled .. autofunction:: intel_device_info -.. autoexception:: ExecutionPlacementError +.. data:: SequentialOrderManager + + Thread-local instance of + :class:`~dpctl.utils._order_manager.SyclQueueToOrderManagerMap` used to + ensure sequential ordering of tasks offloaded to a :class:`dpctl.SyclQueue`. + +.. autoclass:: dpctl.utils._order_manager.SyclQueueToOrderManagerMap + :members: From 24d77d782d89699563803ec90b55d2899c462dfa Mon Sep 17 00:00:00 2001 From: Anton Volkov Date: Wed, 8 Jul 2026 19:34:51 +0200 Subject: [PATCH 2/6] Drop documentation for SyclQueueToOrderManagerMap, since it's a private class --- docs/doc_sources/api_reference/dpctl/utils.rst | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/docs/doc_sources/api_reference/dpctl/utils.rst b/docs/doc_sources/api_reference/dpctl/utils.rst index 551a34fa88..093f298ff6 100644 --- a/docs/doc_sources/api_reference/dpctl/utils.rst +++ b/docs/doc_sources/api_reference/dpctl/utils.rst @@ -13,9 +13,5 @@ .. data:: SequentialOrderManager - Thread-local instance of - :class:`~dpctl.utils._order_manager.SyclQueueToOrderManagerMap` used to - ensure sequential ordering of tasks offloaded to a :class:`dpctl.SyclQueue`. - -.. autoclass:: dpctl.utils._order_manager.SyclQueueToOrderManagerMap - :members: + Thread-local object mapping each :class:`dpctl.SyclQueue` to an order + manager, used to ensure sequential ordering of offloaded tasks. From 58ac0215dc3f2d5e42089e2c6b2c68b8ccba0e2b Mon Sep 17 00:00:00 2001 From: Anton Volkov Date: Wed, 8 Jul 2026 19:37:43 +0200 Subject: [PATCH 3/6] Add missing but required blunk lines after `code-block::` bash directives --- docs/doc_sources/beginners_guides/installation.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/doc_sources/beginners_guides/installation.rst b/docs/doc_sources/beginners_guides/installation.rst index c3d41bf658..edfa1b4dae 100644 --- a/docs/doc_sources/beginners_guides/installation.rst +++ b/docs/doc_sources/beginners_guides/installation.rst @@ -217,6 +217,7 @@ one architecture can be specified at a time. To determine the architecture code (````) for your AMD GPU, run: .. code-block:: bash + rocminfo | grep 'Name: *gfx.*' This will print names like ``gfx90a``, ``gfx1030``, etc. @@ -225,6 +226,7 @@ You can then use one of them as the argument to ``--target-hip``. For example: .. code-block:: bash + python scripts/build_locally.py --verbose --target-hip=gfx1030 Alternatively, you can use the ``DPCTL_TARGET_HIP`` CMake option: From 5a478c7c3523bb74fbf67be8a689b2c8546dd263 Mon Sep 17 00:00:00 2001 From: Anton Volkov Date: Wed, 8 Jul 2026 19:43:46 +0200 Subject: [PATCH 4/6] Match each underline to its title's source-line length --- docs/doc_sources/api_reference/dpctl_capi.rst | 2 +- docs/doc_sources/user_guides/environment_variables.rst | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/doc_sources/api_reference/dpctl_capi.rst b/docs/doc_sources/api_reference/dpctl_capi.rst index ce4b435aa6..db1e8257f2 100644 --- a/docs/doc_sources/api_reference/dpctl_capi.rst +++ b/docs/doc_sources/api_reference/dpctl_capi.rst @@ -177,7 +177,7 @@ API for :c:struct:`PySyclKernelObject` API for :c:struct:`PySyclKernelBundleObject` ---------------------------------------- +-------------------------------------------- .. c:function:: DPCTLSyclKernelBundleRef SyclKernelBundle_GetKernelBundleRef(struct PySyclKernelBundleObject *prog) diff --git a/docs/doc_sources/user_guides/environment_variables.rst b/docs/doc_sources/user_guides/environment_variables.rst index db697127bb..c2d4c71bf8 100644 --- a/docs/doc_sources/user_guides/environment_variables.rst +++ b/docs/doc_sources/user_guides/environment_variables.rst @@ -42,7 +42,7 @@ The value of the variable is a bit-mask, with the following supported values: .. _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``. @@ -79,7 +79,7 @@ Therefore, we could use the second tile in each of four dual-tile GPUs with ``ZE Additional examples to illustrate this are in the detailed documentation for ``ZE_AFFINITY_MASK``, read more about it in `Level Zero Specification `_. Variable ``ZE_ENABLE_PCI_ID_DEVICE_ORDER`` -------------------------------- +------------------------------------------ Forces driver to report devices from lowest to highest PCI bus ID. .. list-table:: @@ -93,7 +93,7 @@ Forces driver to report devices from lowest to highest PCI bus ID. - Enabled. Variable ``ZE_SHARED_FORCE_DEVICE_ALLOC`` -------------------------------- +----------------------------------------- Forces all shared allocations into device memory .. list-table:: From e360b1eb23a62afbdf4faeb23b91cb3b2e499b75 Mon Sep 17 00:00:00 2001 From: Anton Volkov Date: Wed, 8 Jul 2026 19:51:55 +0200 Subject: [PATCH 5/6] Use anonymous hyperlink references to get rid of duplication warning --- docs/doc_sources/user_guides/environment_variables.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/doc_sources/user_guides/environment_variables.rst b/docs/doc_sources/user_guides/environment_variables.rst index c2d4c71bf8..77386ac388 100644 --- a/docs/doc_sources/user_guides/environment_variables.rst +++ b/docs/doc_sources/user_guides/environment_variables.rst @@ -58,7 +58,7 @@ Keep in mind :py:mod:`dpctl.get_composite_devices` will only work while this is * - ``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 in `Level Zero Specification `_ and `Intel GPU article `_. +Read more about device hierarchy in `Level Zero Specification `__ and `Intel GPU article `__. Variable ``ZE_AFFINITY_MASK`` ------------------------------- @@ -76,7 +76,7 @@ Therefore, we could use the second tile in each of four dual-tile GPUs with ``ZE | **If the exposed tiles belong to different physical devices:** | - A composite device is available for each physical device, and the tiles are accessible as component devices of their respective composite device. -Additional examples to illustrate this are in the detailed documentation for ``ZE_AFFINITY_MASK``, read more about it in `Level Zero Specification `_. +Additional examples to illustrate this are in the detailed documentation for ``ZE_AFFINITY_MASK``, read more about it in `Level Zero Specification `__. Variable ``ZE_ENABLE_PCI_ID_DEVICE_ORDER`` ------------------------------------------ From 2c68a79eacf830dfd6c898ec31dc70fc6b627123 Mon Sep 17 00:00:00 2001 From: Anton Volkov Date: Wed, 8 Jul 2026 19:57:29 +0200 Subject: [PATCH 6/6] Add `constants.rst` to hidden toctree to resolve `WARNING: document isn't included in any toctree` --- docs/doc_sources/api_reference/dpctl/index.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/doc_sources/api_reference/dpctl/index.rst b/docs/doc_sources/api_reference/dpctl/index.rst index 87fdfb16b2..6af99e288f 100644 --- a/docs/doc_sources/api_reference/dpctl/index.rst +++ b/docs/doc_sources/api_reference/dpctl/index.rst @@ -96,4 +96,5 @@ .. toctree:: :hidden: + constants filter_selector_string