Skip to content

Commit 4f23ae6

Browse files
author
cuda-python-bot
committed
Deploy doc preview for PR 2603 (a00f2da)
1 parent f4a8c78 commit 4f23ae6

264 files changed

Lines changed: 666 additions & 539 deletions

File tree

Some content is hidden

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

docs/pr-preview/pr-2603/cuda-bindings/latest/examples.html

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1302,65 +1302,65 @@
13021302
<section id="examples">
13031303
<h1>Examples<a class="headerlink" href="#examples" title="Link to this heading">#</a></h1>
13041304
<p>This page links to the <code class="docutils literal notranslate"><span class="pre">cuda.bindings</span></code> examples shipped in the
1305-
<a class="extlink-cuda-bindings-examples reference external" href="https://github.com/NVIDIA/cuda-python/tree/fe2da76c217fb5876532cd5306215acab93df947/cuda_bindings/examples/">cuda-python repository</a>.
1305+
<a class="extlink-cuda-bindings-examples reference external" href="https://github.com/NVIDIA/cuda-python/tree/a00f2da5732fd915a0384cadbe3d0441579bf677/cuda_bindings/examples/">cuda-python repository</a>.
13061306
Use it as a quick index when you want a runnable sample for a specific API area
13071307
or CUDA feature.</p>
13081308
<section id="introduction">
13091309
<h2>Introduction<a class="headerlink" href="#introduction" title="Link to this heading">#</a></h2>
13101310
<ul class="simple">
1311-
<li><p><a class="extlink-cuda-bindings-example reference external" href="https://github.com/NVIDIA/cuda-python/blob/fe2da76c217fb5876532cd5306215acab93df947/cuda_bindings/examples/0_Introduction/clock_nvrtc.py">clock_nvrtc.py</a>
1311+
<li><p><a class="extlink-cuda-bindings-example reference external" href="https://github.com/NVIDIA/cuda-python/blob/a00f2da5732fd915a0384cadbe3d0441579bf677/cuda_bindings/examples/0_Introduction/clock_nvrtc.py">clock_nvrtc.py</a>
13121312
uses NVRTC-compiled CUDA code and the device clock to time a reduction
13131313
kernel.</p></li>
1314-
<li><p><a class="extlink-cuda-bindings-example reference external" href="https://github.com/NVIDIA/cuda-python/blob/fe2da76c217fb5876532cd5306215acab93df947/cuda_bindings/examples/0_Introduction/simple_cubemap_texture.py">simple_cubemap_texture.py</a>
1314+
<li><p><a class="extlink-cuda-bindings-example reference external" href="https://github.com/NVIDIA/cuda-python/blob/a00f2da5732fd915a0384cadbe3d0441579bf677/cuda_bindings/examples/0_Introduction/simple_cubemap_texture.py">simple_cubemap_texture.py</a>
13151315
demonstrates cubemap texture sampling and transformation.</p></li>
1316-
<li><p><a class="extlink-cuda-bindings-example reference external" href="https://github.com/NVIDIA/cuda-python/blob/fe2da76c217fb5876532cd5306215acab93df947/cuda_bindings/examples/0_Introduction/simple_p2p.py">simple_p2p.py</a>
1316+
<li><p><a class="extlink-cuda-bindings-example reference external" href="https://github.com/NVIDIA/cuda-python/blob/a00f2da5732fd915a0384cadbe3d0441579bf677/cuda_bindings/examples/0_Introduction/simple_p2p.py">simple_p2p.py</a>
13171317
shows peer-to-peer memory access and transfers between multiple GPUs.</p></li>
1318-
<li><p><a class="extlink-cuda-bindings-example reference external" href="https://github.com/NVIDIA/cuda-python/blob/fe2da76c217fb5876532cd5306215acab93df947/cuda_bindings/examples/0_Introduction/simple_zero_copy.py">simple_zero_copy.py</a>
1318+
<li><p><a class="extlink-cuda-bindings-example reference external" href="https://github.com/NVIDIA/cuda-python/blob/a00f2da5732fd915a0384cadbe3d0441579bf677/cuda_bindings/examples/0_Introduction/simple_zero_copy.py">simple_zero_copy.py</a>
13191319
uses zero-copy mapped host memory for vector addition.</p></li>
1320-
<li><p><a class="extlink-cuda-bindings-example reference external" href="https://github.com/NVIDIA/cuda-python/blob/fe2da76c217fb5876532cd5306215acab93df947/cuda_bindings/examples/0_Introduction/system_wide_atomics.py">system_wide_atomics.py</a>
1320+
<li><p><a class="extlink-cuda-bindings-example reference external" href="https://github.com/NVIDIA/cuda-python/blob/a00f2da5732fd915a0384cadbe3d0441579bf677/cuda_bindings/examples/0_Introduction/system_wide_atomics.py">system_wide_atomics.py</a>
13211321
demonstrates system-wide atomic operations on managed memory.</p></li>
1322-
<li><p><a class="extlink-cuda-bindings-example reference external" href="https://github.com/NVIDIA/cuda-python/blob/fe2da76c217fb5876532cd5306215acab93df947/cuda_bindings/examples/0_Introduction/vector_add_drv.py">vector_add_drv.py</a>
1322+
<li><p><a class="extlink-cuda-bindings-example reference external" href="https://github.com/NVIDIA/cuda-python/blob/a00f2da5732fd915a0384cadbe3d0441579bf677/cuda_bindings/examples/0_Introduction/vector_add_drv.py">vector_add_drv.py</a>
13231323
uses the CUDA Driver API and unified virtual addressing for vector addition.</p></li>
1324-
<li><p><a class="extlink-cuda-bindings-example reference external" href="https://github.com/NVIDIA/cuda-python/blob/fe2da76c217fb5876532cd5306215acab93df947/cuda_bindings/examples/0_Introduction/vector_add_mmap.py">vector_add_mmap.py</a>
1324+
<li><p><a class="extlink-cuda-bindings-example reference external" href="https://github.com/NVIDIA/cuda-python/blob/a00f2da5732fd915a0384cadbe3d0441579bf677/cuda_bindings/examples/0_Introduction/vector_add_mmap.py">vector_add_mmap.py</a>
13251325
uses virtual memory management APIs such as <code class="docutils literal notranslate"><span class="pre">cuMemCreate</span></code> and
13261326
<code class="docutils literal notranslate"><span class="pre">cuMemMap</span></code> for vector addition.</p></li>
13271327
</ul>
13281328
</section>
13291329
<section id="concepts-and-techniques">
13301330
<h2>Concepts and techniques<a class="headerlink" href="#concepts-and-techniques" title="Link to this heading">#</a></h2>
13311331
<ul class="simple">
1332-
<li><p><a class="extlink-cuda-bindings-example reference external" href="https://github.com/NVIDIA/cuda-python/blob/fe2da76c217fb5876532cd5306215acab93df947/cuda_bindings/examples/2_Concepts_and_Techniques/stream_ordered_allocation.py">stream_ordered_allocation.py</a>
1332+
<li><p><a class="extlink-cuda-bindings-example reference external" href="https://github.com/NVIDIA/cuda-python/blob/a00f2da5732fd915a0384cadbe3d0441579bf677/cuda_bindings/examples/2_Concepts_and_Techniques/stream_ordered_allocation.py">stream_ordered_allocation.py</a>
13331333
demonstrates <code class="docutils literal notranslate"><span class="pre">cudaMallocAsync</span></code> and <code class="docutils literal notranslate"><span class="pre">cudaFreeAsync</span></code> together with
13341334
memory-pool release thresholds.</p></li>
13351335
</ul>
13361336
</section>
13371337
<section id="cuda-features">
13381338
<h2>CUDA features<a class="headerlink" href="#cuda-features" title="Link to this heading">#</a></h2>
13391339
<ul class="simple">
1340-
<li><p><a class="extlink-cuda-bindings-example reference external" href="https://github.com/NVIDIA/cuda-python/blob/fe2da76c217fb5876532cd5306215acab93df947/cuda_bindings/examples/3_CUDA_Features/global_to_shmem_async_copy.py">global_to_shmem_async_copy.py</a>
1340+
<li><p><a class="extlink-cuda-bindings-example reference external" href="https://github.com/NVIDIA/cuda-python/blob/a00f2da5732fd915a0384cadbe3d0441579bf677/cuda_bindings/examples/3_CUDA_Features/global_to_shmem_async_copy.py">global_to_shmem_async_copy.py</a>
13411341
compares asynchronous global-to-shared-memory copy strategies in matrix
13421342
multiplication kernels.</p></li>
1343-
<li><p><a class="extlink-cuda-bindings-example reference external" href="https://github.com/NVIDIA/cuda-python/blob/fe2da76c217fb5876532cd5306215acab93df947/cuda_bindings/examples/3_CUDA_Features/simple_cuda_graphs.py">simple_cuda_graphs.py</a>
1343+
<li><p><a class="extlink-cuda-bindings-example reference external" href="https://github.com/NVIDIA/cuda-python/blob/a00f2da5732fd915a0384cadbe3d0441579bf677/cuda_bindings/examples/3_CUDA_Features/simple_cuda_graphs.py">simple_cuda_graphs.py</a>
13441344
shows both manual CUDA graph construction and stream-capture-based replay.</p></li>
13451345
</ul>
13461346
</section>
13471347
<section id="libraries-and-tools">
13481348
<h2>Libraries and tools<a class="headerlink" href="#libraries-and-tools" title="Link to this heading">#</a></h2>
13491349
<ul class="simple">
1350-
<li><p><a class="extlink-cuda-bindings-example reference external" href="https://github.com/NVIDIA/cuda-python/blob/fe2da76c217fb5876532cd5306215acab93df947/cuda_bindings/examples/4_CUDA_Libraries/conjugate_gradient_multi_block_cg.py">conjugate_gradient_multi_block_cg.py</a>
1350+
<li><p><a class="extlink-cuda-bindings-example reference external" href="https://github.com/NVIDIA/cuda-python/blob/a00f2da5732fd915a0384cadbe3d0441579bf677/cuda_bindings/examples/4_CUDA_Libraries/conjugate_gradient_multi_block_cg.py">conjugate_gradient_multi_block_cg.py</a>
13511351
implements a conjugate-gradient solver with cooperative groups and
13521352
multi-block synchronization.</p></li>
1353-
<li><p><a class="extlink-cuda-bindings-example reference external" href="https://github.com/NVIDIA/cuda-python/blob/fe2da76c217fb5876532cd5306215acab93df947/cuda_bindings/examples/4_CUDA_Libraries/nvidia_smi.py">nvidia_smi.py</a>
1353+
<li><p><a class="extlink-cuda-bindings-example reference external" href="https://github.com/NVIDIA/cuda-python/blob/a00f2da5732fd915a0384cadbe3d0441579bf677/cuda_bindings/examples/4_CUDA_Libraries/nvidia_smi.py">nvidia_smi.py</a>
13541354
uses NVML to implement a Python subset of <code class="docutils literal notranslate"><span class="pre">nvidia-smi</span></code>.</p></li>
13551355
</ul>
13561356
</section>
13571357
<section id="advanced-and-interoperability">
13581358
<h2>Advanced and interoperability<a class="headerlink" href="#advanced-and-interoperability" title="Link to this heading">#</a></h2>
13591359
<ul class="simple">
1360-
<li><p><a class="extlink-cuda-bindings-example reference external" href="https://github.com/NVIDIA/cuda-python/blob/fe2da76c217fb5876532cd5306215acab93df947/cuda_bindings/examples/extra/iso_fd_modelling.py">iso_fd_modelling.py</a>
1360+
<li><p><a class="extlink-cuda-bindings-example reference external" href="https://github.com/NVIDIA/cuda-python/blob/a00f2da5732fd915a0384cadbe3d0441579bf677/cuda_bindings/examples/extra/iso_fd_modelling.py">iso_fd_modelling.py</a>
13611361
runs isotropic finite-difference wave propagation across multiple GPUs with
13621362
peer-to-peer halo exchange.</p></li>
1363-
<li><p><a class="extlink-cuda-bindings-example reference external" href="https://github.com/NVIDIA/cuda-python/blob/fe2da76c217fb5876532cd5306215acab93df947/cuda_bindings/examples/extra/jit_program.py">jit_program.py</a>
1363+
<li><p><a class="extlink-cuda-bindings-example reference external" href="https://github.com/NVIDIA/cuda-python/blob/a00f2da5732fd915a0384cadbe3d0441579bf677/cuda_bindings/examples/extra/jit_program.py">jit_program.py</a>
13641364
JIT-compiles a SAXPY kernel with NVRTC and launches it through the Driver
13651365
API.</p></li>
13661366
</ul>

docs/pr-preview/pr-2603/cuda-bindings/latest/license.html

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1474,6 +1474,31 @@ <h1>Apache License 2.0<a class="headerlink" href="#apache-license-2-0" title="Li
14741474
of your accepting any such warranty or additional liability.
14751475

14761476
END OF TERMS AND CONDITIONS
1477+
1478+
APPENDIX: How to apply the Apache License to your work.
1479+
1480+
To apply the Apache License to your work, attach the following
1481+
boilerplate notice, with the fields enclosed by brackets &quot;[]&quot;
1482+
replaced with your own identifying information. (Don&#39;t include
1483+
the brackets!) The text should be enclosed in the appropriate
1484+
comment syntax for the file format. We also recommend that a
1485+
file or class name and description of purpose be included on the
1486+
same &quot;printed page&quot; as the copyright notice for easier
1487+
identification within third-party archives.
1488+
1489+
Copyright [yyyy] [name of copyright owner]
1490+
1491+
Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);
1492+
you may not use this file except in compliance with the License.
1493+
You may obtain a copy of the License at
1494+
1495+
http://www.apache.org/licenses/LICENSE-2.0
1496+
1497+
Unless required by applicable law or agreed to in writing, software
1498+
distributed under the License is distributed on an &quot;AS IS&quot; BASIS,
1499+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1500+
See the License for the specific language governing permissions and
1501+
limitations under the License.
14771502
</pre></div>
14781503
</div>
14791504
</section>

docs/pr-preview/pr-2603/cuda-bindings/latest/overview.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1786,7 +1786,7 @@ <h3>Using ctypes<a class="headerlink" href="#using-ctypes" title="Link to this h
17861786
<h3>CUDA objects<a class="headerlink" href="#cuda-objects" title="Link to this heading">#</a></h3>
17871787
<p>Certain CUDA kernels use native CUDA types as their parameters such as <code class="docutils literal notranslate"><span class="pre">cudaTextureObject_t</span></code>. These types require special handling since they’re neither a primitive ctype nor a custom user type. Since <code class="docutils literal notranslate"><span class="pre">cuda.bindings</span></code> exposes each of them as Python classes, they each implement <code class="docutils literal notranslate"><span class="pre">getPtr()</span></code> and <code class="docutils literal notranslate"><span class="pre">__int__()</span></code>. These two callables used to support the NumPy and ctypes approach. The difference between each call is further described under <a class="reference external" href="https://nvidia.github.io/cuda-python/cuda-bindings/latest/tips_and_tricks.html#">Tips and Tricks</a>.</p>
17881788
<p>For this example, lets use the <code class="docutils literal notranslate"><span class="pre">transformKernel</span></code> from
1789-
<a class="extlink-cuda-bindings-example reference external" href="https://github.com/NVIDIA/cuda-python/blob/fe2da76c217fb5876532cd5306215acab93df947/cuda_bindings/examples/0_Introduction/simple_cubemap_texture.py">simple_cubemap_texture.py</a>.
1789+
<a class="extlink-cuda-bindings-example reference external" href="https://github.com/NVIDIA/cuda-python/blob/a00f2da5732fd915a0384cadbe3d0441579bf677/cuda_bindings/examples/0_Introduction/simple_cubemap_texture.py">simple_cubemap_texture.py</a>.
17901790
The <a class="reference internal" href="examples.html"><span class="doc">Examples</span></a> page links to more samples covering textures, graphs,
17911791
memory mapping, and multi-GPU workflows.</p>
17921792
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">simpleCubemapTexture</span> <span class="o">=</span> <span class="s2">&quot;&quot;&quot;</span><span class="se">\</span>

docs/pr-preview/pr-2603/cuda-bindings/latest/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: c608aa84bbd5a4a3848166d5fbf1329e
3+
config: 4bc8fbc1b7486e07d3c4f3c8d754f07a
44
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

0 commit comments

Comments
 (0)