Skip to content

Commit 70ec6a6

Browse files
mdboommdboom
authored
Update docs following CTK 13.2 release (#1812)
1 parent 1f99cdf commit 70ec6a6

File tree

3 files changed

+213
-154
lines changed

3 files changed

+213
-154
lines changed

‎cuda_bindings/cuda/bindings/runtime.pyx.in‎

Lines changed: 75 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# SPDX-FileCopyrightText: Copyright (c) 2021-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
22
# SPDX-License-Identifier: LicenseRef-NVIDIA-SOFTWARE-LICENSE
33

4-
# This code was automatically generated with version 13.2.0, generator version 8797618. Do not modify it directly.
4+
# This code was automatically generated with version 13.2.0, generator version 0.3.1.dev1422+gf4812259e.d20260318. Do not modify it directly.
55
from typing import Any, Optional
66
import cython
77
import ctypes
@@ -1858,7 +1858,9 @@ class cudaLogLevel(_FastEnum):
18581858
{{if 'cudaDataType_t' in found_types}}
18591859

18601860
class cudaDataType(_FastEnum):
1861-
""""""
1861+
"""
1862+
1863+
"""
18621864
{{if 'CUDA_R_32F' in found_values}}
18631865
CUDA_R_32F = cyruntime.cudaDataType_t.CUDA_R_32F{{endif}}
18641866
{{if 'CUDA_R_64F' in found_values}}
@@ -1934,43 +1936,98 @@ class cudaDataType(_FastEnum):
19341936
{{if 'cudaEmulationStrategy_t' in found_types}}
19351937

19361938
class cudaEmulationStrategy(_FastEnum):
1937-
""""""
1939+
"""
1940+
Enum for specifying how to leverage floating-point emulation
1941+
algorithms
1942+
"""
19381943
{{if 'CUDA_EMULATION_STRATEGY_DEFAULT' in found_values}}
1939-
CUDA_EMULATION_STRATEGY_DEFAULT = cyruntime.cudaEmulationStrategy_t.CUDA_EMULATION_STRATEGY_DEFAULT{{endif}}
1944+
1945+
CUDA_EMULATION_STRATEGY_DEFAULT = (
1946+
cyruntime.cudaEmulationStrategy_t.CUDA_EMULATION_STRATEGY_DEFAULT,
1947+
'The default emulation strategy. For emulated computations, this is\n'
1948+
'equivalent to CUDA_EMULATION_STRATEGY_PERFORMANT, unless a library\n'
1949+
'dependent environment variable is set\n'
1950+
){{endif}}
19401951
{{if 'CUDA_EMULATION_STRATEGY_PERFORMANT' in found_values}}
1941-
CUDA_EMULATION_STRATEGY_PERFORMANT = cyruntime.cudaEmulationStrategy_t.CUDA_EMULATION_STRATEGY_PERFORMANT{{endif}}
1952+
1953+
CUDA_EMULATION_STRATEGY_PERFORMANT = (
1954+
cyruntime.cudaEmulationStrategy_t.CUDA_EMULATION_STRATEGY_PERFORMANT,
1955+
'An emulation strategy which configures libraries to use emulation when it\n'
1956+
'provides a performance benefit\n'
1957+
){{endif}}
19421958
{{if 'CUDA_EMULATION_STRATEGY_EAGER' in found_values}}
1943-
CUDA_EMULATION_STRATEGY_EAGER = cyruntime.cudaEmulationStrategy_t.CUDA_EMULATION_STRATEGY_EAGER{{endif}}
1959+
1960+
CUDA_EMULATION_STRATEGY_EAGER = (
1961+
cyruntime.cudaEmulationStrategy_t.CUDA_EMULATION_STRATEGY_EAGER,
1962+
'An emulation strategy which configures libraries to use emulation whenever\n'
1963+
'possible\n'
1964+
){{endif}}
19441965

19451966
{{endif}}
19461967
{{if 'cudaEmulationMantissaControl_t' in found_types}}
19471968

19481969
class cudaEmulationMantissaControl(_FastEnum):
1949-
""""""
1970+
"""
1971+
Enum to configure the mantissa related parameters for floating-
1972+
point emulation algorithms
1973+
"""
19501974
{{if 'CUDA_EMULATION_MANTISSA_CONTROL_DYNAMIC' in found_values}}
1951-
CUDA_EMULATION_MANTISSA_CONTROL_DYNAMIC = cyruntime.cudaEmulationMantissaControl_t.CUDA_EMULATION_MANTISSA_CONTROL_DYNAMIC{{endif}}
1975+
1976+
CUDA_EMULATION_MANTISSA_CONTROL_DYNAMIC = (
1977+
cyruntime.cudaEmulationMantissaControl_t.CUDA_EMULATION_MANTISSA_CONTROL_DYNAMIC,
1978+
'The number of retained mantissa bits are computed at runtime to ensure the\n'
1979+
'same or better accuracy than the floating point representation being\n'
1980+
'emulated\n'
1981+
){{endif}}
19521982
{{if 'CUDA_EMULATION_MANTISSA_CONTROL_FIXED' in found_values}}
1953-
CUDA_EMULATION_MANTISSA_CONTROL_FIXED = cyruntime.cudaEmulationMantissaControl_t.CUDA_EMULATION_MANTISSA_CONTROL_FIXED{{endif}}
1983+
1984+
CUDA_EMULATION_MANTISSA_CONTROL_FIXED = (
1985+
cyruntime.cudaEmulationMantissaControl_t.CUDA_EMULATION_MANTISSA_CONTROL_FIXED,
1986+
'The number of retained mantissa bits are known at runtime\n'
1987+
){{endif}}
19541988

19551989
{{endif}}
19561990
{{if 'cudaEmulationSpecialValuesSupport_t' in found_types}}
19571991

19581992
class cudaEmulationSpecialValuesSupport(_FastEnum):
1959-
""""""
1993+
"""
1994+
Enum to configure how special floating-point values will be handled
1995+
by emulation algorithms
1996+
"""
19601997
{{if 'CUDA_EMULATION_SPECIAL_VALUES_SUPPORT_NONE' in found_values}}
1961-
CUDA_EMULATION_SPECIAL_VALUES_SUPPORT_NONE = cyruntime.cudaEmulationSpecialValuesSupport_t.CUDA_EMULATION_SPECIAL_VALUES_SUPPORT_NONE{{endif}}
1998+
1999+
CUDA_EMULATION_SPECIAL_VALUES_SUPPORT_NONE = (
2000+
cyruntime.cudaEmulationSpecialValuesSupport_t.CUDA_EMULATION_SPECIAL_VALUES_SUPPORT_NONE,
2001+
'There are no requirements for emulation algorithms to support special\n'
2002+
'values\n'
2003+
){{endif}}
19622004
{{if 'CUDA_EMULATION_SPECIAL_VALUES_SUPPORT_INFINITY' in found_values}}
1963-
CUDA_EMULATION_SPECIAL_VALUES_SUPPORT_INFINITY = cyruntime.cudaEmulationSpecialValuesSupport_t.CUDA_EMULATION_SPECIAL_VALUES_SUPPORT_INFINITY{{endif}}
2005+
2006+
CUDA_EMULATION_SPECIAL_VALUES_SUPPORT_INFINITY = (
2007+
cyruntime.cudaEmulationSpecialValuesSupport_t.CUDA_EMULATION_SPECIAL_VALUES_SUPPORT_INFINITY,
2008+
'Require emulation algorithms to handle signed infinity inputs and outputs\n'
2009+
){{endif}}
19642010
{{if 'CUDA_EMULATION_SPECIAL_VALUES_SUPPORT_NAN' in found_values}}
1965-
CUDA_EMULATION_SPECIAL_VALUES_SUPPORT_NAN = cyruntime.cudaEmulationSpecialValuesSupport_t.CUDA_EMULATION_SPECIAL_VALUES_SUPPORT_NAN{{endif}}
2011+
2012+
CUDA_EMULATION_SPECIAL_VALUES_SUPPORT_NAN = (
2013+
cyruntime.cudaEmulationSpecialValuesSupport_t.CUDA_EMULATION_SPECIAL_VALUES_SUPPORT_NAN,
2014+
'Require emulation algorithms to handle NaN inputs and outputs\n'
2015+
){{endif}}
19662016
{{if 'CUDA_EMULATION_SPECIAL_VALUES_SUPPORT_DEFAULT' in found_values}}
1967-
CUDA_EMULATION_SPECIAL_VALUES_SUPPORT_DEFAULT = cyruntime.cudaEmulationSpecialValuesSupport_t.CUDA_EMULATION_SPECIAL_VALUES_SUPPORT_DEFAULT{{endif}}
2017+
2018+
CUDA_EMULATION_SPECIAL_VALUES_SUPPORT_DEFAULT = (
2019+
cyruntime.cudaEmulationSpecialValuesSupport_t.CUDA_EMULATION_SPECIAL_VALUES_SUPPORT_DEFAULT,
2020+
'The default special value support mask which contains support for signed\n'
2021+
'infinities and NaN values\n'
2022+
){{endif}}
19682023

19692024
{{endif}}
19702025
{{if 'libraryPropertyType_t' in found_types}}
19712026

19722027
class libraryPropertyType(_FastEnum):
1973-
""""""
2028+
"""
2029+
2030+
"""
19742031
{{if 'MAJOR_VERSION' in found_values}}
19752032
MAJOR_VERSION = cyruntime.libraryPropertyType_t.MAJOR_VERSION{{endif}}
19762033
{{if 'MINOR_VERSION' in found_values}}
@@ -6394,7 +6451,9 @@ class cudaTextureReadMode(_FastEnum):
63946451
{{if 'cudaRoundMode' in found_types}}
63956452

63966453
class cudaRoundMode(_FastEnum):
6397-
""""""
6454+
"""
6455+
6456+
"""
63986457
{{if 'cudaRoundNearest' in found_values}}
63996458
cudaRoundNearest = cyruntime.cudaRoundMode.cudaRoundNearest{{endif}}
64006459
{{if 'cudaRoundZero' in found_values}}

‎cuda_bindings/docs/source/module/driver.rst‎

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

0 commit comments

Comments
 (0)