Skip to content

Commit

Permalink
Document NVTX ranges in CUB device algorithms
Browse files Browse the repository at this point in the history
  • Loading branch information
bernhardmgruber committed Apr 25, 2024
1 parent 9ac7578 commit fdac322
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions cub/docs/developer_overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -744,3 +744,16 @@ contains hidden visibility attribute.

To satisfy (3), CUB symbols are placed inside an inline namespace containing the set of
GPU architectures for which the TU is being compiled.


NVTX
************************************

The `NVIDIA Tools Extension SDK (NVTX) <https://nvidia.github.io/NVTX/>`_ is a cross-platform API
for annotating source code to provide contextual information to developer tools.
All device-scope algorithms in CUB are annotated with NVTX ranges,
allowing their start and stop to be visualized in profilers
like `NVIDIA Nsight Systems <https://developer.nvidia.com/nsight-systems>`_.
Only the public APIs available in the ``<cub/device/device_xxx.cuh>`` headers are annotated,
excluding direct calls to the dispatch layer.
NVTX annotations can be disabled by defining ``NVTX_DISABLE`` during compilation.

0 comments on commit fdac322

Please sign in to comment.