Skip to content

Commit 777efff

Browse files
committed
Generate Python docs from pytorch/pytorch@8c2aa0c
1 parent 3616f16 commit 777efff

File tree

2,564 files changed

+5856
-5762
lines changed

Some content is hidden

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

2,564 files changed

+5856
-5762
lines changed

main/_images/RReLU.png

81 Bytes
Loading

main/_modules/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@
281281
<div class="pytorch-left-menu-search">
282282

283283
<div class="version">
284-
<a href='https://pytorch.org/docs/versions.html'>main (2.7.0a0+gitdcc04e9 ) &#x25BC</a>
284+
<a href='https://pytorch.org/docs/versions.html'>main (2.7.0a0+git8c2aa0c ) &#x25BC</a>
285285
</div>
286286
<div id="searchBox">
287287
<div class="searchbox" id="googleSearchBox">

main/_modules/torch.html

Lines changed: 37 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@
281281
<div class="pytorch-left-menu-search">
282282

283283
<div class="version">
284-
<a href='https://pytorch.org/docs/versions.html'>main (2.7.0a0+gitdcc04e9 ) &#x25BC</a>
284+
<a href='https://pytorch.org/docs/versions.html'>main (2.7.0a0+git8c2aa0c ) &#x25BC</a>
285285
</div>
286286
<div id="searchBox">
287287
<div class="searchbox" id="googleSearchBox">
@@ -903,6 +903,24 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
903903

904904
<span class="k">try</span><span class="p">:</span>
905905
<span class="n">ctypes</span><span class="o">.</span><span class="n">CDLL</span><span class="p">(</span><span class="n">global_deps_lib_path</span><span class="p">,</span> <span class="n">mode</span><span class="o">=</span><span class="n">ctypes</span><span class="o">.</span><span class="n">RTLD_GLOBAL</span><span class="p">)</span>
906+
<span class="c1"># Workaround slim-wheel CUDA-12.4+ dependency bug in libcusparse by preloading nvjitlink</span>
907+
<span class="c1"># In those versions of cuda cusparse depends on nvjitlink, but does not have rpath when</span>
908+
<span class="c1"># shipped as wheel, which results in OS picking wrong/older version of nvjitlink library</span>
909+
<span class="c1"># if `LD_LIBRARY_PATH` is defined</span>
910+
<span class="c1"># See https://github.com/pytorch/pytorch/issues/138460</span>
911+
<span class="k">if</span> <span class="n">version</span><span class="o">.</span><span class="n">cuda</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">&quot;12.4&quot;</span><span class="p">,</span> <span class="s2">&quot;12.6&quot;</span><span class="p">]:</span> <span class="c1"># type: ignore[name-defined]</span>
912+
<span class="k">return</span>
913+
<span class="k">try</span><span class="p">:</span>
914+
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s2">&quot;/proc/self/maps&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
915+
<span class="n">_maps</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
916+
<span class="c1"># libtorch_global_deps.so always depends in cudart, check if its installed via wheel</span>
917+
<span class="k">if</span> <span class="s2">&quot;nvidia/cuda_runtime/lib/libcudart.so&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">_maps</span><span class="p">:</span>
918+
<span class="k">return</span>
919+
<span class="c1"># If all abovementioned conditions are met, preload nvjitlink</span>
920+
<span class="n">_preload_cuda_deps</span><span class="p">(</span><span class="s2">&quot;nvjitlink&quot;</span><span class="p">,</span> <span class="s2">&quot;libnvJitLink.so.*[0-9]&quot;</span><span class="p">)</span>
921+
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
922+
<span class="k">pass</span>
923+
906924
<span class="k">except</span> <span class="ne">OSError</span> <span class="k">as</span> <span class="n">err</span><span class="p">:</span>
907925
<span class="c1"># Can only happen for wheel with cuda libs as PYPI deps</span>
908926
<span class="c1"># As PyTorch is not purelib, but nvidia-*-cu12 is</span>
@@ -1735,7 +1753,7 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
17351753
<span class="sd"> .. note::</span>
17361754

17371755
<span class="sd"> This doesn&#39;t affect functions that create tensors that share the same memory as the input, like:</span>
1738-
<span class="sd"> :func:`torch.from_numpy` and :func:`torch.frombuffer`. Using :func:`torch.Tensor.to` move tensor to desired device.</span>
1756+
<span class="sd"> :func:`torch.from_numpy` and :func:`torch.frombuffer`</span>
17391757

17401758
<span class="sd"> Args:</span>
17411759
<span class="sd"> device (device or string): the device to set as default</span>
@@ -2224,11 +2242,17 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
22242242
<span class="n">_check_with</span><span class="p">(</span><span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">cond</span><span class="p">,</span> <span class="n">message</span><span class="p">)</span>
22252243

22262244

2227-
<span class="k">def</span> <span class="nf">_check_is_size</span><span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
2245+
<span class="k">def</span> <span class="nf">_check_is_size</span><span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="nb">max</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
22282246
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Checks that a given integer is a valid size (i.e., is non-negative).</span>
2229-
<span class="sd"> You should use this over _check(i &gt;= 0) because we can use the semantic</span>
2230-
<span class="sd"> information (that i is a size) to make some further inferences in case</span>
2231-
<span class="sd"> i is an unbacked SymInt.</span>
2247+
<span class="sd"> You should use this over ``_check(i &gt;= 0)`` because it can prevent</span>
2248+
<span class="sd"> ``GuardOnDataDependentSymNode`` exceptions by opting yourself into alternate</span>
2249+
<span class="sd"> semantics for ``guard_size_oblivious`` tests that treat values 0 and 1</span>
2250+
<span class="sd"> equivalently to all other values.</span>
2251+
2252+
<span class="sd"> When max is not None, this specifies an upper bound equivalent to</span>
2253+
<span class="sd"> ``_check(i &lt;= max)``. This bound is also subject to alternate semantics:</span>
2254+
<span class="sd"> in ``guard_size_oblivious`` tests, we assume that the max bound is treated</span>
2255+
<span class="sd"> equivalently to all other values.</span>
22322256

22332257
<span class="sd"> NB: Do NOT use this in contexts where a -1 size would be valid (indicating</span>
22342258
<span class="sd"> to infer the size from context, or if you should wrap-around or truncate).</span>
@@ -2240,6 +2264,13 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
22402264

22412265
<span class="n">_advise_is_size</span><span class="p">(</span><span class="n">i</span><span class="p">)</span>
22422266

2267+
<span class="k">if</span> <span class="nb">max</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
2268+
<span class="n">_check</span><span class="p">(</span><span class="n">i</span> <span class="o">&lt;=</span> <span class="nb">max</span><span class="p">,</span> <span class="n">message</span><span class="p">)</span>
2269+
2270+
<span class="kn">from</span> <span class="nn">torch.fx.experimental.symbolic_shapes</span> <span class="kn">import</span> <span class="n">_advise_is_bounded</span>
2271+
2272+
<span class="n">_advise_is_bounded</span><span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="nb">max</span><span class="p">)</span>
2273+
22432274

22442275
<span class="k">def</span> <span class="nf">_check_index</span><span class="p">(</span><span class="n">cond</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> <span class="c1"># noqa: F811</span>
22452276
<span class="w"> </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;Throws error containing an optional message if the specified condition</span>

main/_modules/torch/__config__.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@
281281
<div class="pytorch-left-menu-search">
282282

283283
<div class="version">
284-
<a href='https://pytorch.org/docs/versions.html'>main (2.7.0a0+gitdcc04e9 ) &#x25BC</a>
284+
<a href='https://pytorch.org/docs/versions.html'>main (2.7.0a0+git8c2aa0c ) &#x25BC</a>
285285
</div>
286286
<div id="searchBox">
287287
<div class="searchbox" id="googleSearchBox">

main/_modules/torch/__future__.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@
281281
<div class="pytorch-left-menu-search">
282282

283283
<div class="version">
284-
<a href='https://pytorch.org/docs/versions.html'>main (2.7.0a0+gitdcc04e9 ) &#x25BC</a>
284+
<a href='https://pytorch.org/docs/versions.html'>main (2.7.0a0+git8c2aa0c ) &#x25BC</a>
285285
</div>
286286
<div id="searchBox">
287287
<div class="searchbox" id="googleSearchBox">

main/_modules/torch/_jit_internal.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@
281281
<div class="pytorch-left-menu-search">
282282

283283
<div class="version">
284-
<a href='https://pytorch.org/docs/versions.html'>main (2.7.0a0+gitdcc04e9 ) &#x25BC</a>
284+
<a href='https://pytorch.org/docs/versions.html'>main (2.7.0a0+git8c2aa0c ) &#x25BC</a>
285285
</div>
286286
<div id="searchBox">
287287
<div class="searchbox" id="googleSearchBox">

main/_modules/torch/_library/custom_ops.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@
281281
<div class="pytorch-left-menu-search">
282282

283283
<div class="version">
284-
<a href='https://pytorch.org/docs/versions.html'>main (2.7.0a0+gitdcc04e9 ) &#x25BC</a>
284+
<a href='https://pytorch.org/docs/versions.html'>main (2.7.0a0+git8c2aa0c ) &#x25BC</a>
285285
</div>
286286
<div id="searchBox">
287287
<div class="searchbox" id="googleSearchBox">

main/_modules/torch/_lobpcg.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@
281281
<div class="pytorch-left-menu-search">
282282

283283
<div class="version">
284-
<a href='https://pytorch.org/docs/versions.html'>main (2.7.0a0+gitdcc04e9 ) &#x25BC</a>
284+
<a href='https://pytorch.org/docs/versions.html'>main (2.7.0a0+git8c2aa0c ) &#x25BC</a>
285285
</div>
286286
<div id="searchBox">
287287
<div class="searchbox" id="googleSearchBox">

main/_modules/torch/_logging/_internal.html

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@
281281
<div class="pytorch-left-menu-search">
282282

283283
<div class="version">
284-
<a href='https://pytorch.org/docs/versions.html'>main (2.7.0a0+gitdcc04e9 ) &#x25BC</a>
284+
<a href='https://pytorch.org/docs/versions.html'>main (2.7.0a0+git8c2aa0c ) &#x25BC</a>
285285
</div>
286286
<div id="searchBox">
287287
<div class="searchbox" id="googleSearchBox">
@@ -1813,8 +1813,17 @@ <h1>Source code for torch._logging._internal</h1><div class="highlight"><pre>
18131813
<span class="c1"># special case to look better</span>
18141814
<span class="n">payload</span> <span class="o">=</span> <span class="s2">&quot;[</span><span class="se">\n</span><span class="s2">&quot;</span> <span class="o">+</span> <span class="s2">&quot;,</span><span class="se">\n</span><span class="s2">&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">i</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">payload</span><span class="p">)</span> <span class="o">+</span> <span class="s2">&quot;</span><span class="se">\n</span><span class="s2">]&quot;</span>
18151815
<span class="k">else</span><span class="p">:</span>
1816+
1817+
<span class="k">def</span> <span class="nf">json_default</span><span class="p">(</span><span class="n">obj</span><span class="p">):</span>
1818+
<span class="c1"># Sets aren&#39;t json serializable</span>
1819+
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="nb">set</span><span class="p">):</span>
1820+
<span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span>
1821+
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span>
1822+
<span class="sa">f</span><span class="s2">&quot;Object of type </span><span class="si">{</span><span class="nb">type</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span><span class="si">}</span><span class="s2"> is not JSON serializable&quot;</span>
1823+
<span class="p">)</span>
1824+
18161825
<span class="c1"># force newlines so we are unlikely to overflow line limit</span>
1817-
<span class="n">payload</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span> <span class="n">indent</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span>
1826+
<span class="n">payload</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="n">json_default</span><span class="p">,</span> <span class="n">indent</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span>
18181827
<span class="n">h</span> <span class="o">=</span> <span class="n">hashlib</span><span class="o">.</span><span class="n">md5</span><span class="p">()</span>
18191828
<span class="n">h</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">payload</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s2">&quot;utf-8&quot;</span><span class="p">))</span>
18201829
<span class="n">record</span><span class="p">[</span><span class="s2">&quot;has_payload&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">h</span><span class="o">.</span><span class="n">hexdigest</span><span class="p">()</span>

main/_modules/torch/_lowrank.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@
281281
<div class="pytorch-left-menu-search">
282282

283283
<div class="version">
284-
<a href='https://pytorch.org/docs/versions.html'>main (2.7.0a0+gitdcc04e9 ) &#x25BC</a>
284+
<a href='https://pytorch.org/docs/versions.html'>main (2.7.0a0+git8c2aa0c ) &#x25BC</a>
285285
</div>
286286
<div id="searchBox">
287287
<div class="searchbox" id="googleSearchBox">

0 commit comments

Comments
 (0)