Merge pull request #445 from rwgk/add_docs_nvvm_rst

Add cuda_bindings/docs/source/module/nvvm.rst

Author: leofang

cuda_bindings/docs/source/api.rst

@@ -10,3 +10,4 @@ CUDA Python API Reference
    module/runtime
    module/nvrtc
    module/nvjitlink
+   module/nvvm

cuda_bindings/docs/source/install.md

@@ -29,6 +29,7 @@ Where the optional dependencies are:
 
 * nvidia-cuda-nvrtc-cu12 (Provides NVRTC shared library)
 * nvidia-nvjitlink-cu12>=12.3 (Provides nvJitLink shared library)
+* nvidia-cuda-nvcc-cu12 (Provides NVVM shared library)
 
 
 ## Installing from Conda

cuda_bindings/docs/source/module/nvvm.rst

@@ -0,0 +1,50 @@
+nvvm
+====
+
+The ``cuda.bindings.nvvm`` Python module wraps the
+`libNVVM C API <https://docs.nvidia.com/cuda/libnvvm-api/>`_.
+
+Functions
+---------
+
+.. autofunction:: cuda.bindings.nvvm.version
+.. autofunction:: cuda.bindings.nvvm.ir_version
+.. autofunction:: cuda.bindings.nvvm.create_program
+.. autofunction:: cuda.bindings.nvvm.add_module_to_program
+.. autofunction:: cuda.bindings.nvvm.lazy_add_module_to_program
+.. autofunction:: cuda.bindings.nvvm.compile_program
+.. autofunction:: cuda.bindings.nvvm.verify_program
+.. autofunction:: cuda.bindings.nvvm.get_compiled_result_size
+.. autofunction:: cuda.bindings.nvvm.get_compiled_result
+.. autofunction:: cuda.bindings.nvvm.get_program_log_size
+.. autofunction:: cuda.bindings.nvvm.get_program_log
+
+Types
+-----
+
+..
+   The empty lines below are important!
+
+.. autoclass:: cuda.bindings.nvvm.Result
+
+    .. autoattribute:: cuda.bindings.nvvm.Result.SUCCESS
+
+    .. autoattribute:: cuda.bindings.nvvm.Result.ERROR_OUT_OF_MEMORY
+
+    .. autoattribute:: cuda.bindings.nvvm.Result.ERROR_PROGRAM_CREATION_FAILURE
+
+    .. autoattribute:: cuda.bindings.nvvm.Result.ERROR_IR_VERSION_MISMATCH
+
+    .. autoattribute:: cuda.bindings.nvvm.Result.ERROR_INVALID_INPUT
+
+    .. autoattribute:: cuda.bindings.nvvm.Result.ERROR_INVALID_PROGRAM
+
+    .. autoattribute:: cuda.bindings.nvvm.Result.ERROR_INVALID_IR
+
+    .. autoattribute:: cuda.bindings.nvvm.Result.ERROR_INVALID_OPTION
+
+    .. autoattribute:: cuda.bindings.nvvm.Result.ERROR_NO_MODULE_IN_PROGRAM
+
+    .. autoattribute:: cuda.bindings.nvvm.Result.ERROR_COMPILATION
+
+    .. autoattribute:: cuda.bindings.nvvm.Result.ERROR_CANCELLED

cuda_bindings/docs/source/release.rst

@@ -4,6 +4,7 @@ Release Notes
 .. toctree::
    :maxdepth: 3
 
+   12.X.Y <release/12.X.Y-notes.rst>
    12.8.0 <release/12.8.0-notes.md>
    12.6.2 <release/12.6.2-notes.md>
    12.6.1 <release/12.6.1-notes.md>
@@ -15,6 +16,7 @@ Release Notes
    12.2.0 <release/12.2.0-notes.md>
    12.1.0 <release/12.1.0-notes.md>
    12.0.0 <release/12.0.0-notes.md>
+   11.8.7 <release/11.8.7-notes.rst>
    11.8.6 <release/11.8.6-notes.md>
    11.8.5 <release/11.8.5-notes.md>
    11.8.4 <release/11.8.4-notes.md>

cuda_bindings/docs/source/release/11.8.7-notes.rst

@@ -0,0 +1,11 @@
+``cuda-bindings`` 11.8.7 Release notes
+======================================
+
+Released on **TBD**.
+
+
+Highlights
+----------
+
+* The ``cuda.bindings.nvvm`` Python module was added, wrapping the
+  `libNVVM C API <https://docs.nvidia.com/cuda/libnvvm-api/>`_.

cuda_bindings/docs/source/release/12.X.Y-notes.rst

@@ -0,0 +1,11 @@
+``cuda-bindings`` 12.X.Y Release notes
+======================================
+
+Released on **TBD**.
+
+
+Highlights
+----------
+
+* The ``cuda.bindings.nvvm`` Python module was added, wrapping the
+  `libNVVM C API <https://docs.nvidia.com/cuda/libnvvm-api/>`_.