Skip to content

Commit 28d4bf3

Browse files
author
cuda-python-bot
committed
Deploy latest docs: 1af5db9 
1 parent d79ba2e commit 28d4bf3

File tree

221 files changed

+1759
-225
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

221 files changed

+1759
-225
lines changed

‎docs/cuda-bindings/latest/_sources/api.rst.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,6 @@ CUDA Python API Reference
1414
module/nvrtc
1515
module/nvjitlink
1616
module/nvvm
17+
module/nvfatbin
1718
module/cufile
1819
module/utils

‎docs/cuda-bindings/latest/_sources/module/nvfatbin.rst.txt‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
.. SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2+
.. SPDX-License-Identifier: LicenseRef-NVIDIA-SOFTWARE-LICENSE
3+
4+
.. default-role:: cpp:any
5+
6+
nvfatbin
7+
========
8+
9+
Note
10+
----
11+
12+
The nvfatbin bindings are not supported on nvFatbin installations <12.4. Ensure the installed CUDA toolkit's nvFatbin version is >=12.4.
13+
14+
The Tile IR API (:func:`cuda.bindings.nvfatbin.add_tile_ir`) is only available in CUDA 13.1+.
15+
16+
Functions
17+
---------
18+
19+
NvFatbin defines the following functions for creating and populating fatbinaries.
20+
21+
.. autofunction:: cuda.bindings.nvfatbin.create
22+
.. autofunction:: cuda.bindings.nvfatbin.destroy
23+
.. autofunction:: cuda.bindings.nvfatbin.add_ptx
24+
.. autofunction:: cuda.bindings.nvfatbin.add_cubin
25+
.. autofunction:: cuda.bindings.nvfatbin.add_ltoir
26+
.. autofunction:: cuda.bindings.nvfatbin.add_reloc
27+
.. autofunction:: cuda.bindings.nvfatbin.add_tile_ir
28+
.. autofunction:: cuda.bindings.nvfatbin.size
29+
.. autofunction:: cuda.bindings.nvfatbin.get
30+
.. autofunction:: cuda.bindings.nvfatbin.get_error_string
31+
.. autofunction:: cuda.bindings.nvfatbin.version
32+
33+
Types
34+
---------
35+
.. autoclass:: cuda.bindings.nvfatbin.Result
36+
37+
.. autoattribute:: cuda.bindings.nvfatbin.Result.SUCCESS
38+
39+
40+
.. autoattribute:: cuda.bindings.nvfatbin.Result.ERROR_INTERNAL
41+
42+
43+
.. autoattribute:: cuda.bindings.nvfatbin.Result.ERROR_ELF_ARCH_MISMATCH
44+
45+
46+
.. autoattribute:: cuda.bindings.nvfatbin.Result.ERROR_ELF_SIZE_MISMATCH
47+
48+
49+
.. autoattribute:: cuda.bindings.nvfatbin.Result.ERROR_MISSING_PTX_VERSION
50+
51+
52+
.. autoattribute:: cuda.bindings.nvfatbin.Result.ERROR_NULL_POINTER
53+
54+
55+
.. autoattribute:: cuda.bindings.nvfatbin.Result.ERROR_COMPRESSION_FAILED
56+
57+
58+
.. autoattribute:: cuda.bindings.nvfatbin.Result.ERROR_COMPRESSED_SIZE_EXCEEDED
59+
60+
61+
.. autoattribute:: cuda.bindings.nvfatbin.Result.ERROR_UNRECOGNIZED_OPTION
62+
63+
64+
.. autoattribute:: cuda.bindings.nvfatbin.Result.ERROR_INVALID_ARCH
65+
66+
67+
.. autoattribute:: cuda.bindings.nvfatbin.Result.ERROR_INVALID_NVVM
68+
69+
70+
.. autoattribute:: cuda.bindings.nvfatbin.Result.ERROR_EMPTY_INPUT
71+
72+
73+
.. autoattribute:: cuda.bindings.nvfatbin.Result.ERROR_MISSING_PTX_ARCH
74+
75+
76+
.. autoattribute:: cuda.bindings.nvfatbin.Result.ERROR_PTX_ARCH_MISMATCH
77+
78+
79+
.. autoattribute:: cuda.bindings.nvfatbin.Result.ERROR_MISSING_FATBIN
80+
81+
82+
.. autoattribute:: cuda.bindings.nvfatbin.Result.ERROR_INVALID_INDEX
83+
84+
85+
.. autoattribute:: cuda.bindings.nvfatbin.Result.ERROR_IDENTIFIER_REUSE
86+
87+
88+
.. autoattribute:: cuda.bindings.nvfatbin.Result.ERROR_INTERNAL_PTX_OPTION
89+

‎docs/cuda-bindings/latest/_sources/release/13.1.X-notes.rst.txt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99
Highlights
1010
----------
1111

12+
* Add ``nvFatbin`` bindings. (PR #1467 <https://github.com/NVIDIA/cuda-python/pull/1467>_)
13+
1214
Experimental
1315
------------
1416

‎docs/cuda-bindings/latest/api.html‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -547,6 +547,7 @@
547547
<li class="toctree-l2"><a class="reference internal" href="module/nvrtc.html">nvrtc</a></li>
548548
<li class="toctree-l2"><a class="reference internal" href="module/nvjitlink.html">nvjitlink</a></li>
549549
<li class="toctree-l2"><a class="reference internal" href="module/nvvm.html">nvvm</a></li>
550+
<li class="toctree-l2"><a class="reference internal" href="module/nvfatbin.html">nvfatbin</a></li>
550551
<li class="toctree-l2 has-children"><a class="reference internal" href="module/cufile.html">cufile</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
551552
<li class="toctree-l3"><a class="reference internal" href="module/generated/cuda.bindings.cufile.handle_register.html">cuda.bindings.cufile.handle_register</a></li>
552553
<li class="toctree-l3"><a class="reference internal" href="module/generated/cuda.bindings.cufile.handle_deregister.html">cuda.bindings.cufile.handle_deregister</a></li>
@@ -2449,6 +2450,28 @@ <h1>CUDA Python API Reference<a class="headerlink" href="#cuda-python-api-refere
24492450
</li>
24502451
</ul>
24512452
</li>
2453+
<li class="toctree-l1"><a class="reference internal" href="module/nvfatbin.html">nvfatbin</a><ul>
2454+
<li class="toctree-l2"><a class="reference internal" href="module/nvfatbin.html#note">Note</a></li>
2455+
<li class="toctree-l2"><a class="reference internal" href="module/nvfatbin.html#functions">Functions</a><ul>
2456+
<li class="toctree-l3"><a class="reference internal" href="module/nvfatbin.html#cuda.bindings.nvfatbin.create"><code class="docutils literal notranslate"><span class="pre">create()</span></code></a></li>
2457+
<li class="toctree-l3"><a class="reference internal" href="module/nvfatbin.html#cuda.bindings.nvfatbin.destroy"><code class="docutils literal notranslate"><span class="pre">destroy()</span></code></a></li>
2458+
<li class="toctree-l3"><a class="reference internal" href="module/nvfatbin.html#cuda.bindings.nvfatbin.add_ptx"><code class="docutils literal notranslate"><span class="pre">add_ptx()</span></code></a></li>
2459+
<li class="toctree-l3"><a class="reference internal" href="module/nvfatbin.html#cuda.bindings.nvfatbin.add_cubin"><code class="docutils literal notranslate"><span class="pre">add_cubin()</span></code></a></li>
2460+
<li class="toctree-l3"><a class="reference internal" href="module/nvfatbin.html#cuda.bindings.nvfatbin.add_ltoir"><code class="docutils literal notranslate"><span class="pre">add_ltoir()</span></code></a></li>
2461+
<li class="toctree-l3"><a class="reference internal" href="module/nvfatbin.html#cuda.bindings.nvfatbin.add_reloc"><code class="docutils literal notranslate"><span class="pre">add_reloc()</span></code></a></li>
2462+
<li class="toctree-l3"><a class="reference internal" href="module/nvfatbin.html#cuda.bindings.nvfatbin.add_tile_ir"><code class="docutils literal notranslate"><span class="pre">add_tile_ir()</span></code></a></li>
2463+
<li class="toctree-l3"><a class="reference internal" href="module/nvfatbin.html#cuda.bindings.nvfatbin.size"><code class="docutils literal notranslate"><span class="pre">size()</span></code></a></li>
2464+
<li class="toctree-l3"><a class="reference internal" href="module/nvfatbin.html#cuda.bindings.nvfatbin.get"><code class="docutils literal notranslate"><span class="pre">get()</span></code></a></li>
2465+
<li class="toctree-l3"><a class="reference internal" href="module/nvfatbin.html#cuda.bindings.nvfatbin.get_error_string"><code class="docutils literal notranslate"><span class="pre">get_error_string()</span></code></a></li>
2466+
<li class="toctree-l3"><a class="reference internal" href="module/nvfatbin.html#cuda.bindings.nvfatbin.version"><code class="docutils literal notranslate"><span class="pre">version()</span></code></a></li>
2467+
</ul>
2468+
</li>
2469+
<li class="toctree-l2"><a class="reference internal" href="module/nvfatbin.html#types">Types</a><ul>
2470+
<li class="toctree-l3"><a class="reference internal" href="module/nvfatbin.html#cuda.bindings.nvfatbin.Result"><code class="docutils literal notranslate"><span class="pre">Result</span></code></a></li>
2471+
</ul>
2472+
</li>
2473+
</ul>
2474+
</li>
24522475
<li class="toctree-l1"><a class="reference internal" href="module/cufile.html">cufile</a><ul>
24532476
<li class="toctree-l2"><a class="reference internal" href="module/cufile.html#functions">Functions</a><ul>
24542477
<li class="toctree-l3"><a class="reference internal" href="module/generated/cuda.bindings.cufile.handle_register.html">cuda.bindings.cufile.handle_register</a></li>

‎docs/cuda-bindings/latest/conduct.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -551,6 +551,7 @@
551551
<li class="toctree-l2"><a class="reference internal" href="module/nvrtc.html">nvrtc</a></li>
552552
<li class="toctree-l2"><a class="reference internal" href="module/nvjitlink.html">nvjitlink</a></li>
553553
<li class="toctree-l2"><a class="reference internal" href="module/nvvm.html">nvvm</a></li>
554+
<li class="toctree-l2"><a class="reference internal" href="module/nvfatbin.html">nvfatbin</a></li>
554555
<li class="toctree-l2 has-children"><a class="reference internal" href="module/cufile.html">cufile</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
555556
<li class="toctree-l3"><a class="reference internal" href="module/generated/cuda.bindings.cufile.handle_register.html">cuda.bindings.cufile.handle_register</a></li>
556557
<li class="toctree-l3"><a class="reference internal" href="module/generated/cuda.bindings.cufile.handle_deregister.html">cuda.bindings.cufile.handle_deregister</a></li>

‎docs/cuda-bindings/latest/contribute.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -547,6 +547,7 @@
547547
<li class="toctree-l2"><a class="reference internal" href="module/nvrtc.html">nvrtc</a></li>
548548
<li class="toctree-l2"><a class="reference internal" href="module/nvjitlink.html">nvjitlink</a></li>
549549
<li class="toctree-l2"><a class="reference internal" href="module/nvvm.html">nvvm</a></li>
550+
<li class="toctree-l2"><a class="reference internal" href="module/nvfatbin.html">nvfatbin</a></li>
550551
<li class="toctree-l2 has-children"><a class="reference internal" href="module/cufile.html">cufile</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
551552
<li class="toctree-l3"><a class="reference internal" href="module/generated/cuda.bindings.cufile.handle_register.html">cuda.bindings.cufile.handle_register</a></li>
552553
<li class="toctree-l3"><a class="reference internal" href="module/generated/cuda.bindings.cufile.handle_deregister.html">cuda.bindings.cufile.handle_deregister</a></li>

‎docs/cuda-bindings/latest/environment_variables.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -551,6 +551,7 @@
551551
<li class="toctree-l2"><a class="reference internal" href="module/nvrtc.html">nvrtc</a></li>
552552
<li class="toctree-l2"><a class="reference internal" href="module/nvjitlink.html">nvjitlink</a></li>
553553
<li class="toctree-l2"><a class="reference internal" href="module/nvvm.html">nvvm</a></li>
554+
<li class="toctree-l2"><a class="reference internal" href="module/nvfatbin.html">nvfatbin</a></li>
554555
<li class="toctree-l2 has-children"><a class="reference internal" href="module/cufile.html">cufile</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
555556
<li class="toctree-l3"><a class="reference internal" href="module/generated/cuda.bindings.cufile.handle_register.html">cuda.bindings.cufile.handle_register</a></li>
556557
<li class="toctree-l3"><a class="reference internal" href="module/generated/cuda.bindings.cufile.handle_deregister.html">cuda.bindings.cufile.handle_deregister</a></li>

0 commit comments

Comments
 (0)