Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add nvjitlink to bindings documentation #291

Merged
merged 11 commits into from
Dec 18, 2024
1 change: 1 addition & 0 deletions cuda_bindings/docs/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ CUDA Python API Reference
module/driver
module/runtime
module/nvrtc
module/nvjitlink
84 changes: 84 additions & 0 deletions cuda_bindings/docs/source/module/nvjitlink.rst
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions cuda_bindings/docs/source/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
6 changes: 6 additions & 0 deletions cuda_bindings/docs/source/release/12.x.y-notes.md
Original file line number Diff line number Diff line change
@@ -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.