build based on 51688ed

JuliaGPU · Aug 4, 2023 · fdb130c · fdb130c
1 parent b7f5e86
commit fdb130c
Show file tree

Hide file tree

Showing 28 changed files with 980 additions and 0 deletions.
diff --git a/previews/PR456/api/index.html b/previews/PR456/api/index.html
@@ -0,0 +1,2 @@
+<!DOCTYPE html>
+<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API Reference · AMDGPU.jl</title><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../"><img src="../assets/logo.png" alt="AMDGPU.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">AMDGPU.jl</a></span></div><form class="docs-search" action="../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><a class="tocitem" href="../quickstart/">Quick Start</a></li><li><a class="tocitem" href="../devices/">Devices</a></li><li><a class="tocitem" href="../streams/">Streams</a></li><li><a class="tocitem" href="../kernel_launch/">Kernel Launch</a></li><li><a class="tocitem" href="../exceptions/">Exceptions</a></li><li><a class="tocitem" href="../profiling/">Profiling</a></li><li><a class="tocitem" href="../memory/">Memory</a></li><li><a class="tocitem" href="../hostcall/">Host-Call</a></li><li><span class="tocitem">Intrinsics</span><ul><li><a class="tocitem" href="../execution_control/">Execution Control</a></li><li><a class="tocitem" href="../wavefront_ops/">Wavefront Operations</a></li></ul></li><li><a class="tocitem" href="../printing/">Printing</a></li><li><a class="tocitem" href="../logging/">Logging</a></li><li class="is-active"><a class="tocitem" href>API Reference</a><ul class="internal"><li><a class="tocitem" href="#Kernel-launching"><span>Kernel launching</span></a></li><li><a class="tocitem" href="#Device-code-API"><span>Device code API</span></a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>API Reference</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>API Reference</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/JuliaGPU/AMDGPU.jl/blob/master/docs/src/api.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="AMDGPU-API-Reference"><a class="docs-heading-anchor" href="#AMDGPU-API-Reference">AMDGPU API Reference</a><a id="AMDGPU-API-Reference-1"></a><a class="docs-heading-anchor-permalink" href="#AMDGPU-API-Reference" title="Permalink"></a></h1><h2 id="Kernel-launching"><a class="docs-heading-anchor" href="#Kernel-launching">Kernel launching</a><a id="Kernel-launching-1"></a><a class="docs-heading-anchor-permalink" href="#Kernel-launching" title="Permalink"></a></h2><div class="admonition is-warning"><header class="admonition-header">Missing docstring.</header><div class="admonition-body"><p>Missing docstring for <code>@roc</code>. Check Documenter&#39;s build log for details.</p></div></div><div class="admonition is-warning"><header class="admonition-header">Missing docstring.</header><div class="admonition-body"><p>Missing docstring for <code>AMDGPU.AbstractKernel</code>. Check Documenter&#39;s build log for details.</p></div></div><div class="admonition is-warning"><header class="admonition-header">Missing docstring.</header><div class="admonition-body"><p>Missing docstring for <code>AMDGPU.HostKernel</code>. Check Documenter&#39;s build log for details.</p></div></div><div class="admonition is-warning"><header class="admonition-header">Missing docstring.</header><div class="admonition-body"><p>Missing docstring for <code>AMDGPU.rocfunction</code>. Check Documenter&#39;s build log for details.</p></div></div><h2 id="Device-code-API"><a class="docs-heading-anchor" href="#Device-code-API">Device code API</a><a id="Device-code-API-1"></a><a class="docs-heading-anchor-permalink" href="#Device-code-API" title="Permalink"></a></h2><h3 id="Thread-indexing"><a class="docs-heading-anchor" href="#Thread-indexing">Thread indexing</a><a id="Thread-indexing-1"></a><a class="docs-heading-anchor-permalink" href="#Thread-indexing" title="Permalink"></a></h3><h4 id="HSA-nomenclature"><a class="docs-heading-anchor" href="#HSA-nomenclature">HSA nomenclature</a><a id="HSA-nomenclature-1"></a><a class="docs-heading-anchor-permalink" href="#HSA-nomenclature" title="Permalink"></a></h4><article class="docstring"><header><a class="docstring-binding" id="AMDGPU.Device.workitemIdx" href="#AMDGPU.Device.workitemIdx"><code>AMDGPU.Device.workitemIdx</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">workitemIdx()::ROCDim3</code></pre><p>Returns the work item index within the work group. See also: <a href="#AMDGPU.Device.threadIdx"><code>threadIdx</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGPU/AMDGPU.jl/blob/51688ed002dc2dd49adc6b2b7f46b82579546ff7/src/device/gcn/indexing.jl#L116-L121">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="AMDGPU.Device.workgroupIdx" href="#AMDGPU.Device.workgroupIdx"><code>AMDGPU.Device.workgroupIdx</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">workgroupIdx()::ROCDim3</code></pre><p>Returns the work group index. See also: <a href="#AMDGPU.Device.blockIdx"><code>blockIdx</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGPU/AMDGPU.jl/blob/51688ed002dc2dd49adc6b2b7f46b82579546ff7/src/device/gcn/indexing.jl#L124-L129">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="AMDGPU.Device.workgroupDim" href="#AMDGPU.Device.workgroupDim"><code>AMDGPU.Device.workgroupDim</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">workgroupDim()::ROCDim3</code></pre><p>Returns the size of each workgroup in workitems. See also: <a href="#AMDGPU.Device.blockDim"><code>blockDim</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGPU/AMDGPU.jl/blob/51688ed002dc2dd49adc6b2b7f46b82579546ff7/src/device/gcn/indexing.jl#L132-L137">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="AMDGPU.Device.gridItemDim" href="#AMDGPU.Device.gridItemDim"><code>AMDGPU.Device.gridItemDim</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">gridItemDim()::ROCDim3</code></pre><p>Returns the size of the grid in workitems. This behaviour is different from CUDA where <code>gridDim</code> gives the size of the grid in blocks.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGPU/AMDGPU.jl/blob/51688ed002dc2dd49adc6b2b7f46b82579546ff7/src/device/gcn/indexing.jl#L140-L145">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="AMDGPU.Device.gridGroupDim" href="#AMDGPU.Device.gridGroupDim"><code>AMDGPU.Device.gridGroupDim</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">gridGroupDim()::ROCDim3</code></pre><p>Returns the size of the grid in workgroups. This is equivalent to CUDA&#39;s <code>gridDim</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGPU/AMDGPU.jl/blob/51688ed002dc2dd49adc6b2b7f46b82579546ff7/src/device/gcn/indexing.jl#L148-L153">source</a></section></article><h4 id="CUDA-nomenclature"><a class="docs-heading-anchor" href="#CUDA-nomenclature">CUDA nomenclature</a><a id="CUDA-nomenclature-1"></a><a class="docs-heading-anchor-permalink" href="#CUDA-nomenclature" title="Permalink"></a></h4><p>Use these functions for compatibility with CUDA.jl.</p><article class="docstring"><header><a class="docstring-binding" id="AMDGPU.Device.threadIdx" href="#AMDGPU.Device.threadIdx"><code>AMDGPU.Device.threadIdx</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">threadIdx()::ROCDim3</code></pre><p>Returns the thread index within the block. See also: <a href="#AMDGPU.Device.workitemIdx"><code>workitemIdx</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGPU/AMDGPU.jl/blob/51688ed002dc2dd49adc6b2b7f46b82579546ff7/src/device/gcn/indexing.jl#L158-L163">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="AMDGPU.Device.blockIdx" href="#AMDGPU.Device.blockIdx"><code>AMDGPU.Device.blockIdx</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">blockIdx()::ROCDim3</code></pre><p>Returns the block index within the grid. See also: <a href="#AMDGPU.Device.workgroupIdx"><code>workgroupIdx</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGPU/AMDGPU.jl/blob/51688ed002dc2dd49adc6b2b7f46b82579546ff7/src/device/gcn/indexing.jl#L166-L171">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="AMDGPU.Device.blockDim" href="#AMDGPU.Device.blockDim"><code>AMDGPU.Device.blockDim</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">blockDim()::ROCDim3</code></pre><p>Returns the dimensions of the block. See also: <a href="#AMDGPU.Device.workgroupDim"><code>workgroupDim</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGPU/AMDGPU.jl/blob/51688ed002dc2dd49adc6b2b7f46b82579546ff7/src/device/gcn/indexing.jl#L174-L179">source</a></section></article><h3 id="Synchronization"><a class="docs-heading-anchor" href="#Synchronization">Synchronization</a><a id="Synchronization-1"></a><a class="docs-heading-anchor-permalink" href="#Synchronization" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-binding" id="AMDGPU.Device.sync_workgroup" href="#AMDGPU.Device.sync_workgroup"><code>AMDGPU.Device.sync_workgroup</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">sync_workgroup()</code></pre><p>Waits until all wavefronts in a workgroup have reached this call.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGPU/AMDGPU.jl/blob/51688ed002dc2dd49adc6b2b7f46b82579546ff7/src/device/gcn/synchronization.jl#L1-L5">source</a></section></article><h3 id="Global-Variables"><a class="docs-heading-anchor" href="#Global-Variables">Global Variables</a><a id="Global-Variables-1"></a><a class="docs-heading-anchor-permalink" href="#Global-Variables" title="Permalink"></a></h3><div class="admonition is-warning"><header class="admonition-header">Missing docstring.</header><div class="admonition-body"><p>Missing docstring for <code>AMDGPU.Device.get_global_pointer</code>. Check Documenter&#39;s build log for details.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../logging/">« Logging</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Friday 4 August 2023 18:41">Friday 4 August 2023</span>. Using Julia version 1.9.3-DEV.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>