Skip to content

Commit 0ca92a1

Browse files
committed
Generate Python docs from pytorch/pytorch@b3308c4
1 parent cb8becb commit 0ca92a1

File tree

2,293 files changed

+3573
-4648
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,293 files changed

+3573
-4648
lines changed

docs/main/_images/RReLU.png

-68 Bytes
Loading

docs/main/_modules/index.html

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@
242242
<div class="pytorch-left-menu-search">
243243

244244
<div class="version">
245-
<a href='https://pytorch.org/docs/versions.html'>main (2.2.0a0+git1e260c8 ) &#x25BC</a>
245+
<a href='https://pytorch.org/docs/versions.html'>main (2.2.0a0+gitb3308c4 ) &#x25BC</a>
246246
</div>
247247

248248

@@ -605,8 +605,6 @@ <h1>All modules for which code is available</h1>
605605
<li><a href="torch/distributed/rpc/functions.html">torch.distributed.rpc.functions</a></li>
606606
<li><a href="torch/distributed/rpc/options.html">torch.distributed.rpc.options</a></li>
607607
</ul><li><a href="torch/distributed/tensor/parallel/api.html">torch.distributed.tensor.parallel.api</a></li>
608-
<li><a href="torch/distributed/tensor/parallel/ddp.html">torch.distributed.tensor.parallel.ddp</a></li>
609-
<li><a href="torch/distributed/tensor/parallel/fsdp.html">torch.distributed.tensor.parallel.fsdp</a></li>
610608
<li><a href="torch/distributed/tensor/parallel/style.html">torch.distributed.tensor.parallel.style</a></li>
611609
</ul><li><a href="torch/distributions/bernoulli.html">torch.distributions.bernoulli</a></li>
612610
<li><a href="torch/distributions/beta.html">torch.distributions.beta</a></li>

docs/main/_modules/torch.html

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

244244
<div class="version">
245-
<a href='https://pytorch.org/docs/versions.html'>main (2.2.0a0+git1e260c8 ) &#x25BC</a>
245+
<a href='https://pytorch.org/docs/versions.html'>main (2.2.0a0+gitb3308c4 ) &#x25BC</a>
246246
</div>
247247

248248

docs/main/_modules/torch/__config__.html

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

244244
<div class="version">
245-
<a href='https://pytorch.org/docs/versions.html'>main (2.2.0a0+git1e260c8 ) &#x25BC</a>
245+
<a href='https://pytorch.org/docs/versions.html'>main (2.2.0a0+gitb3308c4 ) &#x25BC</a>
246246
</div>
247247

248248

docs/main/_modules/torch/_jit_internal.html

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

244244
<div class="version">
245-
<a href='https://pytorch.org/docs/versions.html'>main (2.2.0a0+git1e260c8 ) &#x25BC</a>
245+
<a href='https://pytorch.org/docs/versions.html'>main (2.2.0a0+gitb3308c4 ) &#x25BC</a>
246246
</div>
247247

248248

docs/main/_modules/torch/_lobpcg.html

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

244244
<div class="version">
245-
<a href='https://pytorch.org/docs/versions.html'>main (2.2.0a0+git1e260c8 ) &#x25BC</a>
245+
<a href='https://pytorch.org/docs/versions.html'>main (2.2.0a0+gitb3308c4 ) &#x25BC</a>
246246
</div>
247247

248248

docs/main/_modules/torch/_logging/_internal.html

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@
242242
<div class="pytorch-left-menu-search">
243243

244244
<div class="version">
245-
<a href='https://pytorch.org/docs/versions.html'>main (2.2.0a0+git1e260c8 ) &#x25BC</a>
245+
<a href='https://pytorch.org/docs/versions.html'>main (2.2.0a0+gitb3308c4 ) &#x25BC</a>
246246
</div>
247247

248248

@@ -641,7 +641,7 @@ <h1>Source code for torch._logging._internal</h1><div class="highlight"><pre>
641641

642642
<div class="viewcode-block" id="set_logs"><a class="viewcode-back" href="../../../generated/torch._logging.set_logs.html#torch._logging.set_logs">[docs]</a><span class="k">def</span> <span class="nf">set_logs</span><span class="p">(</span>
643643
<span class="o">*</span><span class="p">,</span>
644-
<span class="nb">all</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="n">DEFAULT_LOG_LEVEL</span><span class="p">,</span>
644+
<span class="nb">all</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
645645
<span class="n">dynamo</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
646646
<span class="n">aot</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
647647
<span class="n">dynamic</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
@@ -658,6 +658,7 @@ <h1>Source code for torch._logging._internal</h1><div class="highlight"><pre>
658658
<span class="n">graph_sizes</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
659659
<span class="n">guards</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
660660
<span class="n">recompiles</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
661+
<span class="n">recompiles_verbose</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
661662
<span class="n">trace_source</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
662663
<span class="n">trace_call</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
663664
<span class="n">output_code</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
@@ -764,6 +765,10 @@ <h1>Source code for torch._logging._internal</h1><div class="highlight"><pre>
764765
<span class="sd"> Whether to emit a guard failure reason and message every time</span>
765766
<span class="sd"> TorchDynamo recompiles a function. Default: ``False``</span>
766767

768+
<span class="sd"> recompiles_verbose (:class:`bool`):</span>
769+
<span class="sd"> Whether to emit all guard failure reasons when TorchDynamo recompiles</span>
770+
<span class="sd"> a function, even those that are not actually run. Default: ``False``</span>
771+
767772
<span class="sd"> trace_source (:class:`bool`):</span>
768773
<span class="sd"> Whether to emit when TorchDynamo begins tracing a new line. Default: ``False``</span>
769774

@@ -875,6 +880,7 @@ <h1>Source code for torch._logging._internal</h1><div class="highlight"><pre>
875880
<span class="n">graph_sizes</span><span class="o">=</span><span class="n">graph_sizes</span><span class="p">,</span>
876881
<span class="n">guards</span><span class="o">=</span><span class="n">guards</span><span class="p">,</span>
877882
<span class="n">recompiles</span><span class="o">=</span><span class="n">recompiles</span><span class="p">,</span>
883+
<span class="n">recompiles_verbose</span><span class="o">=</span><span class="n">recompiles_verbose</span><span class="p">,</span>
878884
<span class="n">trace_source</span><span class="o">=</span><span class="n">trace_source</span><span class="p">,</span>
879885
<span class="n">trace_call</span><span class="o">=</span><span class="n">trace_call</span><span class="p">,</span>
880886
<span class="n">output_code</span><span class="o">=</span><span class="n">output_code</span><span class="p">,</span>
@@ -1234,12 +1240,15 @@ <h1>Source code for torch._logging._internal</h1><div class="highlight"><pre>
12341240
<span class="c1"># First, reset all known (registered) loggers to NOTSET, so that they</span>
12351241
<span class="c1"># respect their parent log level</span>
12361242
<span class="k">for</span> <span class="n">log_qname</span> <span class="ow">in</span> <span class="n">log_registry</span><span class="o">.</span><span class="n">get_log_qnames</span><span class="p">():</span>
1243+
<span class="c1"># But not the top level torch level: this defaults to WARNING so</span>
1244+
<span class="c1"># that our log messages don&#39;t leak to the lower levels</span>
1245+
<span class="k">if</span> <span class="n">log_qname</span> <span class="o">==</span> <span class="s2">&quot;torch&quot;</span><span class="p">:</span>
1246+
<span class="k">continue</span>
12371247
<span class="n">log</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="n">log_qname</span><span class="p">)</span>
12381248
<span class="n">log</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">NOTSET</span><span class="p">)</span>
12391249

12401250
<span class="c1"># Now, for all loggers which the user requested to have non-standard</span>
1241-
<span class="c1"># logging behavior (and torch, because we always toggle torch), modify</span>
1242-
<span class="c1"># their log levels</span>
1251+
<span class="c1"># logging behavior, modify their log levels</span>
12431252
<span class="k">for</span> <span class="n">log_qname</span><span class="p">,</span> <span class="n">level</span> <span class="ow">in</span> <span class="n">log_state</span><span class="o">.</span><span class="n">get_log_level_pairs</span><span class="p">():</span>
12441253
<span class="n">log</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="n">log_qname</span><span class="p">)</span>
12451254
<span class="n">log</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">level</span><span class="p">)</span>

docs/main/_modules/torch/_lowrank.html

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

244244
<div class="version">
245-
<a href='https://pytorch.org/docs/versions.html'>main (2.2.0a0+git1e260c8 ) &#x25BC</a>
245+
<a href='https://pytorch.org/docs/versions.html'>main (2.2.0a0+gitb3308c4 ) &#x25BC</a>
246246
</div>
247247

248248

docs/main/_modules/torch/_tensor.html

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@
242242
<div class="pytorch-left-menu-search">
243243

244244
<div class="version">
245-
<a href='https://pytorch.org/docs/versions.html'>main (2.2.0a0+git1e260c8 ) &#x25BC</a>
245+
<a href='https://pytorch.org/docs/versions.html'>main (2.2.0a0+gitb3308c4 ) &#x25BC</a>
246246
</div>
247247

248248

@@ -480,7 +480,7 @@ <h1>Source code for torch._tensor</h1><div class="highlight"><pre>
480480
<span class="kn">from</span> <span class="nn">collections</span> <span class="kn">import</span> <span class="n">OrderedDict</span>
481481
<span class="kn">from</span> <span class="nn">copy</span> <span class="kn">import</span> <span class="n">deepcopy</span>
482482
<span class="kn">from</span> <span class="nn">numbers</span> <span class="kn">import</span> <span class="n">Number</span>
483-
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Set</span><span class="p">,</span> <span class="n">Tuple</span><span class="p">,</span> <span class="n">Union</span>
483+
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Tuple</span><span class="p">,</span> <span class="n">Union</span>
484484

485485
<span class="kn">import</span> <span class="nn">torch</span>
486486
<span class="kn">import</span> <span class="nn">torch._C</span> <span class="k">as</span> <span class="nn">_C</span>
@@ -554,9 +554,6 @@ <h1>Source code for torch._tensor</h1><div class="highlight"><pre>
554554
<span class="c1"># torch/_C/__init__.pyi.in to add a type annotation for your method;</span>
555555
<span class="c1"># otherwise, it will not show up in autocomplete.</span>
556556
<span class="k">class</span> <span class="nc">Tensor</span><span class="p">(</span><span class="n">torch</span><span class="o">.</span><span class="n">_C</span><span class="o">.</span><span class="n">TensorBase</span><span class="p">):</span>
557-
<span class="n">_dynamo_static_input_type</span><span class="p">:</span> <span class="nb">str</span> <span class="c1"># Set in `mark_static_address`</span>
558-
<span class="n">_dynamo_dynamic_indices</span><span class="p">:</span> <span class="n">Set</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="c1"># Set in `mark_dynamic`</span>
559-
560557
<span class="k">def</span> <span class="nf">__deepcopy__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">memo</span><span class="p">):</span>
561558
<span class="k">if</span> <span class="n">has_torch_function_unary</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
562559
<span class="k">return</span> <span class="n">handle_torch_function</span><span class="p">(</span><span class="n">Tensor</span><span class="o">.</span><span class="n">__deepcopy__</span><span class="p">,</span> <span class="p">(</span><span class="bp">self</span><span class="p">,),</span> <span class="bp">self</span><span class="p">,</span> <span class="n">memo</span><span class="p">)</span>

docs/main/_modules/torch/_tensor_str.html

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@
242242
<div class="pytorch-left-menu-search">
243243

244244
<div class="version">
245-
<a href='https://pytorch.org/docs/versions.html'>main (2.2.0a0+git1e260c8 ) &#x25BC</a>
245+
<a href='https://pytorch.org/docs/versions.html'>main (2.2.0a0+gitb3308c4 ) &#x25BC</a>
246246
</div>
247247

248248

@@ -1076,11 +1076,22 @@ <h1>Source code for torch._tensor_str</h1><div class="highlight"><pre>
10761076

10771077
<span class="c1"># Use inp here to get the original grad_fn and not the one generated by the forward grad</span>
10781078
<span class="c1"># unpacking.</span>
1079-
<span class="k">if</span> <span class="n">inp</span><span class="o">.</span><span class="n">grad_fn</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
1080-
<span class="n">name</span> <span class="o">=</span> <span class="nb">type</span><span class="p">(</span><span class="n">inp</span><span class="o">.</span><span class="n">grad_fn</span><span class="p">)</span><span class="o">.</span><span class="vm">__name__</span>
1081-
<span class="k">if</span> <span class="n">name</span> <span class="o">==</span> <span class="s2">&quot;CppFunction&quot;</span><span class="p">:</span>
1082-
<span class="n">name</span> <span class="o">=</span> <span class="n">inp</span><span class="o">.</span><span class="n">grad_fn</span><span class="o">.</span><span class="n">name</span><span class="p">()</span><span class="o">.</span><span class="n">rsplit</span><span class="p">(</span><span class="s2">&quot;::&quot;</span><span class="p">,</span> <span class="mi">1</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
1083-
<span class="n">suffixes</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;grad_fn=&lt;</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">&gt;&quot;</span><span class="p">)</span>
1079+
<span class="n">grad_fn_name</span> <span class="o">=</span> <span class="kc">None</span>
1080+
<span class="k">try</span><span class="p">:</span>
1081+
<span class="n">grad_fn</span> <span class="o">=</span> <span class="n">inp</span><span class="o">.</span><span class="n">grad_fn</span>
1082+
<span class="k">except</span> <span class="ne">RuntimeError</span><span class="p">:</span>
1083+
<span class="c1"># Accessing the grad_fn calls rebasing logic which would cause an error</span>
1084+
<span class="c1"># if that tensor is a view created in no-grad mode modified in-place in</span>
1085+
<span class="c1"># no-grad mode. See: https://github.com/pytorch/pytorch/issues/99968</span>
1086+
<span class="n">grad_fn_name</span> <span class="o">=</span> <span class="s2">&quot;Invalid&quot;</span>
1087+
1088+
<span class="k">if</span> <span class="n">grad_fn_name</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">grad_fn</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
1089+
<span class="n">grad_fn_name</span> <span class="o">=</span> <span class="nb">type</span><span class="p">(</span><span class="n">grad_fn</span><span class="p">)</span><span class="o">.</span><span class="vm">__name__</span>
1090+
<span class="k">if</span> <span class="n">grad_fn_name</span> <span class="o">==</span> <span class="s2">&quot;CppFunction&quot;</span><span class="p">:</span>
1091+
<span class="n">grad_fn_name</span> <span class="o">=</span> <span class="n">grad_fn</span><span class="o">.</span><span class="n">name</span><span class="p">()</span><span class="o">.</span><span class="n">rsplit</span><span class="p">(</span><span class="s2">&quot;::&quot;</span><span class="p">,</span> <span class="mi">1</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
1092+
1093+
<span class="k">if</span> <span class="n">grad_fn_name</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
1094+
<span class="n">suffixes</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;grad_fn=&lt;</span><span class="si">{</span><span class="n">grad_fn_name</span><span class="si">}</span><span class="s2">&gt;&quot;</span><span class="p">)</span>
10841095
<span class="k">elif</span> <span class="n">inp</span><span class="o">.</span><span class="n">requires_grad</span><span class="p">:</span>
10851096
<span class="n">suffixes</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">&quot;requires_grad=True&quot;</span><span class="p">)</span>
10861097

docs/main/_modules/torch/_utils.html

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

244244
<div class="version">
245-
<a href='https://pytorch.org/docs/versions.html'>main (2.2.0a0+git1e260c8 ) &#x25BC</a>
245+
<a href='https://pytorch.org/docs/versions.html'>main (2.2.0a0+gitb3308c4 ) &#x25BC</a>
246246
</div>
247247

248248

docs/main/_modules/torch/amp/autocast_mode.html

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

244244
<div class="version">
245-
<a href='https://pytorch.org/docs/versions.html'>main (2.2.0a0+git1e260c8 ) &#x25BC</a>
245+
<a href='https://pytorch.org/docs/versions.html'>main (2.2.0a0+gitb3308c4 ) &#x25BC</a>
246246
</div>
247247

248248

docs/main/_modules/torch/ao/nn/intrinsic/modules/fused.html

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

244244
<div class="version">
245-
<a href='https://pytorch.org/docs/versions.html'>main (2.2.0a0+git1e260c8 ) &#x25BC</a>
245+
<a href='https://pytorch.org/docs/versions.html'>main (2.2.0a0+gitb3308c4 ) &#x25BC</a>
246246
</div>
247247

248248

docs/main/_modules/torch/ao/nn/intrinsic/qat/modules/conv_fused.html

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

244244
<div class="version">
245-
<a href='https://pytorch.org/docs/versions.html'>main (2.2.0a0+git1e260c8 ) &#x25BC</a>
245+
<a href='https://pytorch.org/docs/versions.html'>main (2.2.0a0+gitb3308c4 ) &#x25BC</a>
246246
</div>
247247

248248

docs/main/_modules/torch/ao/nn/intrinsic/qat/modules/linear_relu.html

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

244244
<div class="version">
245-
<a href='https://pytorch.org/docs/versions.html'>main (2.2.0a0+git1e260c8 ) &#x25BC</a>
245+
<a href='https://pytorch.org/docs/versions.html'>main (2.2.0a0+gitb3308c4 ) &#x25BC</a>
246246
</div>
247247

248248

docs/main/_modules/torch/ao/nn/intrinsic/quantized/dynamic/modules/linear_relu.html

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

244244
<div class="version">
245-
<a href='https://pytorch.org/docs/versions.html'>main (2.2.0a0+git1e260c8 ) &#x25BC</a>
245+
<a href='https://pytorch.org/docs/versions.html'>main (2.2.0a0+gitb3308c4 ) &#x25BC</a>
246246
</div>
247247

248248

docs/main/_modules/torch/ao/nn/intrinsic/quantized/modules/bn_relu.html

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

244244
<div class="version">
245-
<a href='https://pytorch.org/docs/versions.html'>main (2.2.0a0+git1e260c8 ) &#x25BC</a>
245+
<a href='https://pytorch.org/docs/versions.html'>main (2.2.0a0+gitb3308c4 ) &#x25BC</a>
246246
</div>
247247

248248

0 commit comments

Comments
 (0)