Skip to content

Commit e0c0c98

Browse files
committed
Generate Python docs from pytorch/pytorch@1c5a812
1 parent 016aac8 commit e0c0c98

18 files changed

+395
-395
lines changed

docs/master/_images/RReLU.png

372 Bytes
Loading

docs/master/_modules/torch/_jit_internal.html

+8-8
Original file line numberDiff line numberDiff line change
@@ -867,7 +867,7 @@ <h1>Source code for torch._jit_internal</h1><div class="highlight"><pre>
867867
<span class="s2">&quot;if this method is not scripted, copy the python method onto the scripted model&quot;</span>
868868

869869

870-
<span class="k">def</span> <span class="nf">export</span><span class="p">(</span><span class="n">fn</span><span class="p">):</span>
870+
<div class="viewcode-block" id="export"><a class="viewcode-back" href="../../jit.html#torch.jit.export">[docs]</a><span class="k">def</span> <span class="nf">export</span><span class="p">(</span><span class="n">fn</span><span class="p">):</span>
871871
<span class="sd">&quot;&quot;&quot;</span>
872872
<span class="sd"> This decorator indicates that a method on an ``nn.Module`` is used as an entry point into a</span>
873873
<span class="sd"> :class:`ScriptModule` and should be compiled.</span>
@@ -910,10 +910,10 @@ <h1>Source code for torch._jit_internal</h1><div class="highlight"><pre>
910910
<span class="sd"> m = torch.jit.script(MyModule())</span>
911911
<span class="sd"> &quot;&quot;&quot;</span>
912912
<span class="n">fn</span><span class="o">.</span><span class="n">_torchscript_modifier</span> <span class="o">=</span> <span class="n">FunctionModifiers</span><span class="o">.</span><span class="n">EXPORT</span>
913-
<span class="k">return</span> <span class="n">fn</span>
913+
<span class="k">return</span> <span class="n">fn</span></div>
914914

915915

916-
<div class="viewcode-block" id="unused"><a class="viewcode-back" href="../../generated/torch.jit.unused.html#torch.jit.unused">[docs]</a><span class="k">def</span> <span class="nf">unused</span><span class="p">(</span><span class="n">fn</span><span class="p">):</span>
916+
<span class="k">def</span> <span class="nf">unused</span><span class="p">(</span><span class="n">fn</span><span class="p">):</span>
917917
<span class="sd">&quot;&quot;&quot;</span>
918918
<span class="sd"> This decorator indicates to the compiler that a function or method should</span>
919919
<span class="sd"> be ignored and replaced with the raising of an exception. This allows you</span>
@@ -960,7 +960,7 @@ <h1>Source code for torch._jit_internal</h1><div class="highlight"><pre>
960960
<span class="k">return</span> <span class="n">prop</span>
961961

962962
<span class="n">fn</span><span class="o">.</span><span class="n">_torchscript_modifier</span> <span class="o">=</span> <span class="n">FunctionModifiers</span><span class="o">.</span><span class="n">UNUSED</span>
963-
<span class="k">return</span> <span class="n">fn</span></div>
963+
<span class="k">return</span> <span class="n">fn</span>
964964

965965
<span class="c1"># No op context manager from python side</span>
966966
<span class="k">class</span> <span class="nc">_IgnoreContextManager</span><span class="p">(</span><span class="n">contextlib</span><span class="o">.</span><span class="n">AbstractContextManager</span><span class="p">):</span>
@@ -970,7 +970,7 @@ <h1>Source code for torch._jit_internal</h1><div class="highlight"><pre>
970970
<span class="k">def</span> <span class="fm">__exit__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exc_type</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span> <span class="n">exc_value</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span> <span class="n">traceback</span><span class="p">:</span> <span class="n">Any</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
971971
<span class="k">pass</span>
972972

973-
<div class="viewcode-block" id="ignore"><a class="viewcode-back" href="../../generated/torch.jit.ignore.html#torch.jit.ignore">[docs]</a><span class="k">def</span> <span class="nf">ignore</span><span class="p">(</span><span class="n">drop</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
973+
<span class="k">def</span> <span class="nf">ignore</span><span class="p">(</span><span class="n">drop</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
974974
<span class="sd">&quot;&quot;&quot;</span>
975975
<span class="sd"> This decorator indicates to the compiler that a function or method should</span>
976976
<span class="sd"> be ignored and left as a Python function. This allows you to leave code in</span>
@@ -1061,7 +1061,7 @@ <h1>Source code for torch._jit_internal</h1><div class="highlight"><pre>
10611061
<span class="k">else</span><span class="p">:</span>
10621062
<span class="n">fn</span><span class="o">.</span><span class="n">_torchscript_modifier</span> <span class="o">=</span> <span class="n">FunctionModifiers</span><span class="o">.</span><span class="n">IGNORE</span>
10631063
<span class="k">return</span> <span class="n">fn</span>
1064-
<span class="k">return</span> <span class="n">decorator</span></div>
1064+
<span class="k">return</span> <span class="n">decorator</span>
10651065

10661066

10671067
<span class="k">def</span> <span class="nf">_copy_to_script_wrapper</span><span class="p">(</span><span class="n">fn</span><span class="p">):</span>
@@ -1359,7 +1359,7 @@ <h1>Source code for torch._jit_internal</h1><div class="highlight"><pre>
13591359
<span class="nb">globals</span><span class="p">()[</span><span class="sa">f</span><span class="s2">&quot;BroadcastingList</span><span class="si">{</span><span class="n">i</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">BroadcastingList1</span>
13601360

13611361

1362-
<span class="k">def</span> <span class="nf">is_scripting</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
1362+
<div class="viewcode-block" id="is_scripting"><a class="viewcode-back" href="../../jit_language_reference.html#torch.jit.is_scripting">[docs]</a><span class="k">def</span> <span class="nf">is_scripting</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
13631363
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;</span>
13641364
<span class="sd"> Function that returns True when in compilation and False otherwise. This</span>
13651365
<span class="sd"> is useful especially with the @unused decorator to leave code in your</span>
@@ -1378,7 +1378,7 @@ <h1>Source code for torch._jit_internal</h1><div class="highlight"><pre>
13781378
<span class="sd"> else:</span>
13791379
<span class="sd"> return unsupported_linear_op(x)</span>
13801380
<span class="sd"> &quot;&quot;&quot;</span>
1381-
<span class="k">return</span> <span class="kc">False</span>
1381+
<span class="k">return</span> <span class="kc">False</span></div>
13821382

13831383

13841384
<span class="c1"># Retrieves a fully-qualified name (module hierarchy + classname) for a given obj.</span>

0 commit comments

Comments
 (0)