Skip to content

Commit 363d13d

Browse files
committed
Deploy latest docs: 474ec97
1 parent 068e5a1 commit 363d13d

File tree

147 files changed

+1633
-145
lines changed

Some content is hidden

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

147 files changed

+1633
-145
lines changed

docs/cuda-bindings/jupyter_execute/overview.ipynb

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"cells": [
33
{
44
"cell_type": "markdown",
5-
"id": "e4ec4817",
5+
"id": "2c2ee760",
66
"metadata": {},
77
"source": [
88
"# Overview\n",
@@ -50,7 +50,7 @@
5050
{
5151
"cell_type": "code",
5252
"execution_count": 1,
53-
"id": "3e3b9cc4",
53+
"id": "eec9439d",
5454
"metadata": {},
5555
"outputs": [],
5656
"source": [
@@ -60,7 +60,7 @@
6060
},
6161
{
6262
"cell_type": "markdown",
63-
"id": "4f485e19",
63+
"id": "a02f0fed",
6464
"metadata": {},
6565
"source": [
6666
"Error checking is a fundamental best practice in code development and a code\n",
@@ -72,7 +72,7 @@
7272
{
7373
"cell_type": "code",
7474
"execution_count": 2,
75-
"id": "1681c159",
75+
"id": "aba234e7",
7676
"metadata": {},
7777
"outputs": [],
7878
"source": [
@@ -98,7 +98,7 @@
9898
},
9999
{
100100
"cell_type": "markdown",
101-
"id": "9f00a874",
101+
"id": "aedde00f",
102102
"metadata": {},
103103
"source": [
104104
"It’s common practice to write CUDA kernels near the top of a translation unit,\n",
@@ -112,7 +112,7 @@
112112
{
113113
"cell_type": "code",
114114
"execution_count": 3,
115-
"id": "9fb64edb",
115+
"id": "9501b26e",
116116
"metadata": {},
117117
"outputs": [],
118118
"source": [
@@ -130,7 +130,7 @@
130130
},
131131
{
132132
"cell_type": "markdown",
133-
"id": "12c3d68e",
133+
"id": "ba8aa6dd",
134134
"metadata": {},
135135
"source": [
136136
"Go ahead and compile the kernel into PTX. Remember that this is executed at runtime using NVRTC. There are three basic steps to NVRTC:\n",
@@ -147,7 +147,7 @@
147147
{
148148
"cell_type": "code",
149149
"execution_count": 4,
150-
"id": "4dcbbae0",
150+
"id": "3f34e779",
151151
"metadata": {},
152152
"outputs": [],
153153
"source": [
@@ -177,7 +177,7 @@
177177
},
178178
{
179179
"cell_type": "markdown",
180-
"id": "44d61dcc",
180+
"id": "fb09c972",
181181
"metadata": {},
182182
"source": [
183183
"Before you can use the PTX or do any work on the GPU, you must create a CUDA\n",
@@ -189,7 +189,7 @@
189189
{
190190
"cell_type": "code",
191191
"execution_count": 5,
192-
"id": "651b8b1d",
192+
"id": "ccb32289",
193193
"metadata": {},
194194
"outputs": [],
195195
"source": [
@@ -199,7 +199,7 @@
199199
},
200200
{
201201
"cell_type": "markdown",
202-
"id": "260e3e04",
202+
"id": "a2f56747",
203203
"metadata": {},
204204
"source": [
205205
"With a CUDA context created on device 0, load the PTX generated earlier into a\n",
@@ -211,7 +211,7 @@
211211
{
212212
"cell_type": "code",
213213
"execution_count": 6,
214-
"id": "faaa6606",
214+
"id": "d4fbd234",
215215
"metadata": {},
216216
"outputs": [],
217217
"source": [
@@ -224,7 +224,7 @@
224224
},
225225
{
226226
"cell_type": "markdown",
227-
"id": "1b6a9c1b",
227+
"id": "84b6af96",
228228
"metadata": {},
229229
"source": [
230230
"Next, get all your data prepared and transferred to the GPU. For increased\n",
@@ -236,7 +236,7 @@
236236
{
237237
"cell_type": "code",
238238
"execution_count": 7,
239-
"id": "2610146c",
239+
"id": "857cb9dc",
240240
"metadata": {},
241241
"outputs": [],
242242
"source": [
@@ -254,7 +254,7 @@
254254
},
255255
{
256256
"cell_type": "markdown",
257-
"id": "062d791c",
257+
"id": "299122b9",
258258
"metadata": {},
259259
"source": [
260260
"With the input data `a`, `x`, and `y` created for the SAXPY transform device,\n",
@@ -271,7 +271,7 @@
271271
{
272272
"cell_type": "code",
273273
"execution_count": 8,
274-
"id": "5265fe4c",
274+
"id": "19f9e83f",
275275
"metadata": {},
276276
"outputs": [],
277277
"source": [
@@ -291,7 +291,7 @@
291291
},
292292
{
293293
"cell_type": "markdown",
294-
"id": "c616468b",
294+
"id": "6e703eba",
295295
"metadata": {},
296296
"source": [
297297
"With data prep and resources allocation finished, the kernel is ready to be\n",
@@ -308,7 +308,7 @@
308308
{
309309
"cell_type": "code",
310310
"execution_count": 9,
311-
"id": "9f959caf",
311+
"id": "5a917142",
312312
"metadata": {},
313313
"outputs": [],
314314
"source": [
@@ -324,7 +324,7 @@
324324
},
325325
{
326326
"cell_type": "markdown",
327-
"id": "7748da50",
327+
"id": "65d9e077",
328328
"metadata": {},
329329
"source": [
330330
"Now the kernel can be launched:"
@@ -333,7 +333,7 @@
333333
{
334334
"cell_type": "code",
335335
"execution_count": 10,
336-
"id": "d39dd4ea",
336+
"id": "310fdfe7",
337337
"metadata": {},
338338
"outputs": [],
339339
"source": [
@@ -359,7 +359,7 @@
359359
},
360360
{
361361
"cell_type": "markdown",
362-
"id": "40026786",
362+
"id": "c8c842c7",
363363
"metadata": {},
364364
"source": [
365365
"The `cuLaunchKernel` function takes the compiled module kernel and execution\n",
@@ -374,7 +374,7 @@
374374
{
375375
"cell_type": "code",
376376
"execution_count": 11,
377-
"id": "ef1d6967",
377+
"id": "3adea158",
378378
"metadata": {},
379379
"outputs": [],
380380
"source": [
@@ -386,7 +386,7 @@
386386
},
387387
{
388388
"cell_type": "markdown",
389-
"id": "57ba691d",
389+
"id": "96dd7306",
390390
"metadata": {},
391391
"source": [
392392
"Perform verification of the data to ensure correctness and finish the code with\n",
@@ -396,7 +396,7 @@
396396
{
397397
"cell_type": "code",
398398
"execution_count": 12,
399-
"id": "4e0e5320",
399+
"id": "cd0c402e",
400400
"metadata": {},
401401
"outputs": [],
402402
"source": [
@@ -410,7 +410,7 @@
410410
},
411411
{
412412
"cell_type": "markdown",
413-
"id": "124b497f",
413+
"id": "d08fe6ce",
414414
"metadata": {},
415415
"source": [
416416
"## Performance\n",
@@ -485,7 +485,7 @@
485485
"name": "python",
486486
"nbconvert_exporter": "python",
487487
"pygments_lexer": "ipython3",
488-
"version": "3.12.5"
488+
"version": "3.12.8"
489489
},
490490
"source_map": [
491491
8,
34 Bytes
Binary file not shown.
Binary file not shown.
10 Bytes
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,4 @@ CUDA Python API Reference
99
module/driver
1010
module/runtime
1111
module/nvrtc
12+
module/nvjitlink
Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
nvjitlink
2+
=========
3+
4+
Functions
5+
---------
6+
7+
NvJitLink defines the following functions for linking code objects and querying the info and error logs.
8+
9+
.. autofunction:: cuda.bindings.nvjitlink.create
10+
.. autofunction:: cuda.bindings.nvjitlink.destroy
11+
.. autofunction:: cuda.bindings.nvjitlink.add_data
12+
.. autofunction:: cuda.bindings.nvjitlink.add_file
13+
.. autofunction:: cuda.bindings.nvjitlink.complete
14+
.. autofunction:: cuda.bindings.nvjitlink.get_linked_cubin_size
15+
.. autofunction:: cuda.bindings.nvjitlink.get_linked_cubin
16+
.. autofunction:: cuda.bindings.nvjitlink.get_linked_ptx_size
17+
.. autofunction:: cuda.bindings.nvjitlink.get_linked_ptx
18+
.. autofunction:: cuda.bindings.nvjitlink.get_error_log_size
19+
.. autofunction:: cuda.bindings.nvjitlink.get_error_log
20+
.. autofunction:: cuda.bindings.nvjitlink.get_info_log_size
21+
.. autofunction:: cuda.bindings.nvjitlink.get_info_log
22+
.. autofunction:: cuda.bindings.nvjitlink.version
23+
24+
Types
25+
---------
26+
.. autoclass:: cuda.bindings.nvjitlink.Result
27+
28+
.. autoattribute:: cuda.bindings.nvjitlink.Result.SUCCESS
29+
30+
31+
.. autoattribute:: cuda.bindings.nvjitlink.Result.ERROR_UNRECOGNIZED_OPTION
32+
33+
34+
.. autoattribute:: cuda.bindings.nvjitlink.Result.ERROR_MISSING_ARCH
35+
36+
37+
.. autoattribute:: cuda.bindings.nvjitlink.Result.ERROR_INVALID_INPUT
38+
39+
40+
.. autoattribute:: cuda.bindings.nvjitlink.Result.ERROR_PTX_COMPILE
41+
42+
43+
.. autoattribute:: cuda.bindings.nvjitlink.Result.ERROR_NVVM_COMPILE
44+
45+
46+
.. autoattribute:: cuda.bindings.nvjitlink.Result.ERROR_INTERNAL
47+
48+
49+
.. autoattribute:: cuda.bindings.nvjitlink.Result.ERROR_THREADPOOL
50+
51+
52+
.. autoattribute:: cuda.bindings.nvjitlink.Result.ERROR_UNRECOGNIZED_INPUT
53+
54+
55+
.. autoattribute:: cuda.bindings.nvjitlink.Result.ERROR_FINALIZE
56+
57+
58+
.. autoclass:: cuda.bindings.nvjitlink.InputType
59+
60+
.. autoattribute:: cuda.bindings.nvjitlink.InputType.NONE
61+
62+
63+
.. autoattribute:: cuda.bindings.nvjitlink.InputType.CUBIN
64+
65+
66+
.. autoattribute:: cuda.bindings.nvjitlink.InputType.PTX
67+
68+
69+
.. autoattribute:: cuda.bindings.nvjitlink.InputType.LTOIR
70+
71+
72+
.. autoattribute:: cuda.bindings.nvjitlink.InputType.FATBIN
73+
74+
75+
.. autoattribute:: cuda.bindings.nvjitlink.InputType.OBJECT
76+
77+
78+
.. autoattribute:: cuda.bindings.nvjitlink.InputType.LIBRARY
79+
80+
81+
.. autoattribute:: cuda.bindings.nvjitlink.InputType.INDEX
82+
83+
84+
.. autoattribute:: cuda.bindings.nvjitlink.InputType.ANY

docs/cuda-bindings/latest/_sources/release.md.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
maxdepth: 3
66
---
77

8+
12.x.y <release/12.x.y-notes>
89
12.6.2 <release/12.6.2-notes>
910
12.6.1 <release/12.6.1-notes>
1011
12.6.0 <release/12.6.0-notes>
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# CUDA Python 12.X.Y Release notes
2+
3+
Released on MM DD, 20YY.
4+
5+
## Highlights
6+
- Added bindings for nvJitLink. It requires nvJitLink from CUDA 12.3 or above.

docs/cuda-bindings/latest/api.html

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="driver" href="module/driver.html" /><link rel="prev" title="CUDA Python 11.4.0 Release notes" href="release/11.4.0-notes.html" />
77
<link rel="canonical" href="docs/api.html" />
88

9-
<!-- Generated with Sphinx 8.1.1 and Furo 2024.08.06 -->
9+
<!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
1010
<title>CUDA Python API Reference - cuda.bindings 12.6.2 documentation</title>
1111
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
1212
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" />
@@ -210,6 +210,7 @@
210210
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
211211
<li class="toctree-l1"><a class="reference internal" href="motivation.html">Motivation</a></li>
212212
<li class="toctree-l1 has-children"><a class="reference internal" href="release.html">Release Notes</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Release Notes</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
213+
<li class="toctree-l2"><a class="reference internal" href="release/12.x.y-notes.html"> 12.x.y</a></li>
213214
<li class="toctree-l2"><a class="reference internal" href="release/12.6.2-notes.html"> 12.6.2</a></li>
214215
<li class="toctree-l2"><a class="reference internal" href="release/12.6.1-notes.html"> 12.6.1</a></li>
215216
<li class="toctree-l2"><a class="reference internal" href="release/12.6.0-notes.html"> 12.6.0</a></li>
@@ -238,6 +239,7 @@
238239
<li class="toctree-l2"><a class="reference internal" href="module/driver.html">driver</a></li>
239240
<li class="toctree-l2"><a class="reference internal" href="module/runtime.html">runtime</a></li>
240241
<li class="toctree-l2"><a class="reference internal" href="module/nvrtc.html">nvrtc</a></li>
242+
<li class="toctree-l2"><a class="reference internal" href="module/nvjitlink.html">nvjitlink</a></li>
241243
</ul>
242244
</li>
243245
</ul>
@@ -1870,6 +1872,31 @@ <h1>CUDA Python API Reference<a class="headerlink" href="#cuda-python-api-refere
18701872
<li class="toctree-l2"><a class="reference internal" href="module/nvrtc.html#supported-compile-options">Supported Compile Options</a></li>
18711873
</ul>
18721874
</li>
1875+
<li class="toctree-l1"><a class="reference internal" href="module/nvjitlink.html">nvjitlink</a><ul>
1876+
<li class="toctree-l2"><a class="reference internal" href="module/nvjitlink.html#functions">Functions</a><ul>
1877+
<li class="toctree-l3"><a class="reference internal" href="module/nvjitlink.html#cuda.bindings.nvjitlink.create"><code class="docutils literal notranslate"><span class="pre">create()</span></code></a></li>
1878+
<li class="toctree-l3"><a class="reference internal" href="module/nvjitlink.html#cuda.bindings.nvjitlink.destroy"><code class="docutils literal notranslate"><span class="pre">destroy()</span></code></a></li>
1879+
<li class="toctree-l3"><a class="reference internal" href="module/nvjitlink.html#cuda.bindings.nvjitlink.add_data"><code class="docutils literal notranslate"><span class="pre">add_data()</span></code></a></li>
1880+
<li class="toctree-l3"><a class="reference internal" href="module/nvjitlink.html#cuda.bindings.nvjitlink.add_file"><code class="docutils literal notranslate"><span class="pre">add_file()</span></code></a></li>
1881+
<li class="toctree-l3"><a class="reference internal" href="module/nvjitlink.html#cuda.bindings.nvjitlink.complete"><code class="docutils literal notranslate"><span class="pre">complete()</span></code></a></li>
1882+
<li class="toctree-l3"><a class="reference internal" href="module/nvjitlink.html#cuda.bindings.nvjitlink.get_linked_cubin_size"><code class="docutils literal notranslate"><span class="pre">get_linked_cubin_size()</span></code></a></li>
1883+
<li class="toctree-l3"><a class="reference internal" href="module/nvjitlink.html#cuda.bindings.nvjitlink.get_linked_cubin"><code class="docutils literal notranslate"><span class="pre">get_linked_cubin()</span></code></a></li>
1884+
<li class="toctree-l3"><a class="reference internal" href="module/nvjitlink.html#cuda.bindings.nvjitlink.get_linked_ptx_size"><code class="docutils literal notranslate"><span class="pre">get_linked_ptx_size()</span></code></a></li>
1885+
<li class="toctree-l3"><a class="reference internal" href="module/nvjitlink.html#cuda.bindings.nvjitlink.get_linked_ptx"><code class="docutils literal notranslate"><span class="pre">get_linked_ptx()</span></code></a></li>
1886+
<li class="toctree-l3"><a class="reference internal" href="module/nvjitlink.html#cuda.bindings.nvjitlink.get_error_log_size"><code class="docutils literal notranslate"><span class="pre">get_error_log_size()</span></code></a></li>
1887+
<li class="toctree-l3"><a class="reference internal" href="module/nvjitlink.html#cuda.bindings.nvjitlink.get_error_log"><code class="docutils literal notranslate"><span class="pre">get_error_log()</span></code></a></li>
1888+
<li class="toctree-l3"><a class="reference internal" href="module/nvjitlink.html#cuda.bindings.nvjitlink.get_info_log_size"><code class="docutils literal notranslate"><span class="pre">get_info_log_size()</span></code></a></li>
1889+
<li class="toctree-l3"><a class="reference internal" href="module/nvjitlink.html#cuda.bindings.nvjitlink.get_info_log"><code class="docutils literal notranslate"><span class="pre">get_info_log()</span></code></a></li>
1890+
<li class="toctree-l3"><a class="reference internal" href="module/nvjitlink.html#cuda.bindings.nvjitlink.version"><code class="docutils literal notranslate"><span class="pre">version()</span></code></a></li>
1891+
</ul>
1892+
</li>
1893+
<li class="toctree-l2"><a class="reference internal" href="module/nvjitlink.html#types">Types</a><ul>
1894+
<li class="toctree-l3"><a class="reference internal" href="module/nvjitlink.html#cuda.bindings.nvjitlink.Result"><code class="docutils literal notranslate"><span class="pre">Result</span></code></a></li>
1895+
<li class="toctree-l3"><a class="reference internal" href="module/nvjitlink.html#cuda.bindings.nvjitlink.InputType"><code class="docutils literal notranslate"><span class="pre">InputType</span></code></a></li>
1896+
</ul>
1897+
</li>
1898+
</ul>
1899+
</li>
18731900
</ul>
18741901
</div>
18751902
</section>

0 commit comments

Comments
 (0)