Skip to content

Commit

Permalink
build based on db95b0a
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Jul 26, 2023
1 parent 8eb5bfd commit e175510
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
10 changes: 5 additions & 5 deletions dev/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -477,7 +477,7 @@ <h3 id="preferences">Preferences<a class="headerlink" href="#preferences" title=
<p>Creates a <code>LocalPreferences.toml</code> file with the desired GPU backend.</p>
<p>If <code>backend == ""</code>, then the <code>gpu_backend</code> preference is deleted. Otherwise, <code>backend</code> is validated to be one of the possible backends and the preference is set to <code>backend</code>.</p>
<p>If a new backend is successfully set, then the Julia session must be restarted for the change to take effect.</p>
<p><a target='_blank' href='https://github.com/LuxDL/LuxDeviceUtils.jl/blob/10ccab161765cf1a534791836db4a531aa240f97/src/LuxDeviceUtils.jl#L168-L181' class='documenter-source'>source</a><br></p>
<p><a target='_blank' href='https://github.com/LuxDL/LuxDeviceUtils.jl/blob/db95b0a949a839f0b0e06d1981533f56e2e09b4a/src/LuxDeviceUtils.jl#L159-L172' class='documenter-source'>source</a><br></p>
<p><a id='Data-Transfer'></a></p>
<p><a id='Data-Transfer-1'></a></p>
<h3 id="data-transfer">Data Transfer<a class="headerlink" href="#data-transfer" title="Permanent link">¤</a></h3>
Expand All @@ -486,7 +486,7 @@ <h3 id="data-transfer">Data Transfer<a class="headerlink" href="#data-transfer"
<div class="highlight"><pre><span></span><code><span class="n">cpu_device</span><span class="p">()</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="n">LuxCPUDevice</span><span class="p">()</span>
</code></pre></div>
<p>Return a <code>LuxCPUDevice</code> object which can be used to transfer data to CPU.</p>
<p><a target='_blank' href='https://github.com/LuxDL/LuxDeviceUtils.jl/blob/10ccab161765cf1a534791836db4a531aa240f97/src/LuxDeviceUtils.jl#L207-L211' class='documenter-source'>source</a><br></p>
<p><a target='_blank' href='https://github.com/LuxDL/LuxDeviceUtils.jl/blob/db95b0a949a839f0b0e06d1981533f56e2e09b4a/src/LuxDeviceUtils.jl#L198-L202' class='documenter-source'>source</a><br></p>
<p><a id='LuxDeviceUtils.gpu_device' href='#LuxDeviceUtils.gpu_device'>#</a>
<strong><code>LuxDeviceUtils.gpu_device</code></strong> &mdash; <em>Function</em>.</p>
<div class="highlight"><pre><span></span><code><span class="n">gpu_device</span><span class="p">(;</span><span class="w"> </span><span class="n">force_gpu_usage</span><span class="o">::</span><span class="kt">Bool</span><span class="o">=</span><span class="nb">false</span><span class="p">)</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="n">AbstractLuxDevice</span><span class="p">()</span>
Expand All @@ -498,7 +498,7 @@ <h3 id="data-transfer">Data Transfer<a class="headerlink" href="#data-transfer"
<li>If no GPU device is functional and <code>force_gpu_usage</code> is <code>false</code>, then <code>cpu_device()</code> is invoked.</li>
<li>If nothing works, an error is thrown.</li>
</ol>
<p><a target='_blank' href='https://github.com/LuxDL/LuxDeviceUtils.jl/blob/10ccab161765cf1a534791836db4a531aa240f97/src/LuxDeviceUtils.jl#L84-L97' class='documenter-source'>source</a><br></p>
<p><a target='_blank' href='https://github.com/LuxDL/LuxDeviceUtils.jl/blob/db95b0a949a839f0b0e06d1981533f56e2e09b4a/src/LuxDeviceUtils.jl#L74-L87' class='documenter-source'>source</a><br></p>
<p><a id='Miscellaneous'></a></p>
<p><a id='Miscellaneous-1'></a></p>
<h3 id="miscellaneous">Miscellaneous<a class="headerlink" href="#miscellaneous" title="Permanent link">¤</a></h3>
Expand All @@ -507,7 +507,7 @@ <h3 id="miscellaneous">Miscellaneous<a class="headerlink" href="#miscellaneous"
<div class="highlight"><pre><span></span><code><span class="n">reset_gpu_device!</span><span class="p">()</span>
</code></pre></div>
<p>Resets the selected GPU device. This is useful when automatic GPU selection needs to be run again.</p>
<p><a target='_blank' href='https://github.com/LuxDL/LuxDeviceUtils.jl/blob/10ccab161765cf1a534791836db4a531aa240f97/src/LuxDeviceUtils.jl#L62-L67' class='documenter-source'>source</a><br></p>
<p><a target='_blank' href='https://github.com/LuxDL/LuxDeviceUtils.jl/blob/db95b0a949a839f0b0e06d1981533f56e2e09b4a/src/LuxDeviceUtils.jl#L52-L57' class='documenter-source'>source</a><br></p>
<p><a id='LuxDeviceUtils.supported_gpu_backends' href='#LuxDeviceUtils.supported_gpu_backends'>#</a>
<strong><code>LuxDeviceUtils.supported_gpu_backends</code></strong> &mdash; <em>Function</em>.</p>
<div class="highlight"><pre><span></span><code><span class="n">supported_gpu_backends</span><span class="p">()</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="kt">Tuple</span><span class="p">{</span><span class="kt">String</span><span class="p">,</span><span class="w"> </span><span class="o">...</span><span class="p">}</span>
Expand All @@ -517,7 +517,7 @@ <h3 id="miscellaneous">Miscellaneous<a class="headerlink" href="#miscellaneous"
<p class="admonition-title">Warning</p>
<p>This is not the list of functional backends on the system, but rather backends which <code>Lux.jl</code> supports.</p>
</div>
<p><a target='_blank' href='https://github.com/LuxDL/LuxDeviceUtils.jl/blob/10ccab161765cf1a534791836db4a531aa240f97/src/LuxDeviceUtils.jl#L72-L81' class='documenter-source'>source</a><br></p>
<p><a target='_blank' href='https://github.com/LuxDL/LuxDeviceUtils.jl/blob/db95b0a949a839f0b0e06d1981533f56e2e09b4a/src/LuxDeviceUtils.jl#L62-L71' class='documenter-source'>source</a><br></p>



Expand Down
2 changes: 1 addition & 1 deletion dev/sitemap.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://luxdl.github.io/LuxDeviceUtils.jl/</loc>
<lastmod>2023-07-20</lastmod>
<lastmod>2023-07-26</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>
Binary file modified dev/sitemap.xml.gz
Binary file not shown.

0 comments on commit e175510

Please sign in to comment.