Skip to content

Commit 71a6c7c

Browse files
pytorchbotpytorchbot
committed
auto-generating sphinx docs
1 parent 49d9fc6 commit 71a6c7c

Some content is hidden

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

55 files changed

+598
-594
lines changed

‎docs/.buildinfo

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 5c9c098f2b2b63c7722a5b518429df6c
3+
config: 70ea54c860b1ca3e07a20e4470914a97
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/_modules/torch.html

+23-23
Original file line numberDiff line numberDiff line change
@@ -556,36 +556,36 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
556556
<span class="k">def</span> <span class="nf">typename</span><span class="p">(</span><span class="n">o</span><span class="p">):</span>
557557
<span class="n">module</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
558558
<span class="n">class_name</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
559-
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">o</span><span class="p">,</span> <span class="s1">&#39;__module__&#39;</span><span class="p">)</span> <span class="ow">and</span> <span class="n">o</span><span class="o">.</span><span class="n">__module__</span> <span class="o">!=</span> <span class="s1">&#39;builtins&#39;</span> \
560-
<span class="ow">and</span> <span class="n">o</span><span class="o">.</span><span class="n">__module__</span> <span class="o">!=</span> <span class="s1">&#39;__builtin__&#39;</span> <span class="ow">and</span> <span class="n">o</span><span class="o">.</span><span class="n">__module__</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
561-
<span class="n">module</span> <span class="o">=</span> <span class="n">o</span><span class="o">.</span><span class="n">__module__</span> <span class="o">+</span> <span class="s1">&#39;.&#39;</span>
559+
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">o</span><span class="p">,</span> <span class="s1">&#39;__module__&#39;</span><span class="p">)</span> <span class="ow">and</span> <span class="n">o</span><span class="o">.</span><span class="vm">__module__</span> <span class="o">!=</span> <span class="s1">&#39;builtins&#39;</span> \
560+
<span class="ow">and</span> <span class="n">o</span><span class="o">.</span><span class="vm">__module__</span> <span class="o">!=</span> <span class="s1">&#39;__builtin__&#39;</span> <span class="ow">and</span> <span class="n">o</span><span class="o">.</span><span class="vm">__module__</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
561+
<span class="n">module</span> <span class="o">=</span> <span class="n">o</span><span class="o">.</span><span class="vm">__module__</span> <span class="o">+</span> <span class="s1">&#39;.&#39;</span>
562562

563563
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">o</span><span class="p">,</span> <span class="s1">&#39;__qualname__&#39;</span><span class="p">):</span>
564-
<span class="n">class_name</span> <span class="o">=</span> <span class="n">o</span><span class="o">.</span><span class="n">__qualname__</span>
564+
<span class="n">class_name</span> <span class="o">=</span> <span class="n">o</span><span class="o">.</span><span class="vm">__qualname__</span>
565565
<span class="k">elif</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">o</span><span class="p">,</span> <span class="s1">&#39;__name__&#39;</span><span class="p">):</span>
566-
<span class="n">class_name</span> <span class="o">=</span> <span class="n">o</span><span class="o">.</span><span class="n">__name__</span>
566+
<span class="n">class_name</span> <span class="o">=</span> <span class="n">o</span><span class="o">.</span><span class="vm">__name__</span>
567567
<span class="k">else</span><span class="p">:</span>
568-
<span class="n">class_name</span> <span class="o">=</span> <span class="n">o</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span>
568+
<span class="n">class_name</span> <span class="o">=</span> <span class="n">o</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span>
569569

570570
<span class="k">return</span> <span class="n">module</span> <span class="o">+</span> <span class="n">class_name</span>
571571

572572

573573
<div class="viewcode-block" id="is_tensor"><a class="viewcode-back" href="../torch.html#torch.is_tensor">[docs]</a><span class="k">def</span> <span class="nf">is_tensor</span><span class="p">(</span><span class="n">obj</span><span class="p">):</span>
574-
<span class="sd">r&quot;&quot;&quot;Returns True if `obj` is a pytorch tensor.</span>
574+
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Returns True if `obj` is a pytorch tensor.</span>
575575

576576
<span class="sd"> Args:</span>
577577
<span class="sd"> obj (Object): Object to test</span>
578578
<span class="sd"> &quot;&quot;&quot;</span>
579-
<span class="k">return</span> <span class="n">obj</span><span class="o">.</span><span class="n">__class__</span> <span class="ow">in</span> <span class="n">_tensor_classes</span></div>
579+
<span class="k">return</span> <span class="n">obj</span><span class="o">.</span><span class="vm">__class__</span> <span class="ow">in</span> <span class="n">_tensor_classes</span></div>
580580

581581

582582
<div class="viewcode-block" id="is_storage"><a class="viewcode-back" href="../torch.html#torch.is_storage">[docs]</a><span class="k">def</span> <span class="nf">is_storage</span><span class="p">(</span><span class="n">obj</span><span class="p">):</span>
583-
<span class="sd">r&quot;&quot;&quot;Returns True if `obj` is a pytorch storage object.</span>
583+
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Returns True if `obj` is a pytorch storage object.</span>
584584

585585
<span class="sd"> Args:</span>
586586
<span class="sd"> obj (Object): Object to test</span>
587587
<span class="sd"> &quot;&quot;&quot;</span>
588-
<span class="k">return</span> <span class="n">obj</span><span class="o">.</span><span class="n">__class__</span> <span class="ow">in</span> <span class="n">_storage_classes</span></div>
588+
<span class="k">return</span> <span class="n">obj</span><span class="o">.</span><span class="vm">__class__</span> <span class="ow">in</span> <span class="n">_storage_classes</span></div>
589589

590590

591591
<div class="viewcode-block" id="set_default_tensor_type"><a class="viewcode-back" href="../torch.html#torch.set_default_tensor_type">[docs]</a><span class="k">def</span> <span class="nf">set_default_tensor_type</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
@@ -597,7 +597,7 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
597597

598598

599599
<div class="viewcode-block" id="set_rng_state"><a class="viewcode-back" href="../torch.html#torch.set_rng_state">[docs]</a><span class="k">def</span> <span class="nf">set_rng_state</span><span class="p">(</span><span class="n">new_state</span><span class="p">):</span>
600-
<span class="sd">r&quot;&quot;&quot;Sets the random number generator state.</span>
600+
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Sets the random number generator state.</span>
601601

602602
<span class="sd"> Args:</span>
603603
<span class="sd"> new_state (torch.ByteTensor): The desired state</span>
@@ -606,12 +606,12 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
606606

607607

608608
<div class="viewcode-block" id="get_rng_state"><a class="viewcode-back" href="../torch.html#torch.get_rng_state">[docs]</a><span class="k">def</span> <span class="nf">get_rng_state</span><span class="p">():</span>
609-
<span class="sd">r&quot;&quot;&quot;Returns the random number generator state as a ByteTensor.&quot;&quot;&quot;</span>
609+
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Returns the random number generator state as a ByteTensor.&quot;&quot;&quot;</span>
610610
<span class="k">return</span> <span class="n">default_generator</span><span class="o">.</span><span class="n">get_state</span><span class="p">()</span></div>
611611

612612

613613
<div class="viewcode-block" id="manual_seed"><a class="viewcode-back" href="../torch.html#torch.manual_seed">[docs]</a><span class="k">def</span> <span class="nf">manual_seed</span><span class="p">(</span><span class="n">seed</span><span class="p">):</span>
614-
<span class="sd">r&quot;&quot;&quot;Sets the seed for generating random numbers. And returns a</span>
614+
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Sets the seed for generating random numbers. And returns a</span>
615615
<span class="sd"> `torch._C.Generator` object.</span>
616616

617617
<span class="sd"> Args:</span>
@@ -621,7 +621,7 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
621621

622622

623623
<div class="viewcode-block" id="initial_seed"><a class="viewcode-back" href="../torch.html#torch.initial_seed">[docs]</a><span class="k">def</span> <span class="nf">initial_seed</span><span class="p">():</span>
624-
<span class="sd">r&quot;&quot;&quot;Returns the initial seed for generating random numbers as a</span>
624+
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Returns the initial seed for generating random numbers as a</span>
625625
<span class="sd"> python `long`.</span>
626626
<span class="sd"> &quot;&quot;&quot;</span>
627627
<span class="k">return</span> <span class="n">default_generator</span><span class="o">.</span><span class="n">initial_seed</span><span class="p">()</span></div>
@@ -676,7 +676,7 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
676676
<span class="k">return</span> <span class="kc">True</span>
677677

678678
<span class="nd">@classmethod</span>
679-
<span class="k">def</span> <span class="nf">storage_type</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
679+
<span class="k">def</span> <span class="nf">storage_type</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
680680
<span class="k">return</span> <span class="n">DoubleStorage</span>
681681

682682

@@ -686,7 +686,7 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
686686
<span class="k">return</span> <span class="kc">True</span>
687687

688688
<span class="nd">@classmethod</span>
689-
<span class="k">def</span> <span class="nf">storage_type</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
689+
<span class="k">def</span> <span class="nf">storage_type</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
690690
<span class="k">return</span> <span class="n">FloatStorage</span>
691691

692692

@@ -696,7 +696,7 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
696696
<span class="k">return</span> <span class="kc">True</span>
697697

698698
<span class="nd">@classmethod</span>
699-
<span class="k">def</span> <span class="nf">storage_type</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
699+
<span class="k">def</span> <span class="nf">storage_type</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
700700
<span class="k">return</span> <span class="n">HalfStorage</span>
701701

702702

@@ -706,7 +706,7 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
706706
<span class="k">return</span> <span class="kc">True</span>
707707

708708
<span class="nd">@classmethod</span>
709-
<span class="k">def</span> <span class="nf">storage_type</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
709+
<span class="k">def</span> <span class="nf">storage_type</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
710710
<span class="k">return</span> <span class="n">LongStorage</span>
711711

712712

@@ -716,7 +716,7 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
716716
<span class="k">return</span> <span class="kc">True</span>
717717

718718
<span class="nd">@classmethod</span>
719-
<span class="k">def</span> <span class="nf">storage_type</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
719+
<span class="k">def</span> <span class="nf">storage_type</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
720720
<span class="k">return</span> <span class="n">IntStorage</span>
721721

722722

@@ -726,7 +726,7 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
726726
<span class="k">return</span> <span class="kc">True</span>
727727

728728
<span class="nd">@classmethod</span>
729-
<span class="k">def</span> <span class="nf">storage_type</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
729+
<span class="k">def</span> <span class="nf">storage_type</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
730730
<span class="k">return</span> <span class="n">ShortStorage</span>
731731

732732

@@ -737,7 +737,7 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
737737
<span class="k">return</span> <span class="kc">False</span>
738738

739739
<span class="nd">@classmethod</span>
740-
<span class="k">def</span> <span class="nf">storage_type</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
740+
<span class="k">def</span> <span class="nf">storage_type</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
741741
<span class="k">return</span> <span class="n">CharStorage</span>
742742

743743

@@ -747,7 +747,7 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
747747
<span class="k">return</span> <span class="kc">False</span>
748748

749749
<span class="nd">@classmethod</span>
750-
<span class="k">def</span> <span class="nf">storage_type</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
750+
<span class="k">def</span> <span class="nf">storage_type</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
751751
<span class="k">return</span> <span class="n">ByteStorage</span>
752752

753753

@@ -776,7 +776,7 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
776776

777777
<span class="c1"># Shared memory manager needs to know the exact location of manager executable</span>
778778
<span class="kn">import</span> <span class="nn">os</span>
779-
<span class="n">manager_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">__file__</span><span class="p">)),</span> <span class="s1">&#39;lib&#39;</span><span class="p">,</span> <span class="s1">&#39;torch_shm_manager&#39;</span><span class="p">)</span>
779+
<span class="n">manager_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="vm">__file__</span><span class="p">)),</span> <span class="s1">&#39;lib&#39;</span><span class="p">,</span> <span class="s1">&#39;torch_shm_manager&#39;</span><span class="p">)</span>
780780
<span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">&gt;=</span> <span class="mi">3</span><span class="p">:</span>
781781
<span class="n">manager_path</span> <span class="o">=</span> <span class="nb">bytes</span><span class="p">(</span><span class="n">manager_path</span><span class="p">,</span> <span class="s1">&#39;ascii&#39;</span><span class="p">)</span>
782782

0 commit comments

Comments
 (0)