Skip to content

Commit 750eb32

Browse files
chudur-budurDiptorup Deb
authored andcommitted
Move the notes up
1 parent cac382b commit 750eb32

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

docs/source/user_guide/config.rst

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,21 @@
33
Configuration Options for ``numba-dpex``
44
========================================
55

6-
``numba-dpex`` provides a set of environment variables and flags for configuring different aspects of the compilation, debugging and execution of programs. The configuration flags of ``numba-dpex`` are mostly inherited from those of Numba*. They are defined in :file:`numba_dpex/core/config.py` and are listed as follows:
6+
``numba-dpex`` provides a set of environment variables and flags for configuring different aspects of the compilation, debugging and execution of programs. The configuration flags of ``numba-dpex`` are mostly inherited from those of Numba*. They are defined in :file:`numba_dpex/core/config.py`.
7+
8+
.. note::
9+
In order to enable/disable each of the configuration flags, a ``NUMBA_DPEX``
10+
prefix needs to be appended before each variable. For example, in order to
11+
turn ``SAVE_IR_FILES`` flag on, it needs to be passed as ``NUMBA_DPEX_SAVE_IR_FILES=1``
12+
13+
For example:
14+
15+
.. code-block:: bash
16+
17+
user@host:~/NUMBA_DPEX_SAVE_IR_FILES=1 python numba_dpex_program.py
18+
19+
20+
The list of available configuration flags are listed as follows:
721

822
``SAVE_IR_FILES``:
923
A flag to save the Numba* intermediate representation (IR) files generated by the compiler. Set to ``0`` by default.
@@ -37,14 +51,3 @@ Configuration Options for ``numba-dpex``
3751

3852
``STATIC_LOCAL_MEM_PASS``:
3953
A flag to turn on the ``ConstantSizeStaticLocalMemoryPass`` in the kernel pipeline. The pass is turned off by default.
40-
41-
.. note::
42-
In order to enable/disable each of the configuration flags, a ``NUMBA_DPEX``
43-
prefix needs to be appended before each variable. For example, in order to
44-
turn ``SAVE_IR_FILES`` flag on, it needs to be passed as ``NUMBA_DPEX_SAVE_IR_FILES=1``
45-
46-
For example:
47-
48-
.. code-block:: bash
49-
50-
user@host:~/NUMBA_DPEX_SAVE_IR_FILES=1 python numba_dpex_program.py

0 commit comments

Comments
 (0)