Skip to content

Commit 59a9271

Browse files
author
cuda-python-bot
committed
Deploy doc preview for PR 1793 (3d01d6a)
1 parent f562aca commit 59a9271

214 files changed

Lines changed: 27604 additions & 26218 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/pr-preview/pr-1793/cuda-bindings/latest/_sources/environment_variables.rst.txt

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,14 @@ Runtime Environment Variables
1515
Build-Time Environment Variables
1616
--------------------------------
1717

18-
- ``CUDA_HOME`` or ``CUDA_PATH``: Specifies the location of the CUDA Toolkit.
18+
- ``CUDA_PATH`` or ``CUDA_HOME``: Specifies the location of the CUDA Toolkit. If both are set, ``CUDA_PATH`` takes precedence.
19+
20+
.. note::
21+
The ``CUDA_PATH`` > ``CUDA_HOME`` priority is determined by ``cuda-pathfinder``.
22+
Earlier versions of ``cuda-pathfinder`` (before 1.5.0) used the opposite order
23+
(``CUDA_HOME`` > ``CUDA_PATH``). See the
24+
`cuda-pathfinder 1.5.0 release notes <https://nvidia.github.io/cuda-python/cuda-pathfinder/latest/release/1.5.0-notes.html>`_
25+
for details and migration guidance.
1926

2027
- ``CUDA_PYTHON_PARSER_CACHING`` : bool, toggles the caching of parsed header files during the cuda-bindings build process. If caching is enabled (``CUDA_PYTHON_PARSER_CACHING`` is True), the cache path is set to ./cache_<library_name>, where <library_name> is derived from the cuda toolkit libraries used to build cuda-bindings.
2128

docs/pr-preview/pr-1793/cuda-bindings/latest/_sources/install.rst.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,11 +87,11 @@ Requirements
8787

8888
[^2]: The CUDA Runtime static library (``libcudart_static.a`` on Linux, ``cudart_static.lib`` on Windows) is part of the CUDA Toolkit. If using conda packages, it is contained in the ``cuda-cudart-static`` package.
8989

90-
Source builds require that the provided CUDA headers are of the same major.minor version as the ``cuda.bindings`` you're trying to build. Despite this requirement, note that the minor version compatibility is still maintained. Use the ``CUDA_HOME`` (or ``CUDA_PATH``) environment variable to specify the location of your headers. For example, if your headers are located in ``/usr/local/cuda/include``, then you should set ``CUDA_HOME`` with:
90+
Source builds require that the provided CUDA headers are of the same major.minor version as the ``cuda.bindings`` you're trying to build. Despite this requirement, note that the minor version compatibility is still maintained. Use the ``CUDA_PATH`` (or ``CUDA_HOME``) environment variable to specify the location of your headers. If both are set, ``CUDA_PATH`` takes precedence. For example, if your headers are located in ``/usr/local/cuda/include``, then you should set ``CUDA_PATH`` with:
9191

9292
.. code-block:: console
9393
94-
$ export CUDA_HOME=/usr/local/cuda
94+
$ export CUDA_PATH=/usr/local/cuda
9595
9696
See `Environment Variables <environment_variables.rst>`_ for a description of other build-time environment variables.
9797

docs/pr-preview/pr-1793/cuda-bindings/latest/_sources/module/driver.rst.txt

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. SPDX-FileCopyrightText: Copyright (c) 2021-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
1+
.. SPDX-FileCopyrightText: Copyright (c) 2021-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
22
.. SPDX-License-Identifier: LicenseRef-NVIDIA-SOFTWARE-LICENSE
33
44
------
@@ -480,7 +480,7 @@ Data types used by CUDA driver
480480
.. autoattribute:: cuda.bindings.driver.CUstreamBatchMemOpType.CU_STREAM_MEM_OP_ATOMIC_REDUCTION
481481

482482

483-
Perform a atomic reduction. See :py:obj:`~.CUstreamBatchMemOpParams`::atomicReduction
483+
Perform a atomic reduction. See :py:obj:`~.CUstreamBatchMemOpParams.atomicReduction`
484484

485485

486486
.. autoattribute:: cuda.bindings.driver.CUstreamBatchMemOpType.CU_STREAM_MEM_OP_FLUSH_REMOTE_WRITES
@@ -3555,7 +3555,7 @@ Data types used by CUDA driver
35553555

35563556
Valid for graph nodes, launches. This attribute is graphs-only, and passing it to a launch in a non-capturing stream will result in an error.
35573557

3558-
:py:obj:`~.CUlaunchAttributeValue`::deviceUpdatableKernelNode::deviceUpdatable can only be set to 0 or 1. Setting the field to 1 indicates that the corresponding kernel node should be device-updatable. On success, a handle will be returned via :py:obj:`~.CUlaunchAttributeValue`::deviceUpdatableKernelNode::devNode which can be passed to the various device-side update functions to update the node's kernel parameters from within another kernel. For more information on the types of device updates that can be made, as well as the relevant limitations thereof, see :py:obj:`~.cudaGraphKernelNodeUpdatesApply`.
3558+
:py:obj:`~.CUlaunchAttributeValue.deviceUpdatableKernelNode.deviceUpdatable` can only be set to 0 or 1. Setting the field to 1 indicates that the corresponding kernel node should be device-updatable. On success, a handle will be returned via :py:obj:`~.CUlaunchAttributeValue.deviceUpdatableKernelNode.devNode` which can be passed to the various device-side update functions to update the node's kernel parameters from within another kernel. For more information on the types of device updates that can be made, as well as the relevant limitations thereof, see :py:obj:`~.cudaGraphKernelNodeUpdatesApply`.
35593559

35603560
Nodes which are device-updatable have additional restrictions compared to regular kernel nodes. Firstly, device-updatable nodes cannot be removed from their graph via :py:obj:`~.cuGraphDestroyNode`. Additionally, once opted-in to this functionality, a node cannot opt out, and any attempt to set the deviceUpdatable attribute to 0 will result in an error. Device-updatable kernel nodes also cannot have their attributes copied to/from another kernel node via :py:obj:`~.cuGraphKernelNodeCopyAttributes`. Graphs containing one or more device-updatable nodes also do not allow multiple instantiation, and neither the graph nor its instantiated version can be passed to :py:obj:`~.cuGraphExecUpdate`.
35613561

@@ -3579,7 +3579,7 @@ Data types used by CUDA driver
35793579

35803580
This attribute is a hint only. CUDA makes no functional or performance guarantee. Its applicability can be affected by many different factors, including driver version (i.e. CUDA doesn't guarantee the performance characteristics will be maintained between driver versions or a driver update could alter or regress previously observed perf characteristics.) It also doesn't guarantee a successful result, i.e. applying the attribute may not improve the performance of either the targeted kernel or the encapsulating application.
35813581

3582-
Valid values for :py:obj:`~.CUlaunchAttributeValue`::nvlinkUtilCentricScheduling are 0 (disabled) and 1 (enabled).
3582+
Valid values for :py:obj:`~.CUlaunchAttributeValue.nvlinkUtilCentricScheduling` are 0 (disabled) and 1 (enabled).
35833583

35843584

35853585
.. autoattribute:: cuda.bindings.driver.CUlaunchAttributeID.CU_LAUNCH_ATTRIBUTE_PORTABLE_CLUSTER_SIZE_MODE
@@ -7752,6 +7752,14 @@ Checkpoint and restore capabilities are currently restricted to Linux.
77527752
.. autofunction:: cuda.bindings.driver.cuCheckpointProcessRestore
77537753
.. autofunction:: cuda.bindings.driver.cuCheckpointProcessUnlock
77547754

7755+
Profiler Control
7756+
----------------
7757+
7758+
This section describes the profiler control functions of the low-level CUDA driver application programming interface.
7759+
7760+
.. autofunction:: cuda.bindings.driver.cuProfilerStart
7761+
.. autofunction:: cuda.bindings.driver.cuProfilerStop
7762+
77557763
EGL Interoperability
77567764
--------------------
77577765

@@ -7798,14 +7806,6 @@ This section describes the OpenGL interoperability functions of the low-level CU
77987806
.. autofunction:: cuda.bindings.driver.cuGraphicsGLRegisterImage
77997807
.. autofunction:: cuda.bindings.driver.cuGLGetDevices
78007808

7801-
Profiler Control
7802-
----------------
7803-
7804-
This section describes the profiler control functions of the low-level CUDA driver application programming interface.
7805-
7806-
.. autofunction:: cuda.bindings.driver.cuProfilerStart
7807-
.. autofunction:: cuda.bindings.driver.cuProfilerStop
7808-
78097809
VDPAU Interoperability
78107810
----------------------
78117811

docs/pr-preview/pr-1793/cuda-bindings/latest/_sources/module/nvrtc.rst.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. SPDX-FileCopyrightText: Copyright (c) 2021-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
1+
.. SPDX-FileCopyrightText: Copyright (c) 2021-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
22
.. SPDX-License-Identifier: LicenseRef-NVIDIA-SOFTWARE-LICENSE
33
44
-----
@@ -654,7 +654,7 @@ Programmer assertion that all kernel pointer parameters are restrict pointers.
654654

655655
- ``--device-as-default-execution-space``\ (``-default-device``\ )
656656

657-
Treat entities with no execution space annotation as ``device``\ entities.
657+
Treat entities with no execution space annotation as ``__device__``\ entities.
658658

659659

660660

@@ -664,7 +664,7 @@ Treat entities with no execution space annotation as ``device``\ entities.
664664

665665
- ``--device-int128``\ (``-device-int128``\ )
666666

667-
Allow the ``__int128``\ type in device code. Also causes the macro ``CUDACC_RTC_INT128``\ to be defined.
667+
Allow the ``__int128``\ type in device code. Also causes the macro ``__CUDACC_RTC_INT128__``\ to be defined.
668668

669669

670670

0 commit comments

Comments
 (0)