Skip to content

Commit c39eaa7

Browse files
pytorchbotpytorchbot
committed
auto-generating sphinx docs
1 parent e2b3f67 commit c39eaa7

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

+597
-601
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: 70ea54c860b1ca3e07a20e4470914a97
3+
config: 5c9c098f2b2b63c7722a5b518429df6c
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/_modules/torch.html

+23-23
Original file line numberDiff line numberDiff line change
@@ -557,36 +557,36 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
557557
<span class="k">def</span> <span class="nf">typename</span><span class="p">(</span><span class="n">o</span><span class="p">):</span>
558558
<span class="n">module</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
559559
<span class="n">class_name</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
560-
<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> \
561-
<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>
562-
<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>
560+
<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> \
561+
<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>
562+
<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>
563563

564564
<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>
565-
<span class="n">class_name</span> <span class="o">=</span> <span class="n">o</span><span class="o">.</span><span class="vm">__qualname__</span>
565+
<span class="n">class_name</span> <span class="o">=</span> <span class="n">o</span><span class="o">.</span><span class="n">__qualname__</span>
566566
<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>
567-
<span class="n">class_name</span> <span class="o">=</span> <span class="n">o</span><span class="o">.</span><span class="vm">__name__</span>
567+
<span class="n">class_name</span> <span class="o">=</span> <span class="n">o</span><span class="o">.</span><span class="n">__name__</span>
568568
<span class="k">else</span><span class="p">:</span>
569-
<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>
569+
<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>
570570

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

573573

574574
<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>
575-
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Returns True if `obj` is a pytorch tensor.</span>
575+
<span class="sd">r&quot;&quot;&quot;Returns True if `obj` is a pytorch tensor.</span>
576576

577577
<span class="sd"> Args:</span>
578578
<span class="sd"> obj (Object): Object to test</span>
579579
<span class="sd"> &quot;&quot;&quot;</span>
580-
<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>
580+
<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>
581581

582582

583583
<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>
584-
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Returns True if `obj` is a pytorch storage object.</span>
584+
<span class="sd">r&quot;&quot;&quot;Returns True if `obj` is a pytorch storage object.</span>
585585

586586
<span class="sd"> Args:</span>
587587
<span class="sd"> obj (Object): Object to test</span>
588588
<span class="sd"> &quot;&quot;&quot;</span>
589-
<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>
589+
<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>
590590

591591

592592
<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>
@@ -598,7 +598,7 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
598598

599599

600600
<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>
601-
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Sets the random number generator state.</span>
601+
<span class="sd">r&quot;&quot;&quot;Sets the random number generator state.</span>
602602

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

608608

609609
<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>
610-
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Returns the random number generator state as a ByteTensor.&quot;&quot;&quot;</span>
610+
<span class="sd">r&quot;&quot;&quot;Returns the random number generator state as a ByteTensor.&quot;&quot;&quot;</span>
611611
<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>
612612

613613

614614
<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>
615-
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Sets the seed for generating random numbers. And returns a</span>
615+
<span class="sd">r&quot;&quot;&quot;Sets the seed for generating random numbers. And returns a</span>
616616
<span class="sd"> `torch._C.Generator` object.</span>
617617

618618
<span class="sd"> Args:</span>
@@ -622,7 +622,7 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
622622

623623

624624
<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>
625-
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Returns the initial seed for generating random numbers as a</span>
625+
<span class="sd">r&quot;&quot;&quot;Returns the initial seed for generating random numbers as a</span>
626626
<span class="sd"> python `long`.</span>
627627
<span class="sd"> &quot;&quot;&quot;</span>
628628
<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>
@@ -677,7 +677,7 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
677677
<span class="k">return</span> <span class="kc">True</span>
678678

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

683683

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

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

693693

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

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

703703

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

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

713713

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

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

723723

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

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

733733

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

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

744744

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

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

754754

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

778778
<span class="c1"># Shared memory manager needs to know the exact location of manager executable</span>
779779
<span class="kn">import</span> <span class="nn">os</span>
780-
<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>
780+
<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>
781781
<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>
782782
<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>
783783

0 commit comments

Comments
 (0)