Skip to content

Commit fa26907

Browse files
author
cuda-python-bot
committed
Deploy latest docs: b9c76b3
1 parent 0294b49 commit fa26907

8 files changed

+50
-24
lines changed

docs/cuda-core/latest/api.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -579,7 +579,7 @@ <h2>CUDA runtime<a class="headerlink" href="#cuda-runtime" title="Link to this h
579579
<tr class="row-odd"><td><p><a class="reference internal" href="generated/cuda.core.experimental.GraphBuilder.html#cuda.core.experimental.GraphBuilder" title="cuda.core.experimental.GraphBuilder"><code class="xref py py-obj docutils literal notranslate"><span class="pre">GraphBuilder</span></code></a>()</p></td>
580580
<td><p>Represents a graph under construction.</p></td>
581581
</tr>
582-
<tr class="row-even"><td><p><a class="reference internal" href="generated/cuda.core.experimental.launch.html#cuda.core.experimental.launch" title="cuda.core.experimental.launch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">launch</span></code></a>(stream, IsStreamT], ...)</p></td>
582+
<tr class="row-even"><td><p><a class="reference internal" href="generated/cuda.core.experimental.launch.html#cuda.core.experimental.launch" title="cuda.core.experimental.launch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">launch</span></code></a>(stream, LaunchConfig config, kernel, ...)</p></td>
583583
<td><p>Launches a <a class="reference internal" href="generated/cuda.core.experimental.Kernel.html#cuda.core.experimental.Kernel" title="cuda.core.experimental._module.Kernel"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Kernel</span></code></a> object with launch-time configuration.</p></td>
584584
</tr>
585585
<tr class="row-odd"><td><p><a class="reference internal" href="generated/cuda.core.experimental.Buffer.html#cuda.core.experimental.Buffer" title="cuda.core.experimental.Buffer"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Buffer</span></code></a>(*args, **kwargs)</p></td>
@@ -595,7 +595,7 @@ <h2>CUDA runtime<a class="headerlink" href="#cuda-runtime" title="Link to this h
595595
<td><p>Abstract base class for memory resources that manage allocation and deallocation of buffers.</p></td>
596596
</tr>
597597
<tr class="row-odd"><td><p><a class="reference internal" href="generated/cuda.core.experimental.DeviceMemoryResource.html#cuda.core.experimental.DeviceMemoryResource" title="cuda.core.experimental.DeviceMemoryResource"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DeviceMemoryResource</span></code></a>(device_id[, options])</p></td>
598-
<td><p>Create a device memory resource managing a stream-ordered memory pool.</p></td>
598+
<td><p>A device memory resource managing a stream-ordered memory pool.</p></td>
599599
</tr>
600600
<tr class="row-even"><td><p><a class="reference internal" href="generated/cuda.core.experimental.LegacyPinnedMemoryResource.html#cuda.core.experimental.LegacyPinnedMemoryResource" title="cuda.core.experimental.LegacyPinnedMemoryResource"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LegacyPinnedMemoryResource</span></code></a></p></td>
601601
<td><p>Create a pinned memory resource that uses legacy cuMemAllocHost/cudaMallocHost APIs.</p></td>

docs/cuda-core/latest/generated/cuda.core.experimental.Buffer.html

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -582,27 +582,36 @@ <h1>cuda.core.experimental.Buffer<a class="headerlink" href="#cuda-core-experime
582582

583583
<dl class="py method">
584584
<dt class="sig sig-object py" id="cuda.core.experimental.Buffer.close">
585-
<span class="sig-name descname"><span class="pre">close</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Stream</span> <span class="pre">stream:</span> <span class="pre">Stream</span> <span class="pre">=</span> <span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cuda.core.experimental.Buffer.close" title="Link to this definition">#</a></dt>
585+
<span class="sig-name descname"><span class="pre">close</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stream</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cuda.core.experimental.Stream.html#cuda.core.experimental.Stream" title="cuda.core.experimental.Stream"><span class="pre">Stream</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="cuda.core.experimental.GraphBuilder.html#cuda.core.experimental.GraphBuilder" title="cuda.core.experimental.GraphBuilder"><span class="pre">GraphBuilder</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cuda.core.experimental.Buffer.close" title="Link to this definition">#</a></dt>
586586
<dd><p>Deallocate this buffer asynchronously on the given stream.</p>
587587
<p>This buffer is released back to their memory resource
588588
asynchronously on the given stream.</p>
589589
<dl class="field-list simple">
590590
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
591-
<dd class="field-odd"><p><strong>stream</strong> (<a class="reference internal" href="cuda.core.experimental.Stream.html#cuda.core.experimental.Stream" title="cuda.core.experimental.Stream"><em>Stream</em></a><em>, </em><em>optional</em>) – The stream object to use for asynchronous deallocation. If None,
591+
<dd class="field-odd"><p><strong>stream</strong> (<a class="reference internal" href="cuda.core.experimental.Stream.html#cuda.core.experimental.Stream" title="cuda.core.experimental._stream.Stream"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Stream</span></code></a> | <a class="reference internal" href="cuda.core.experimental.GraphBuilder.html#cuda.core.experimental.GraphBuilder" title="cuda.core.experimental._graph.GraphBuilder"><code class="xref py py-obj docutils literal notranslate"><span class="pre">GraphBuilder</span></code></a>, optional) – The stream object to use for asynchronous deallocation. If None,
592592
the behavior depends on the underlying memory resource.</p>
593593
</dd>
594594
</dl>
595595
</dd></dl>
596596

597597
<dl class="py method">
598598
<dt class="sig sig-object py" id="cuda.core.experimental.Buffer.copy_from">
599-
<span class="sig-name descname"><span class="pre">copy_from</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Buffer</span> <span class="pre">src:</span> <span class="pre">Buffer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Stream</span> <span class="pre">stream:</span> <span class="pre">Stream</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cuda.core.experimental.Buffer.copy_from" title="Link to this definition">#</a></dt>
599+
<span class="sig-name descname"><span class="pre">copy_from</span></span><span class="sig-paren">(</span>
600+
601+
<dl>
602+
<dd><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>,</dd>
603+
<dd><em class="sig-param"><span class="n"><span class="pre">Buffer</span> <span class="pre">src:</span> <span class="pre">Buffer</span></span></em>,</dd>
604+
<dd><em class="sig-param"><span class="n"><span class="pre">*</span></span></em>,</dd>
605+
<dd><em class="sig-param"><span class="n"><span class="pre">stream:</span> <span class="pre">Stream</span> <span class="pre">|</span> <span class="pre">GraphBuilder</span></span></em>,</dd>
606+
</dl>
607+
608+
<span class="sig-paren">)</span><a class="headerlink" href="#cuda.core.experimental.Buffer.copy_from" title="Link to this definition">#</a></dt>
600609
<dd><p>Copy from the src buffer to this buffer asynchronously on the given stream.</p>
601610
<dl class="field-list simple">
602611
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
603612
<dd class="field-odd"><ul class="simple">
604613
<li><p><strong>src</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Buffer</span></code>) – Source buffer to copy data from</p></li>
605-
<li><p><strong>stream</strong> (<a class="reference internal" href="cuda.core.experimental.Stream.html#cuda.core.experimental.Stream" title="cuda.core.experimental.Stream"><em>Stream</em></a>) – Keyword argument specifying the stream for the
614+
<li><p><strong>stream</strong> (<a class="reference internal" href="cuda.core.experimental.Stream.html#cuda.core.experimental.Stream" title="cuda.core.experimental._stream.Stream"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Stream</span></code></a> | <a class="reference internal" href="cuda.core.experimental.GraphBuilder.html#cuda.core.experimental.GraphBuilder" title="cuda.core.experimental._graph.GraphBuilder"><code class="xref py py-obj docutils literal notranslate"><span class="pre">GraphBuilder</span></code></a>) – Keyword argument specifying the stream for the
606615
asynchronous copy</p></li>
607616
</ul>
608617
</dd>
@@ -617,7 +626,7 @@ <h1>cuda.core.experimental.Buffer<a class="headerlink" href="#cuda-core-experime
617626
<dd><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>,</dd>
618627
<dd><em class="sig-param"><span class="n"><span class="pre">Buffer</span> <span class="pre">dst:</span> <span class="pre">Buffer</span> <span class="pre">=</span> <span class="pre">None</span></span></em>,</dd>
619628
<dd><em class="sig-param"><span class="n"><span class="pre">*</span></span></em>,</dd>
620-
<dd><em class="sig-param"><span class="n"><span class="pre">Stream</span> <span class="pre">stream:</span> <span class="pre">Stream</span></span></em>,</dd>
629+
<dd><em class="sig-param"><span class="n"><span class="pre">stream:</span> <span class="pre">Stream</span> <span class="pre">|</span> <span class="pre">GraphBuilder</span></span></em>,</dd>
621630
</dl>
622631

623632
<span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cuda.core.experimental.Buffer" title="cuda.core.experimental.Buffer"><span class="pre">Buffer</span></a></span></span><a class="headerlink" href="#cuda.core.experimental.Buffer.copy_to" title="Link to this definition">#</a></dt>
@@ -629,7 +638,7 @@ <h1>cuda.core.experimental.Buffer<a class="headerlink" href="#cuda-core-experime
629638
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
630639
<dd class="field-odd"><ul class="simple">
631640
<li><p><strong>dst</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Buffer</span></code>) – Source buffer to copy data from</p></li>
632-
<li><p><strong>stream</strong> (<a class="reference internal" href="cuda.core.experimental.Stream.html#cuda.core.experimental.Stream" title="cuda.core.experimental.Stream"><em>Stream</em></a>) – Keyword argument specifying the stream for the
641+
<li><p><strong>stream</strong> (<a class="reference internal" href="cuda.core.experimental.Stream.html#cuda.core.experimental.Stream" title="cuda.core.experimental._stream.Stream"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Stream</span></code></a> | <a class="reference internal" href="cuda.core.experimental.GraphBuilder.html#cuda.core.experimental.GraphBuilder" title="cuda.core.experimental._graph.GraphBuilder"><code class="xref py py-obj docutils literal notranslate"><span class="pre">GraphBuilder</span></code></a>) – Keyword argument specifying the stream for the
633642
asynchronous copy</p></li>
634643
</ul>
635644
</dd>

docs/cuda-core/latest/generated/cuda.core.experimental.Device.html

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -597,7 +597,15 @@ <h1>cuda.core.experimental.Device<a class="headerlink" href="#cuda-core-experime
597597

598598
<dl class="py method">
599599
<dt class="sig sig-object py" id="cuda.core.experimental.Device.allocate">
600-
<span class="sig-name descname"><span class="pre">allocate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">size</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stream</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cuda.core.experimental.Stream.html#cuda.core.experimental.Stream" title="cuda.core.experimental.Stream"><span class="pre">Stream</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="cuda.core.experimental.Buffer.html#cuda.core.experimental.Buffer" title="cuda.core.experimental.Buffer"><span class="pre">Buffer</span></a></span></span><a class="headerlink" href="#cuda.core.experimental.Device.allocate" title="Link to this definition">#</a></dt>
600+
<span class="sig-name descname"><span class="pre">allocate</span></span><span class="sig-paren">(</span>
601+
602+
<dl>
603+
<dd><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>,</dd>
604+
<dd><em class="sig-param"><span class="n"><span class="pre">size</span></span></em>,</dd>
605+
<dd><em class="sig-param"><span class="n"><span class="pre">stream</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cuda.core.experimental.Stream.html#cuda.core.experimental.Stream" title="cuda.core.experimental.Stream"><span class="pre">Stream</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="cuda.core.experimental.GraphBuilder.html#cuda.core.experimental.GraphBuilder" title="cuda.core.experimental.GraphBuilder"><span class="pre">GraphBuilder</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>,</dd>
606+
</dl>
607+
608+
<span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="cuda.core.experimental.Buffer.html#cuda.core.experimental.Buffer" title="cuda.core.experimental.Buffer"><span class="pre">Buffer</span></a></span></span><a class="headerlink" href="#cuda.core.experimental.Device.allocate" title="Link to this definition">#</a></dt>
601609
<dd><p>Allocate device memory from a specified stream.</p>
602610
<p>Allocates device memory of <cite>size</cite> bytes on the specified <cite>stream</cite>
603611
using the memory resource currently associated with this Device.</p>

0 commit comments

Comments
 (0)