Skip to content

Commit

Permalink
Update atomics documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ZzEeKkAa authored and diptorupd committed Aug 2, 2023
1 parent 10baaa0 commit 167def8
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 38 deletions.
4 changes: 1 addition & 3 deletions docs/backups/user_guides/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ Numba-dpex depends on following components:
* dpnp 0.10.1 (`Intel Python DPNP`_)
* `dpcpp-llvm-spirv`_ (SPIRV generation from LLVM IR)
* `llvmdev`_ (LLVM IR generation)
* `spirv-tools`_
* `packaging`_
* `scipy`_ (for testing)
* `pytest`_ (for testing)
Expand Down Expand Up @@ -59,7 +58,7 @@ installed in conda environment:
.. code-block:: bash
export ONEAPI_ROOT=/opt/intel/oneapi
conda create -n numba-dpex-env -c ${ONEAPI_ROOT}/conda_channel python=3.7 dpctl dpnp numba spirv-tools dpcpp-llvm-spirv llvmdev pytest
conda create -n numba-dpex-env -c ${ONEAPI_ROOT}/conda_channel python=3.7 dpctl dpnp numba dpcpp-llvm-spirv llvmdev pytest
conda activate numba-dpex-env
Activate DPC++ compiler:
Expand Down Expand Up @@ -150,7 +149,6 @@ Refer to :ref:`Docker <docker>` section for more options.
.. _`Intel Python dpnp`: https://github.com/IntelPython/dpnp
.. _`dpcpp-llvm-spirv`: https://github.com/IntelPython/dpcpp-llvm-spirv
.. _`llvmdev`: https://anaconda.org/intel/llvmdev
.. _`spirv-tools`: https://anaconda.org/intel/spirv-tools
.. _`packaging`: https://packaging.pypa.io/
.. _`scipy`: https://anaconda.org/intel/scipy
.. _`pytest`: https://docs.pytest.org
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,21 +21,6 @@ Example usage of atomic operations
The ``numba_dpex.atomic.add`` function is analogous to The
``numba.cuda.atomic.add`` provided by the ``numba.cuda`` backend.

Generating Native FP Atomics
----------------------------
Numba-dpex supports generating native floating-point atomics.
This feature is experimental. Users will need to provide
the following environment variables to activate it.

NUMBA_DPEX_ACTIVATE_ATOMICS_FP_NATIVE=1

Example command:

.. code-block:: bash
NUMBA_DPEX_ACTIVATE_ATOMICS_FP_NATIVE=1 \
python program.py
Full examples
-------------

Expand Down
6 changes: 3 additions & 3 deletions docs/source/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ to get the latest production releases.
.. code-block:: bash
conda create -n numba-dpex-env \
numba-dpex dpnp dpctl dpcpp-llvm-spirv spirv-tools \
numba-dpex dpnp dpctl dpcpp-llvm-spirv \
-c intel -c conda-forge
To try out the bleeding edge, the latest packages built from tip of the main
Expand All @@ -28,7 +28,7 @@ source trunk can be installed from the ``dppy/label/dev`` conda channel.
.. code-block:: bash
conda create -n numba-dpex-env \
numba-dpex dpnp dpctl dpcpp-llvm-spirv spirv-tools \
numba-dpex dpnp dpctl dpcpp-llvm-spirv \
-c dppy/label/dev -c intel -c conda-forge
Expand Down Expand Up @@ -70,7 +70,7 @@ first step.
# Create a conda environment that hass needed dependencies installed
conda create -n numba-dpex-env \
dpctl dpnp numba spirv-tools dpcpp-llvm-spirv llvmdev pytest \
dpctl dpnp numba dpcpp-llvm-spirv llvmdev pytest \
-c intel -c conda-forge
# Activate the environment
conda activate numba-dpex-env
Expand Down
17 changes: 0 additions & 17 deletions docs/source/user_guide/kernel_programming/atomic-operations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,23 +21,6 @@ Example usage of atomic operations
The ``numba_dpex.atomic.add`` function is analogous to The
``numba.cuda.atomic.add`` provided by the ``numba.cuda`` backend.

Generating Native FP Atomics
----------------------------
Numba-dpex supports generating native floating-point atomics.
This feature is experimental. Users will need to provide
the following environment variables to activate it.

NUMBA_DPEX_ACTIVATE_ATOMICS_FP_NATIVE=1
NUMBA_DPEX_LLVM_SPIRV_ROOT=/path/to/dpcpp/provided/llvm_spirv

Example command:

.. code-block:: bash
NUMBA_DPEX_ACTIVATE_ATOMICS_FP_NATIVE=1 \
NUMBA_DPEX_LLVM_SPIRV_ROOT=/path/to/dpcpp/provided/llvm_spirv \
python program.py
Full examples
-------------

Expand Down

0 comments on commit 167def8

Please sign in to comment.