Skip to content

Commit

Permalink
Generate Python docs from pytorch/pytorch@f44739c
Browse files Browse the repository at this point in the history
  • Loading branch information
pytorchbot committed Jul 13, 2024
1 parent 2e4744b commit 3f5ce6f
Show file tree
Hide file tree
Showing 2,468 changed files with 3,290 additions and 3,437 deletions.
Binary file modified main/_images/RReLU.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion main/_modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@
<div class="pytorch-left-menu-search">

<div class="version">
<a href='https://pytorch.org/docs/versions.html'>main (2.5.0a0+gitb5b91b4 ) &#x25BC</a>
<a href='https://pytorch.org/docs/versions.html'>main (2.5.0a0+gitf44739c ) &#x25BC</a>
</div>


Expand Down
39 changes: 27 additions & 12 deletions main/_modules/torch.html
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@
<div class="pytorch-left-menu-search">

<div class="version">
<a href='https://pytorch.org/docs/versions.html'>main (2.5.0a0+gitb5b91b4 ) &#x25BC</a>
<a href='https://pytorch.org/docs/versions.html'>main (2.5.0a0+gitf44739c ) &#x25BC</a>
</div>


Expand Down Expand Up @@ -1028,17 +1028,29 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;type stub not overridden&quot;</span><span class="p">)</span>

<span class="k">def</span> <span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">_graph_repr</span><span class="p">()</span>

<span class="k">def</span> <span class="nf">_sympy_</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">expr</span>

<span class="k">def</span> <span class="fm">__hash__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">builtins</span><span class="o">.</span><span class="n">int</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">hash</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_get_int</span><span class="p">())</span>

<div class="viewcode-block" id="SymInt.as_integer_ratio"><a class="viewcode-back" href="../torch.html#torch.SymInt.as_integer_ratio">[docs]</a> <span class="k">def</span> <span class="nf">as_integer_ratio</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">_Tuple</span><span class="p">[</span><span class="n">builtins</span><span class="o">.</span><span class="n">int</span><span class="p">,</span> <span class="n">builtins</span><span class="o">.</span><span class="n">int</span><span class="p">]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Represent this int as an exact integer ratio&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_int</span><span class="p">(),</span> <span class="mi">1</span></div>

<span class="k">def</span> <span class="nf">bit_length</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="s2">&quot;SymInt&quot;</span><span class="p">:</span>
<span class="k">return</span> <span class="n">SymInt</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">wrap_int</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_get_int</span><span class="p">()</span><span class="o">.</span><span class="n">bit_length</span><span class="p">()))</span>

<span class="k">def</span> <span class="nf">conjugate</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="s2">&quot;SymInt&quot;</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span>

<span class="k">def</span> <span class="nf">_get_int</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">builtins</span><span class="o">.</span><span class="n">int</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">is_nested_int</span><span class="p">():</span>
<span class="k">return</span> <span class="nb">hash</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">nested_int</span><span class="p">())</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">nested_int</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># Force specialization</span>
<span class="k">return</span> <span class="nb">hash</span><span class="p">(</span><span class="n">builtins</span><span class="o">.</span><span class="n">int</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span></div>
<span class="k">return</span> <span class="n">builtins</span><span class="o">.</span><span class="n">int</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span></div>


<div class="viewcode-block" id="SymFloat"><a class="viewcode-back" href="../torch.html#torch.SymFloat">[docs]</a><span class="k">class</span> <span class="nc">SymFloat</span><span class="p">:</span>
Expand Down Expand Up @@ -1138,18 +1150,21 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Return True if the float is an integer.&quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;type stub not overridden&quot;</span><span class="p">)</span></div>

<div class="viewcode-block" id="SymFloat.as_integer_ratio"><a class="viewcode-back" href="../torch.html#torch.SymFloat.as_integer_ratio">[docs]</a> <span class="k">def</span> <span class="nf">as_integer_ratio</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">_Tuple</span><span class="p">[</span><span class="n">builtins</span><span class="o">.</span><span class="n">int</span><span class="p">,</span> <span class="n">builtins</span><span class="o">.</span><span class="n">int</span><span class="p">]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Represent this float as an exact integer ratio&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_float</span><span class="p">()</span><span class="o">.</span><span class="n">as_integer_ratio</span><span class="p">()</span></div>

<span class="k">def</span> <span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">str</span><span class="p">()</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">_graph_repr</span><span class="p">()</span>

<span class="k">def</span> <span class="nf">_sympy_</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">expr</span>

<span class="k">def</span> <span class="fm">__hash__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">is_constant</span><span class="p">():</span>
<span class="k">return</span> <span class="nb">hash</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">float_</span><span class="p">())</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># Force specialization</span>
<span class="k">return</span> <span class="nb">hash</span><span class="p">(</span><span class="n">builtins</span><span class="o">.</span><span class="n">float</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span></div>
<span class="k">return</span> <span class="nb">hash</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_get_float</span><span class="p">())</span>

<span class="k">def</span> <span class="nf">_get_float</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">builtins</span><span class="o">.</span><span class="n">float</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">float_</span><span class="p">()</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">is_constant</span><span class="p">()</span> <span class="k">else</span> <span class="n">builtins</span><span class="o">.</span><span class="n">float</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span></div>


<div class="viewcode-block" id="SymBool"><a class="viewcode-back" href="../torch.html#torch.SymBool">[docs]</a><span class="k">class</span> <span class="nc">SymBool</span><span class="p">:</span>
Expand Down Expand Up @@ -1207,7 +1222,7 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;type stub not overridden&quot;</span><span class="p">)</span>

<span class="k">def</span> <span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">_graph_repr</span><span class="p">()</span>

<span class="k">def</span> <span class="nf">_sympy_</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">expr</span>
Expand Down
2 changes: 1 addition & 1 deletion main/_modules/torch/__config__.html
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@
<div class="pytorch-left-menu-search">

<div class="version">
<a href='https://pytorch.org/docs/versions.html'>main (2.5.0a0+gitb5b91b4 ) &#x25BC</a>
<a href='https://pytorch.org/docs/versions.html'>main (2.5.0a0+gitf44739c ) &#x25BC</a>
</div>


Expand Down
2 changes: 1 addition & 1 deletion main/_modules/torch/__future__.html
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@
<div class="pytorch-left-menu-search">

<div class="version">
<a href='https://pytorch.org/docs/versions.html'>main (2.5.0a0+gitb5b91b4 ) &#x25BC</a>
<a href='https://pytorch.org/docs/versions.html'>main (2.5.0a0+gitf44739c ) &#x25BC</a>
</div>


Expand Down
2 changes: 1 addition & 1 deletion main/_modules/torch/_jit_internal.html
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@
<div class="pytorch-left-menu-search">

<div class="version">
<a href='https://pytorch.org/docs/versions.html'>main (2.5.0a0+gitb5b91b4 ) &#x25BC</a>
<a href='https://pytorch.org/docs/versions.html'>main (2.5.0a0+gitf44739c ) &#x25BC</a>
</div>


Expand Down
34 changes: 33 additions & 1 deletion main/_modules/torch/_library/custom_ops.html
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@
<div class="pytorch-left-menu-search">

<div class="version">
<a href='https://pytorch.org/docs/versions.html'>main (2.5.0a0+gitb5b91b4 ) &#x25BC</a>
<a href='https://pytorch.org/docs/versions.html'>main (2.5.0a0+gitf44739c ) &#x25BC</a>
</div>


Expand Down Expand Up @@ -704,6 +704,7 @@ <h1>Source code for torch._library.custom_ops</h1><div class="highlight"><pre>
<span class="bp">self</span><span class="o">.</span><span class="n">_abstract_fn</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Callable</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_setup_context_fn</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Callable</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_backward_fn</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Callable</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_torch_dispatch_fns</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">type</span><span class="p">,</span> <span class="n">Callable</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>

<span class="bp">self</span><span class="o">.</span><span class="n">_lib</span> <span class="o">=</span> <span class="n">get_library_allowing_overwrite</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_namespace</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_name</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_register_to_dispatcher</span><span class="p">()</span>
Expand Down Expand Up @@ -976,6 +977,37 @@ <h1>Source code for torch._library.custom_ops</h1><div class="highlight"><pre>
<span class="bp">self</span><span class="o">.</span><span class="n">_abstract_fn</span> <span class="o">=</span> <span class="n">fn</span>
<span class="k">return</span> <span class="n">fn</span>

<span class="k">def</span> <span class="nf">register_torch_dispatch</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span> <span class="n">torch_dispatch_class</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span> <span class="n">fn</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Callable</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="o">/</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Callable</span><span class="p">:</span>
<span class="w"> </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;Registers a torch_dispatch rule for the given operator and ``torch_dispatch_class``.</span>

<span class="sd"> This allows for open registration to specify the behavior between the operator</span>
<span class="sd"> and the ``torch_dispatch_class`` without needing to modify the ``torch_dispatch_class``</span>
<span class="sd"> or the operator directly.</span>

<span class="sd"> Please see :func:`torch.library.register_torch_dispatch` for examples and more details.</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="k">def</span> <span class="nf">register</span><span class="p">(</span><span class="n">fn</span><span class="p">):</span>
<span class="k">if</span> <span class="n">torch_dispatch_class</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_torch_dispatch_fns</span><span class="p">:</span>

<span class="k">def</span> <span class="nf">inner</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_torch_dispatch_fns</span><span class="p">[</span><span class="n">torch_dispatch_class</span><span class="p">](</span>
<span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span>
<span class="p">)</span>

<span class="bp">self</span><span class="o">.</span><span class="n">_lib</span><span class="o">.</span><span class="n">_register_torch_dispatch_rule</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_name</span><span class="p">,</span> <span class="n">torch_dispatch_class</span><span class="p">,</span> <span class="n">inner</span>
<span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_torch_dispatch_fns</span><span class="p">[</span><span class="n">torch_dispatch_class</span><span class="p">]</span> <span class="o">=</span> <span class="n">fn</span>
<span class="k">return</span> <span class="n">fn</span>

<span class="k">if</span> <span class="n">fn</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="n">register</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">register</span><span class="p">(</span><span class="n">fn</span><span class="p">)</span>

<span class="k">def</span> <span class="nf">register_autograd</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">backward</span><span class="p">:</span> <span class="n">Callable</span><span class="p">,</span>
Expand Down
2 changes: 1 addition & 1 deletion main/_modules/torch/_lobpcg.html
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@
<div class="pytorch-left-menu-search">

<div class="version">
<a href='https://pytorch.org/docs/versions.html'>main (2.5.0a0+gitb5b91b4 ) &#x25BC</a>
<a href='https://pytorch.org/docs/versions.html'>main (2.5.0a0+gitf44739c ) &#x25BC</a>
</div>


Expand Down
Loading

0 comments on commit 3f5ce6f

Please sign in to comment.