Skip to content

Commit 9fa68fa

Browse files
committed
Add cuda_bindings/docs/source/module/nvvm.rst
This files was put together manually based on cuda_bindings/cuda/bindings/nvvm.pxd and using cuda_bindings/docs/source/module/nvjitlink.rst as a starting point.
1 parent acff0c5 commit 9fa68fa

3 files changed

Lines changed: 49 additions & 0 deletions

File tree

cuda_bindings/docs/source/api.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,4 @@ CUDA Python API Reference
1010
module/runtime
1111
module/nvrtc
1212
module/nvjitlink
13+
module/nvvm

cuda_bindings/docs/source/install.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ Where the optional dependencies are:
2929

3030
* nvidia-cuda-nvrtc-cu12 (Provides NVRTC shared library)
3131
* nvidia-nvjitlink-cu12>=12.3 (Provides nvJitLink shared library)
32+
* nvidia-cuda-nvcc-cu12 (Provides NVVM shared library)
3233

3334

3435
## Installing from Conda
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
NVVM
2+
====
3+
4+
The ``cuda.bindings.nvvm`` Python module wraps the
5+
`libNVVM C API <https://docs.nvidia.com/cuda/libnvvm-api/>`_.
6+
7+
Functions
8+
---------
9+
10+
.. autofunction:: cuda.bindings.nvvm.version
11+
.. autofunction:: cuda.bindings.nvvm.ir_version
12+
.. autofunction:: cuda.bindings.nvvm.create_program
13+
.. autofunction:: cuda.bindings.nvvm.add_module_to_program
14+
.. autofunction:: cuda.bindings.nvvm.lazy_add_module_to_program
15+
.. autofunction:: cuda.bindings.nvvm.compile_program
16+
.. autofunction:: cuda.bindings.nvvm.verify_program
17+
.. autofunction:: cuda.bindings.nvvm.get_compiled_result_size
18+
.. autofunction:: cuda.bindings.nvvm.get_compiled_result
19+
.. autofunction:: cuda.bindings.nvvm.get_program_log_size
20+
.. autofunction:: cuda.bindings.nvvm.get_program_log
21+
22+
Types
23+
-----
24+
25+
.. autoclass:: cuda.bindings.nvvm.Result
26+
27+
.. autoattribute:: cuda.bindings.nvvm.Result.SUCCESS
28+
29+
.. autoattribute:: cuda.bindings.nvvm.Result.ERROR_OUT_OF_MEMORY
30+
31+
.. autoattribute:: cuda.bindings.nvvm.Result.ERROR_PROGRAM_CREATION_FAILURE
32+
33+
.. autoattribute:: cuda.bindings.nvvm.Result.ERROR_IR_VERSION_MISMATCH
34+
35+
.. autoattribute:: cuda.bindings.nvvm.Result.ERROR_INVALID_INPUT
36+
37+
.. autoattribute:: cuda.bindings.nvvm.Result.ERROR_INVALID_PROGRAM
38+
39+
.. autoattribute:: cuda.bindings.nvvm.Result.ERROR_INVALID_IR
40+
41+
.. autoattribute:: cuda.bindings.nvvm.Result.ERROR_INVALID_OPTION
42+
43+
.. autoattribute:: cuda.bindings.nvvm.Result.ERROR_NO_MODULE_IN_PROGRAM
44+
45+
.. autoattribute:: cuda.bindings.nvvm.Result.ERROR_COMPILATION
46+
47+
.. autoattribute:: cuda.bindings.nvvm.Result.ERROR_CANCELLED

0 commit comments

Comments
 (0)