Merge pull request NVIDIA#291 from ksimpson-work/nvjitlink-documentation

add nvjitlink to bindings documentation
ksimpson-work · Dec 18, 2024 · 33b7366 · 33b7366
2 parents 3ac17fe + c6fb75c
commit 33b7366
Show file tree

Hide file tree

Showing 4 changed files with 92 additions and 0 deletions.
diff --git a/cuda_bindings/docs/source/api.rst b/cuda_bindings/docs/source/api.rst
@@ -9,3 +9,4 @@ CUDA Python API Reference
    module/driver
    module/runtime
    module/nvrtc
+   module/nvjitlink
diff --git a/cuda_bindings/docs/source/module/nvjitlink.rst b/cuda_bindings/docs/source/module/nvjitlink.rst
@@ -0,0 +1,84 @@
+nvjitlink
+=========
+
+Functions
+---------
+
+NvJitLink defines the following functions for linking code objects and querying the info and error logs.
+
+.. autofunction:: cuda.bindings.nvjitlink.create
+.. autofunction:: cuda.bindings.nvjitlink.destroy
+.. autofunction:: cuda.bindings.nvjitlink.add_data
+.. autofunction:: cuda.bindings.nvjitlink.add_file
+.. autofunction:: cuda.bindings.nvjitlink.complete
+.. autofunction:: cuda.bindings.nvjitlink.get_linked_cubin_size
+.. autofunction:: cuda.bindings.nvjitlink.get_linked_cubin
+.. autofunction:: cuda.bindings.nvjitlink.get_linked_ptx_size
+.. autofunction:: cuda.bindings.nvjitlink.get_linked_ptx
+.. autofunction:: cuda.bindings.nvjitlink.get_error_log_size
+.. autofunction:: cuda.bindings.nvjitlink.get_error_log
+.. autofunction:: cuda.bindings.nvjitlink.get_info_log_size
+.. autofunction:: cuda.bindings.nvjitlink.get_info_log
+.. autofunction:: cuda.bindings.nvjitlink.version
+
+Types
+---------
+.. autoclass:: cuda.bindings.nvjitlink.Result
+
+    .. autoattribute:: cuda.bindings.nvjitlink.Result.SUCCESS
+
+
+    .. autoattribute:: cuda.bindings.nvjitlink.Result.ERROR_UNRECOGNIZED_OPTION
+
+
+    .. autoattribute:: cuda.bindings.nvjitlink.Result.ERROR_MISSING_ARCH
+
+
+    .. autoattribute:: cuda.bindings.nvjitlink.Result.ERROR_INVALID_INPUT
+
+
+    .. autoattribute:: cuda.bindings.nvjitlink.Result.ERROR_PTX_COMPILE
+
+
+    .. autoattribute:: cuda.bindings.nvjitlink.Result.ERROR_NVVM_COMPILE
+
+
+    .. autoattribute:: cuda.bindings.nvjitlink.Result.ERROR_INTERNAL
+
+
+    .. autoattribute:: cuda.bindings.nvjitlink.Result.ERROR_THREADPOOL
+
+
+    .. autoattribute:: cuda.bindings.nvjitlink.Result.ERROR_UNRECOGNIZED_INPUT
+
+
+    .. autoattribute:: cuda.bindings.nvjitlink.Result.ERROR_FINALIZE
+
+
+.. autoclass:: cuda.bindings.nvjitlink.InputType
+
+    .. autoattribute:: cuda.bindings.nvjitlink.InputType.NONE
+
+
+    .. autoattribute:: cuda.bindings.nvjitlink.InputType.CUBIN
+
+
+    .. autoattribute:: cuda.bindings.nvjitlink.InputType.PTX
+
+
+    .. autoattribute:: cuda.bindings.nvjitlink.InputType.LTOIR
+
+
+    .. autoattribute:: cuda.bindings.nvjitlink.InputType.FATBIN
+
+
+    .. autoattribute:: cuda.bindings.nvjitlink.InputType.OBJECT
+
+
+    .. autoattribute:: cuda.bindings.nvjitlink.InputType.LIBRARY
+
+
+    .. autoattribute:: cuda.bindings.nvjitlink.InputType.INDEX
+
+
+    .. autoattribute:: cuda.bindings.nvjitlink.InputType.ANY
diff --git a/cuda_bindings/docs/source/release.md b/cuda_bindings/docs/source/release.md
@@ -5,6 +5,7 @@
 maxdepth: 3
 ---
 
+    12.x.y <release/12.x.y-notes>
     12.6.2 <release/12.6.2-notes>
     12.6.1 <release/12.6.1-notes>
     12.6.0 <release/12.6.0-notes>

diff --git a/cuda_bindings/docs/source/release/12.x.y-notes.md b/cuda_bindings/docs/source/release/12.x.y-notes.md
@@ -0,0 +1,6 @@
+# CUDA Python 12.X.Y Release notes
+
+Released on MM DD, 20YY.
+
+## Highlights
+- Added bindings for nvJitLink. It requires nvJitLink from CUDA 12.3 or above.