Skip to content

Commit 6303842

Browse files
author
cuda-python-bot
committed
Deploy release docs:
1 parent d6c11d6 commit 6303842

1,330 files changed

Lines changed: 164290 additions & 4097 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/cuda-bindings/13.2.1/_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/cuda-bindings/13.2.1/_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/cuda-bindings/13.2.1/_sources/module/driver.rst.txt

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,28 @@
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
------
55
driver
66
------
77

8+
Profiler Control
9+
----------------
10+
11+
This section describes the profiler control functions of the low-level CUDA driver application programming interface.
12+
13+
.. autofunction:: cuda.bindings.driver.cuProfilerStart
14+
.. autofunction:: cuda.bindings.driver.cuProfilerStop
15+
16+
VDPAU Interoperability
17+
----------------------
18+
19+
This section describes the VDPAU interoperability functions of the low-level CUDA driver application programming interface.
20+
21+
.. autofunction:: cuda.bindings.driver.cuVDPAUGetDevice
22+
.. autofunction:: cuda.bindings.driver.cuVDPAUCtxCreate
23+
.. autofunction:: cuda.bindings.driver.cuGraphicsVDPAURegisterVideoSurface
24+
.. autofunction:: cuda.bindings.driver.cuGraphicsVDPAURegisterOutputSurface
25+
826
Data types used by CUDA driver
927
------------------------------
1028

@@ -7752,24 +7770,6 @@ Checkpoint and restore capabilities are currently restricted to Linux.
77527770
.. autofunction:: cuda.bindings.driver.cuCheckpointProcessRestore
77537771
.. autofunction:: cuda.bindings.driver.cuCheckpointProcessUnlock
77547772

7755-
EGL Interoperability
7756-
--------------------
7757-
7758-
This section describes the EGL interoperability functions of the low-level CUDA driver application programming interface.
7759-
7760-
.. autofunction:: cuda.bindings.driver.cuGraphicsEGLRegisterImage
7761-
.. autofunction:: cuda.bindings.driver.cuEGLStreamConsumerConnect
7762-
.. autofunction:: cuda.bindings.driver.cuEGLStreamConsumerConnectWithFlags
7763-
.. autofunction:: cuda.bindings.driver.cuEGLStreamConsumerDisconnect
7764-
.. autofunction:: cuda.bindings.driver.cuEGLStreamConsumerAcquireFrame
7765-
.. autofunction:: cuda.bindings.driver.cuEGLStreamConsumerReleaseFrame
7766-
.. autofunction:: cuda.bindings.driver.cuEGLStreamProducerConnect
7767-
.. autofunction:: cuda.bindings.driver.cuEGLStreamProducerDisconnect
7768-
.. autofunction:: cuda.bindings.driver.cuEGLStreamProducerPresentFrame
7769-
.. autofunction:: cuda.bindings.driver.cuEGLStreamProducerReturnFrame
7770-
.. autofunction:: cuda.bindings.driver.cuGraphicsResourceGetMappedEglFrame
7771-
.. autofunction:: cuda.bindings.driver.cuEventCreateFromEGLSync
7772-
77737773
OpenGL Interoperability
77747774
-----------------------
77757775

@@ -7798,20 +7798,20 @@ This section describes the OpenGL interoperability functions of the low-level CU
77987798
.. autofunction:: cuda.bindings.driver.cuGraphicsGLRegisterImage
77997799
.. autofunction:: cuda.bindings.driver.cuGLGetDevices
78007800

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-
7809-
VDPAU Interoperability
7810-
----------------------
7801+
EGL Interoperability
7802+
--------------------
78117803

7812-
This section describes the VDPAU interoperability functions of the low-level CUDA driver application programming interface.
7804+
This section describes the EGL interoperability functions of the low-level CUDA driver application programming interface.
78137805

7814-
.. autofunction:: cuda.bindings.driver.cuVDPAUGetDevice
7815-
.. autofunction:: cuda.bindings.driver.cuVDPAUCtxCreate
7816-
.. autofunction:: cuda.bindings.driver.cuGraphicsVDPAURegisterVideoSurface
7817-
.. autofunction:: cuda.bindings.driver.cuGraphicsVDPAURegisterOutputSurface
7806+
.. autofunction:: cuda.bindings.driver.cuGraphicsEGLRegisterImage
7807+
.. autofunction:: cuda.bindings.driver.cuEGLStreamConsumerConnect
7808+
.. autofunction:: cuda.bindings.driver.cuEGLStreamConsumerConnectWithFlags
7809+
.. autofunction:: cuda.bindings.driver.cuEGLStreamConsumerDisconnect
7810+
.. autofunction:: cuda.bindings.driver.cuEGLStreamConsumerAcquireFrame
7811+
.. autofunction:: cuda.bindings.driver.cuEGLStreamConsumerReleaseFrame
7812+
.. autofunction:: cuda.bindings.driver.cuEGLStreamProducerConnect
7813+
.. autofunction:: cuda.bindings.driver.cuEGLStreamProducerDisconnect
7814+
.. autofunction:: cuda.bindings.driver.cuEGLStreamProducerPresentFrame
7815+
.. autofunction:: cuda.bindings.driver.cuEGLStreamProducerReturnFrame
7816+
.. autofunction:: cuda.bindings.driver.cuGraphicsResourceGetMappedEglFrame
7817+
.. autofunction:: cuda.bindings.driver.cuEventCreateFromEGLSync

docs/cuda-bindings/13.2.1/_sources/module/runtime.rst.txt

Lines changed: 104 additions & 104 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
-------
@@ -172,6 +172,9 @@ This section describes the memory management functions of the CUDA runtime appli
172172

173173
Some functions have overloaded C++ API template versions documented separately in the C++ API Routines module.
174174

175+
.. autofunction:: cuda.bindings.runtime.make_cudaPitchedPtr
176+
.. autofunction:: cuda.bindings.runtime.make_cudaPos
177+
.. autofunction:: cuda.bindings.runtime.make_cudaExtent
175178
.. autofunction:: cuda.bindings.runtime.cudaMallocManaged
176179
.. autofunction:: cuda.bindings.runtime.cudaMalloc
177180
.. autofunction:: cuda.bindings.runtime.cudaMallocHost
@@ -229,9 +232,6 @@ Some functions have overloaded C++ API template versions documented separately i
229232
.. autofunction:: cuda.bindings.runtime.cudaMemAdvise
230233
.. autofunction:: cuda.bindings.runtime.cudaMemRangeGetAttribute
231234
.. autofunction:: cuda.bindings.runtime.cudaMemRangeGetAttributes
232-
.. autofunction:: cuda.bindings.runtime.make_cudaPitchedPtr
233-
.. autofunction:: cuda.bindings.runtime.make_cudaPos
234-
.. autofunction:: cuda.bindings.runtime.make_cudaExtent
235235

236236
Stream Ordered Memory Allocator
237237
-------------------------------
@@ -1110,6 +1110,7 @@ Data types used by CUDA Runtime
11101110

11111111

11121112

1113+
.. autoclass:: cuda.bindings.runtime.cudaTextureDesc
11131114
.. autoclass:: cuda.bindings.runtime.cudaEglPlaneDesc_st
11141115
.. autoclass:: cuda.bindings.runtime.cudaEglFrame_st
11151116
.. autoclass:: cuda.bindings.runtime.cudaChannelFormatDesc
@@ -1177,7 +1178,89 @@ Data types used by CUDA Runtime
11771178
.. autoclass:: cuda.bindings.runtime.cudaLaunchAttributeValue
11781179
.. autoclass:: cuda.bindings.runtime.cudaLaunchAttribute_st
11791180
.. autoclass:: cuda.bindings.runtime.cudaAsyncNotificationInfo
1180-
.. autoclass:: cuda.bindings.runtime.cudaTextureDesc
1181+
.. autoclass:: cuda.bindings.runtime.cudaTextureAddressMode
1182+
1183+
.. autoattribute:: cuda.bindings.runtime.cudaTextureAddressMode.cudaAddressModeWrap
1184+
1185+
1186+
Wrapping address mode
1187+
1188+
1189+
.. autoattribute:: cuda.bindings.runtime.cudaTextureAddressMode.cudaAddressModeClamp
1190+
1191+
1192+
Clamp to edge address mode
1193+
1194+
1195+
.. autoattribute:: cuda.bindings.runtime.cudaTextureAddressMode.cudaAddressModeMirror
1196+
1197+
1198+
Mirror address mode
1199+
1200+
1201+
.. autoattribute:: cuda.bindings.runtime.cudaTextureAddressMode.cudaAddressModeBorder
1202+
1203+
1204+
Border address mode
1205+
1206+
.. autoclass:: cuda.bindings.runtime.cudaTextureFilterMode
1207+
1208+
.. autoattribute:: cuda.bindings.runtime.cudaTextureFilterMode.cudaFilterModePoint
1209+
1210+
1211+
Point filter mode
1212+
1213+
1214+
.. autoattribute:: cuda.bindings.runtime.cudaTextureFilterMode.cudaFilterModeLinear
1215+
1216+
1217+
Linear filter mode
1218+
1219+
.. autoclass:: cuda.bindings.runtime.cudaTextureReadMode
1220+
1221+
.. autoattribute:: cuda.bindings.runtime.cudaTextureReadMode.cudaReadModeElementType
1222+
1223+
1224+
Read texture as specified element type
1225+
1226+
1227+
.. autoattribute:: cuda.bindings.runtime.cudaTextureReadMode.cudaReadModeNormalizedFloat
1228+
1229+
1230+
Read texture as normalized float
1231+
1232+
.. autoclass:: cuda.bindings.runtime.cudaSurfaceBoundaryMode
1233+
1234+
.. autoattribute:: cuda.bindings.runtime.cudaSurfaceBoundaryMode.cudaBoundaryModeZero
1235+
1236+
1237+
Zero boundary mode
1238+
1239+
1240+
.. autoattribute:: cuda.bindings.runtime.cudaSurfaceBoundaryMode.cudaBoundaryModeClamp
1241+
1242+
1243+
Clamp boundary mode
1244+
1245+
1246+
.. autoattribute:: cuda.bindings.runtime.cudaSurfaceBoundaryMode.cudaBoundaryModeTrap
1247+
1248+
1249+
Trap boundary mode
1250+
1251+
.. autoclass:: cuda.bindings.runtime.cudaSurfaceFormatMode
1252+
1253+
.. autoattribute:: cuda.bindings.runtime.cudaSurfaceFormatMode.cudaFormatModeForced
1254+
1255+
1256+
Forced format mode
1257+
1258+
1259+
.. autoattribute:: cuda.bindings.runtime.cudaSurfaceFormatMode.cudaFormatModeAuto
1260+
1261+
1262+
Auto format mode
1263+
11811264
.. autoclass:: cuda.bindings.runtime.cudaEglFrameType
11821265

11831266
.. autoattribute:: cuda.bindings.runtime.cudaEglFrameType.cudaEglFrameTypeArray
@@ -5907,89 +5990,8 @@ Data types used by CUDA Runtime
59075990

59085991
.. autoattribute:: cuda.bindings.runtime.cudaLogLevel.cudaLogLevelWarning
59095992

5910-
.. autoclass:: cuda.bindings.runtime.cudaSurfaceBoundaryMode
5911-
5912-
.. autoattribute:: cuda.bindings.runtime.cudaSurfaceBoundaryMode.cudaBoundaryModeZero
5913-
5914-
5915-
Zero boundary mode
5916-
5917-
5918-
.. autoattribute:: cuda.bindings.runtime.cudaSurfaceBoundaryMode.cudaBoundaryModeClamp
5919-
5920-
5921-
Clamp boundary mode
5922-
5923-
5924-
.. autoattribute:: cuda.bindings.runtime.cudaSurfaceBoundaryMode.cudaBoundaryModeTrap
5925-
5926-
5927-
Trap boundary mode
5928-
5929-
.. autoclass:: cuda.bindings.runtime.cudaSurfaceFormatMode
5930-
5931-
.. autoattribute:: cuda.bindings.runtime.cudaSurfaceFormatMode.cudaFormatModeForced
5932-
5933-
5934-
Forced format mode
5935-
5936-
5937-
.. autoattribute:: cuda.bindings.runtime.cudaSurfaceFormatMode.cudaFormatModeAuto
5938-
5939-
5940-
Auto format mode
5941-
5942-
.. autoclass:: cuda.bindings.runtime.cudaTextureAddressMode
5943-
5944-
.. autoattribute:: cuda.bindings.runtime.cudaTextureAddressMode.cudaAddressModeWrap
5945-
5946-
5947-
Wrapping address mode
5948-
5949-
5950-
.. autoattribute:: cuda.bindings.runtime.cudaTextureAddressMode.cudaAddressModeClamp
5951-
5952-
5953-
Clamp to edge address mode
5954-
5955-
5956-
.. autoattribute:: cuda.bindings.runtime.cudaTextureAddressMode.cudaAddressModeMirror
5957-
5958-
5959-
Mirror address mode
5960-
5961-
5962-
.. autoattribute:: cuda.bindings.runtime.cudaTextureAddressMode.cudaAddressModeBorder
5963-
5964-
5965-
Border address mode
5966-
5967-
.. autoclass:: cuda.bindings.runtime.cudaTextureFilterMode
5968-
5969-
.. autoattribute:: cuda.bindings.runtime.cudaTextureFilterMode.cudaFilterModePoint
5970-
5971-
5972-
Point filter mode
5973-
5974-
5975-
.. autoattribute:: cuda.bindings.runtime.cudaTextureFilterMode.cudaFilterModeLinear
5976-
5977-
5978-
Linear filter mode
5979-
5980-
.. autoclass:: cuda.bindings.runtime.cudaTextureReadMode
5981-
5982-
.. autoattribute:: cuda.bindings.runtime.cudaTextureReadMode.cudaReadModeElementType
5983-
5984-
5985-
Read texture as specified element type
5986-
5987-
5988-
.. autoattribute:: cuda.bindings.runtime.cudaTextureReadMode.cudaReadModeNormalizedFloat
5989-
5990-
5991-
Read texture as normalized float
5992-
5993+
.. autoclass:: cuda.bindings.runtime.cudaTextureObject_t
5994+
.. autoclass:: cuda.bindings.runtime.cudaSurfaceObject_t
59935995
.. autoclass:: cuda.bindings.runtime.cudaEglPlaneDesc
59945996
.. autoclass:: cuda.bindings.runtime.cudaEglFrame
59955997
.. autoclass:: cuda.bindings.runtime.cudaEglStreamConnection
@@ -6033,8 +6035,20 @@ Data types used by CUDA Runtime
60336035
.. autoclass:: cuda.bindings.runtime.cudaAsyncCallback
60346036
.. autoclass:: cuda.bindings.runtime.cudaLogsCallbackHandle
60356037
.. autoclass:: cuda.bindings.runtime.cudaLogIterator
6036-
.. autoclass:: cuda.bindings.runtime.cudaSurfaceObject_t
6037-
.. autoclass:: cuda.bindings.runtime.cudaTextureObject_t
6038+
.. autoattribute:: cuda.bindings.runtime.cudaTextureType1D
6039+
.. autoattribute:: cuda.bindings.runtime.cudaTextureType2D
6040+
.. autoattribute:: cuda.bindings.runtime.cudaTextureType3D
6041+
.. autoattribute:: cuda.bindings.runtime.cudaTextureTypeCubemap
6042+
.. autoattribute:: cuda.bindings.runtime.cudaTextureType1DLayered
6043+
.. autoattribute:: cuda.bindings.runtime.cudaTextureType2DLayered
6044+
.. autoattribute:: cuda.bindings.runtime.cudaTextureTypeCubemapLayered
6045+
.. autoattribute:: cuda.bindings.runtime.cudaSurfaceType1D
6046+
.. autoattribute:: cuda.bindings.runtime.cudaSurfaceType2D
6047+
.. autoattribute:: cuda.bindings.runtime.cudaSurfaceType3D
6048+
.. autoattribute:: cuda.bindings.runtime.cudaSurfaceTypeCubemap
6049+
.. autoattribute:: cuda.bindings.runtime.cudaSurfaceType1DLayered
6050+
.. autoattribute:: cuda.bindings.runtime.cudaSurfaceType2DLayered
6051+
.. autoattribute:: cuda.bindings.runtime.cudaSurfaceTypeCubemapLayered
60386052
.. autoattribute:: cuda.bindings.runtime.CUDA_EGL_MAX_PLANES
60396053

60406054
Maximum number of planes per frame
@@ -6320,17 +6334,3 @@ Data types used by CUDA Runtime
63206334
.. autoattribute:: cuda.bindings.runtime.cudaKernelNodeAttributeDeviceUpdatableKernelNode
63216335
.. autoattribute:: cuda.bindings.runtime.cudaKernelNodeAttributeNvlinkUtilCentricScheduling
63226336
.. autoattribute:: cuda.bindings.runtime.cudaKernelNodeAttrValue
6323-
.. autoattribute:: cuda.bindings.runtime.cudaSurfaceType1D
6324-
.. autoattribute:: cuda.bindings.runtime.cudaSurfaceType2D
6325-
.. autoattribute:: cuda.bindings.runtime.cudaSurfaceType3D
6326-
.. autoattribute:: cuda.bindings.runtime.cudaSurfaceTypeCubemap
6327-
.. autoattribute:: cuda.bindings.runtime.cudaSurfaceType1DLayered
6328-
.. autoattribute:: cuda.bindings.runtime.cudaSurfaceType2DLayered
6329-
.. autoattribute:: cuda.bindings.runtime.cudaSurfaceTypeCubemapLayered
6330-
.. autoattribute:: cuda.bindings.runtime.cudaTextureType1D
6331-
.. autoattribute:: cuda.bindings.runtime.cudaTextureType2D
6332-
.. autoattribute:: cuda.bindings.runtime.cudaTextureType3D
6333-
.. autoattribute:: cuda.bindings.runtime.cudaTextureTypeCubemap
6334-
.. autoattribute:: cuda.bindings.runtime.cudaTextureType1DLayered
6335-
.. autoattribute:: cuda.bindings.runtime.cudaTextureType2DLayered
6336-
.. autoattribute:: cuda.bindings.runtime.cudaTextureTypeCubemapLayered

0 commit comments

Comments
 (0)