Skip to content

Commit 274bc11

Browse files
pytorchbotpytorchbot
committed
Generate Python docs from pytorch/pytorch@12d0e69 
1 parent 9684442 commit 274bc11

24 files changed

+147
-147
lines changed

‎docs/2.3/_images/RReLU.png

-358 Bytes
Loading

‎docs/2.3/_modules/torch/autograd/function.html

+19-19
Large diffs are not rendered by default.

‎docs/2.3/_sources/generated/exportdb/index.rst.txt

+5-5
Original file line numberDiff line numberDiff line change
@@ -467,7 +467,7 @@ cond_closed_over_variable
467467

468468
.. note::
469469

470-
Tags: :doc:`torch.cond <torch.cond>`, :doc:`python.closure <python.closure>`
470+
Tags: :doc:`python.closure <python.closure>`, :doc:`torch.cond <torch.cond>`
471471

472472
Support Level: SUPPORTED
473473

@@ -666,7 +666,7 @@ constrain_as_size_example
666666

667667
.. note::
668668

669-
Tags: :doc:`torch.escape-hatch <torch.escape-hatch>`, :doc:`torch.dynamic-value <torch.dynamic-value>`
669+
Tags: :doc:`torch.dynamic-value <torch.dynamic-value>`, :doc:`torch.escape-hatch <torch.escape-hatch>`
670670

671671
Support Level: SUPPORTED
672672

@@ -726,7 +726,7 @@ constrain_as_value_example
726726

727727
.. note::
728728

729-
Tags: :doc:`torch.escape-hatch <torch.escape-hatch>`, :doc:`torch.dynamic-value <torch.dynamic-value>`
729+
Tags: :doc:`torch.dynamic-value <torch.dynamic-value>`, :doc:`torch.escape-hatch <torch.escape-hatch>`
730730

731731
Support Level: SUPPORTED
732732

@@ -1286,7 +1286,7 @@ list_unpack
12861286

12871287
.. note::
12881288

1289-
Tags: :doc:`python.control-flow <python.control-flow>`, :doc:`python.data-structure <python.data-structure>`
1289+
Tags: :doc:`python.data-structure <python.data-structure>`, :doc:`python.control-flow <python.control-flow>`
12901290

12911291
Support Level: SUPPORTED
12921292

@@ -2005,6 +2005,6 @@ Result:
20052005

20062006
.. code-block::
20072007
2008-
Unsupported: torch.* op returned non-Tensor int call_function <function sym_min at 0x7f4d9cf5cd30>
2008+
Unsupported: torch.* op returned non-Tensor int call_function <function sym_min at 0x7fc1ffee1d30>
20092009
20102010

‎docs/2.3/_sources/generated/exportdb/python.closure.rst.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ cond_closed_over_variable
55

66
.. note::
77

8-
Tags: :doc:`torch.cond <torch.cond>`, :doc:`python.closure <python.closure>`
8+
Tags: :doc:`python.closure <python.closure>`, :doc:`torch.cond <torch.cond>`
99

1010
Support Level: SUPPORTED
1111

‎docs/2.3/_sources/generated/exportdb/python.control-flow.rst.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ list_unpack
5151

5252
.. note::
5353

54-
Tags: :doc:`python.control-flow <python.control-flow>`, :doc:`python.data-structure <python.data-structure>`
54+
Tags: :doc:`python.data-structure <python.data-structure>`, :doc:`python.control-flow <python.control-flow>`
5555

5656
Support Level: SUPPORTED
5757

‎docs/2.3/_sources/generated/exportdb/python.data-structure.rst.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ list_unpack
162162

163163
.. note::
164164

165-
Tags: :doc:`python.control-flow <python.control-flow>`, :doc:`python.data-structure <python.data-structure>`
165+
Tags: :doc:`python.data-structure <python.data-structure>`, :doc:`python.control-flow <python.control-flow>`
166166

167167
Support Level: SUPPORTED
168168

‎docs/2.3/_sources/generated/exportdb/torch.cond.rst.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ cond_closed_over_variable
269269

270270
.. note::
271271

272-
Tags: :doc:`torch.cond <torch.cond>`, :doc:`python.closure <python.closure>`
272+
Tags: :doc:`python.closure <python.closure>`, :doc:`torch.cond <torch.cond>`
273273

274274
Support Level: SUPPORTED
275275

‎docs/2.3/_sources/generated/exportdb/torch.dynamic-value.rst.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ constrain_as_size_example
55

66
.. note::
77

8-
Tags: :doc:`torch.escape-hatch <torch.escape-hatch>`, :doc:`torch.dynamic-value <torch.dynamic-value>`
8+
Tags: :doc:`torch.dynamic-value <torch.dynamic-value>`, :doc:`torch.escape-hatch <torch.escape-hatch>`
99

1010
Support Level: SUPPORTED
1111

@@ -65,7 +65,7 @@ constrain_as_value_example
6565

6666
.. note::
6767

68-
Tags: :doc:`torch.escape-hatch <torch.escape-hatch>`, :doc:`torch.dynamic-value <torch.dynamic-value>`
68+
Tags: :doc:`torch.dynamic-value <torch.dynamic-value>`, :doc:`torch.escape-hatch <torch.escape-hatch>`
6969

7070
Support Level: SUPPORTED
7171

‎docs/2.3/_sources/generated/exportdb/torch.escape-hatch.rst.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ constrain_as_size_example
5454

5555
.. note::
5656

57-
Tags: :doc:`torch.escape-hatch <torch.escape-hatch>`, :doc:`torch.dynamic-value <torch.dynamic-value>`
57+
Tags: :doc:`torch.dynamic-value <torch.dynamic-value>`, :doc:`torch.escape-hatch <torch.escape-hatch>`
5858

5959
Support Level: SUPPORTED
6060

@@ -114,7 +114,7 @@ constrain_as_value_example
114114

115115
.. note::
116116

117-
Tags: :doc:`torch.escape-hatch <torch.escape-hatch>`, :doc:`torch.dynamic-value <torch.dynamic-value>`
117+
Tags: :doc:`torch.dynamic-value <torch.dynamic-value>`, :doc:`torch.escape-hatch <torch.escape-hatch>`
118118

119119
Support Level: SUPPORTED
120120

‎docs/2.3/_sources/generated/exportdb/torch.operator.rst.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,4 @@ Result:
3030

3131
.. code-block::
3232
33-
Unsupported: torch.* op returned non-Tensor int call_function <function sym_min at 0x7f4d9cf5cd30>
33+
Unsupported: torch.* op returned non-Tensor int call_function <function sym_min at 0x7fc1ffee1d30>

‎docs/2.3/ddp_comm_hooks.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -527,7 +527,7 @@ <h2>What Does a Communication Hook Operate On?<a class="headerlink" href="#what-
527527

528528
<dl class="py function">
529529
<dt class="sig sig-object py" id="torch.distributed.GradBucket.gradients">
530-
<span class="sig-prename descclassname"><span class="pre">torch.distributed.GradBucket.</span></span><span class="sig-name descname"><span class="pre">gradients</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#torch.distributed.GradBucket" title="torch._C._distributed_c10d.GradBucket"><span class="pre">torch._C._distributed_c10d.GradBucket</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="tensors.html#torch.Tensor" title="torch.Tensor"><span class="pre">torch.Tensor</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#torch.distributed.GradBucket.gradients" title="Permalink to this definition"></a></dt>
530+
<span class="sig-prename descclassname"><span class="pre">torch.distributed.GradBucket.</span></span><span class="sig-name descname"><span class="pre">gradients</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#torch.distributed.GradBucket" title="torch._C._distributed_c10d.GradBucket"><span class="pre">torch._C._distributed_c10d.GradBucket</span></a></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 external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="tensors.html#torch.Tensor" title="torch.Tensor"><span class="pre">torch.Tensor</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#torch.distributed.GradBucket.gradients" title="Permalink to this definition"></a></dt>
531531
<dd><dl class="field-list simple">
532532
<dt class="field-odd">Returns</dt>
533533
<dd class="field-odd"><p>A list of <code class="docutils literal notranslate"><span class="pre">torch.Tensor</span></code>. Each tensor in the list corresponds to a gradient.</p>
@@ -554,7 +554,7 @@ <h2>What Does a Communication Hook Operate On?<a class="headerlink" href="#what-
554554

555555
<dl class="py function">
556556
<dt class="sig sig-object py" id="torch.distributed.GradBucket.parameters">
557-
<span class="sig-prename descclassname"><span class="pre">torch.distributed.GradBucket.</span></span><span class="sig-name descname"><span class="pre">parameters</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#torch.distributed.GradBucket" title="torch._C._distributed_c10d.GradBucket"><span class="pre">torch._C._distributed_c10d.GradBucket</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="tensors.html#torch.Tensor" title="torch.Tensor"><span class="pre">torch.Tensor</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#torch.distributed.GradBucket.parameters" title="Permalink to this definition"></a></dt>
557+
<span class="sig-prename descclassname"><span class="pre">torch.distributed.GradBucket.</span></span><span class="sig-name descname"><span class="pre">parameters</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#torch.distributed.GradBucket" title="torch._C._distributed_c10d.GradBucket"><span class="pre">torch._C._distributed_c10d.GradBucket</span></a></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 external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="tensors.html#torch.Tensor" title="torch.Tensor"><span class="pre">torch.Tensor</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#torch.distributed.GradBucket.parameters" title="Permalink to this definition"></a></dt>
558558
<dd><dl class="field-list simple">
559559
<dt class="field-odd">Returns</dt>
560560
<dd class="field-odd"><p>A list of <code class="docutils literal notranslate"><span class="pre">torch.Tensor</span></code>. Each tensor in the list corresponds to a model

‎docs/2.3/distributed.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -1348,7 +1348,7 @@ <h2>Distributed Key-Value Store<a class="headerlink" href="#distributed-key-valu
13481348
<span class="sig-prename descclassname"><span class="pre">torch.distributed.Store.</span></span><span class="sig-name descname"><span class="pre">wait</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#torch.distributed.Store.wait" title="Permalink to this definition"></a></dt>
13491349
<dd><p>Overloaded function.</p>
13501350
<ol class="arabic simple">
1351-
<li><p>wait(self: torch._C._distributed_c10d.Store, arg0: List[str]) -&gt; None</p></li>
1351+
<li><p>wait(self: torch._C._distributed_c10d.Store, arg0: list[str]) -&gt; None</p></li>
13521352
</ol>
13531353
<p>Waits for each key in <code class="docutils literal notranslate"><span class="pre">keys</span></code> to be added to the store. If not all keys are
13541354
set before the <code class="docutils literal notranslate"><span class="pre">timeout</span></code> (set during store initialization), then <code class="docutils literal notranslate"><span class="pre">wait</span></code>
@@ -1370,7 +1370,7 @@ <h2>Distributed Key-Value Store<a class="headerlink" href="#distributed-key-valu
13701370
</dd>
13711371
</dl>
13721372
<ol class="arabic simple" start="2">
1373-
<li><p>wait(self: torch._C._distributed_c10d.Store, arg0: List[str], arg1: datetime.timedelta) -&gt; None</p></li>
1373+
<li><p>wait(self: torch._C._distributed_c10d.Store, arg0: list[str], arg1: datetime.timedelta) -&gt; None</p></li>
13741374
</ol>
13751375
<p>Waits for each key in <code class="docutils literal notranslate"><span class="pre">keys</span></code> to be added to the store, and throws an exception
13761376
if the keys have not been set by the supplied <code class="docutils literal notranslate"><span class="pre">timeout</span></code>.</p>

‎docs/2.3/generated/exportdb/index.html

+5-5
Original file line numberDiff line numberDiff line change
@@ -881,7 +881,7 @@ <h3>cond_branch_nonlocal_variables<a class="headerlink" href="#cond-branch-nonlo
881881
<h3>cond_closed_over_variable<a class="headerlink" href="#cond-closed-over-variable" title="Permalink to this heading"></a></h3>
882882
<div class="admonition note">
883883
<p class="admonition-title">Note</p>
884-
<p>Tags: <a class="reference internal" href="torch.cond.html"><span class="doc">torch.cond</span></a>, <a class="reference internal" href="python.closure.html"><span class="doc">python.closure</span></a></p>
884+
<p>Tags: <a class="reference internal" href="python.closure.html"><span class="doc">python.closure</span></a>, <a class="reference internal" href="torch.cond.html"><span class="doc">torch.cond</span></a></p>
885885
<p>Support Level: SUPPORTED</p>
886886
</div>
887887
<p>Original source code:</p>
@@ -1056,7 +1056,7 @@ <h3>cond_predicate<a class="headerlink" href="#cond-predicate" title="Permalink
10561056
<h3>constrain_as_size_example<a class="headerlink" href="#constrain-as-size-example" title="Permalink to this heading"></a></h3>
10571057
<div class="admonition note">
10581058
<p class="admonition-title">Note</p>
1059-
<p>Tags: <a class="reference internal" href="torch.escape-hatch.html"><span class="doc">torch.escape-hatch</span></a>, <a class="reference internal" href="torch.dynamic-value.html"><span class="doc">torch.dynamic-value</span></a></p>
1059+
<p>Tags: <a class="reference internal" href="torch.dynamic-value.html"><span class="doc">torch.dynamic-value</span></a>, <a class="reference internal" href="torch.escape-hatch.html"><span class="doc">torch.escape-hatch</span></a></p>
10601060
<p>Support Level: SUPPORTED</p>
10611061
</div>
10621062
<p>Original source code:</p>
@@ -1108,7 +1108,7 @@ <h3>constrain_as_size_example<a class="headerlink" href="#constrain-as-size-exam
11081108
<h3>constrain_as_value_example<a class="headerlink" href="#constrain-as-value-example" title="Permalink to this heading"></a></h3>
11091109
<div class="admonition note">
11101110
<p class="admonition-title">Note</p>
1111-
<p>Tags: <a class="reference internal" href="torch.escape-hatch.html"><span class="doc">torch.escape-hatch</span></a>, <a class="reference internal" href="torch.dynamic-value.html"><span class="doc">torch.dynamic-value</span></a></p>
1111+
<p>Tags: <a class="reference internal" href="torch.dynamic-value.html"><span class="doc">torch.dynamic-value</span></a>, <a class="reference internal" href="torch.escape-hatch.html"><span class="doc">torch.escape-hatch</span></a></p>
11121112
<p>Support Level: SUPPORTED</p>
11131113
</div>
11141114
<p>Original source code:</p>
@@ -1580,7 +1580,7 @@ <h3>list_contains<a class="headerlink" href="#list-contains" title="Permalink to
15801580
<h3>list_unpack<a class="headerlink" href="#list-unpack" title="Permalink to this heading"></a></h3>
15811581
<div class="admonition note">
15821582
<p class="admonition-title">Note</p>
1583-
<p>Tags: <a class="reference internal" href="python.control-flow.html"><span class="doc">python.control-flow</span></a>, <a class="reference internal" href="python.data-structure.html"><span class="doc">python.data-structure</span></a></p>
1583+
<p>Tags: <a class="reference internal" href="python.data-structure.html"><span class="doc">python.data-structure</span></a>, <a class="reference internal" href="python.control-flow.html"><span class="doc">python.control-flow</span></a></p>
15841584
<p>Support Level: SUPPORTED</p>
15851585
</div>
15861586
<p>Original source code:</p>
@@ -2176,7 +2176,7 @@ <h3>torch_sym_min<a class="headerlink" href="#torch-sym-min" title="Permalink to
21762176
</pre></div>
21772177
</div>
21782178
<p>Result:</p>
2179-
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Unsupported</span><span class="p">:</span> <span class="n">torch</span><span class="o">.*</span> <span class="n">op</span> <span class="n">returned</span> <span class="n">non</span><span class="o">-</span><span class="n">Tensor</span> <span class="nb">int</span> <span class="n">call_function</span> <span class="o">&lt;</span><span class="n">function</span> <span class="n">sym_min</span> <span class="n">at</span> <span class="mh">0x7f4d9cf5cd30</span><span class="o">&gt;</span>
2179+
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Unsupported</span><span class="p">:</span> <span class="n">torch</span><span class="o">.*</span> <span class="n">op</span> <span class="n">returned</span> <span class="n">non</span><span class="o">-</span><span class="n">Tensor</span> <span class="nb">int</span> <span class="n">call_function</span> <span class="o">&lt;</span><span class="n">function</span> <span class="n">sym_min</span> <span class="n">at</span> <span class="mh">0x7fc1ffee1d30</span><span class="o">&gt;</span>
21802180
</pre></div>
21812181
</div>
21822182
</div>

‎docs/2.3/generated/exportdb/python.closure.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -477,7 +477,7 @@ <h1>python.closure<a class="headerlink" href="#python-closure" title="Permalink
477477
<h2>cond_closed_over_variable<a class="headerlink" href="#cond-closed-over-variable" title="Permalink to this heading"></a></h2>
478478
<div class="admonition note">
479479
<p class="admonition-title">Note</p>
480-
<p>Tags: <a class="reference internal" href="torch.cond.html"><span class="doc">torch.cond</span></a>, <a class="reference internal" href="#"><span class="doc">python.closure</span></a></p>
480+
<p>Tags: <a class="reference internal" href="#"><span class="doc">python.closure</span></a>, <a class="reference internal" href="torch.cond.html"><span class="doc">torch.cond</span></a></p>
481481
<p>Support Level: SUPPORTED</p>
482482
</div>
483483
<p>Original source code:</p>

‎docs/2.3/generated/exportdb/python.control-flow.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -515,7 +515,7 @@ <h2>dynamic_shape_if_guard<a class="headerlink" href="#dynamic-shape-if-guard" t
515515
<h2>list_unpack<a class="headerlink" href="#list-unpack" title="Permalink to this heading"></a></h2>
516516
<div class="admonition note">
517517
<p class="admonition-title">Note</p>
518-
<p>Tags: <a class="reference internal" href="#"><span class="doc">python.control-flow</span></a>, <a class="reference internal" href="python.data-structure.html"><span class="doc">python.data-structure</span></a></p>
518+
<p>Tags: <a class="reference internal" href="python.data-structure.html"><span class="doc">python.data-structure</span></a>, <a class="reference internal" href="#"><span class="doc">python.control-flow</span></a></p>
519519
<p>Support Level: SUPPORTED</p>
520520
</div>
521521
<p>Original source code:</p>

‎docs/2.3/generated/exportdb/python.data-structure.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -610,7 +610,7 @@ <h2>list_contains<a class="headerlink" href="#list-contains" title="Permalink to
610610
<h2>list_unpack<a class="headerlink" href="#list-unpack" title="Permalink to this heading"></a></h2>
611611
<div class="admonition note">
612612
<p class="admonition-title">Note</p>
613-
<p>Tags: <a class="reference internal" href="python.control-flow.html"><span class="doc">python.control-flow</span></a>, <a class="reference internal" href="#"><span class="doc">python.data-structure</span></a></p>
613+
<p>Tags: <a class="reference internal" href="#"><span class="doc">python.data-structure</span></a>, <a class="reference internal" href="python.control-flow.html"><span class="doc">python.control-flow</span></a></p>
614614
<p>Support Level: SUPPORTED</p>
615615
</div>
616616
<p>Original source code:</p>

‎docs/2.3/generated/exportdb/torch.cond.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -717,7 +717,7 @@ <h2>cond_branch_nonlocal_variables<a class="headerlink" href="#cond-branch-nonlo
717717
<h2>cond_closed_over_variable<a class="headerlink" href="#cond-closed-over-variable" title="Permalink to this heading"></a></h2>
718718
<div class="admonition note">
719719
<p class="admonition-title">Note</p>
720-
<p>Tags: <a class="reference internal" href="#"><span class="doc">torch.cond</span></a>, <a class="reference internal" href="python.closure.html"><span class="doc">python.closure</span></a></p>
720+
<p>Tags: <a class="reference internal" href="python.closure.html"><span class="doc">python.closure</span></a>, <a class="reference internal" href="#"><span class="doc">torch.cond</span></a></p>
721721
<p>Support Level: SUPPORTED</p>
722722
</div>
723723
<p>Original source code:</p>

0 commit comments

Comments
 (0)