Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@psavine42
psavine42 committed May 25, 2018
1 parent 32807a5 commit 7f8501e
Show file tree
Hide file tree
Showing 26 changed files with 163 additions and 54 deletions.
Binary file modified docs/_build/doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/index.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/source/pytorchart.doctree
View file
Binary file not shown.
1 change: 0 additions & 1 deletion docs/_build/html/_modules/index.html
View file
Expand Up @@ -83,7 +83,6 @@
<li class="toctree-l1"><a class="reference internal" href="../source/pytorchart.Loggers.html">pytorchart.Loggers package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../source/modules.html">pytorchart</a></li>
<li class="toctree-l1"><a class="reference internal" href="../source/pytorchart.html">flexilogger</a></li>
<li class="toctree-l1"><a class="reference internal" href="../source/pytorchart.html">tooledmodel</a></li>
<li class="toctree-l1"><a class="reference internal" href="../source/pytorchart.moremeters.html">moremeters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../source/pytorchart.presets.html">presets</a></li>
</ul>
Expand Down
7 changes: 3 additions & 4 deletions docs/_build/html/_modules/pytorchart/Loggers/tracelogger.html
View file
Expand Up @@ -83,7 +83,6 @@
<li class="toctree-l1"><a class="reference internal" href="../../../source/pytorchart.Loggers.html">pytorchart.Loggers package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../source/modules.html">pytorchart</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../source/pytorchart.html">flexilogger</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../source/pytorchart.html">tooledmodel</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../source/pytorchart.moremeters.html">moremeters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../source/pytorchart.presets.html">presets</a></li>
</ul>
Expand Down Expand Up @@ -158,7 +157,7 @@ <h1>Source code for pytorchart.Loggers.tracelogger</h1><div class="highlight"><p
<span class="n">_nan</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="s1">&#39;NaN&#39;</span><span class="p">)</span>


<div class="viewcode-block" id="TraceLogger"><a class="viewcode-back" href="../../../source/pytorchart.Loggers.html#pytorchart.Loggers.tracelogger.TraceLogger">[docs]</a><span class="k">class</span> <span class="nc">TraceLogger</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<div class="viewcode-block" id="TraceLogger"><a class="viewcode-back" href="../../../source/pytorchart.html#pytorchart.Loggers.tracelogger.TraceLogger">[docs]</a><span class="k">class</span> <span class="nc">TraceLogger</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> TraceLogger has the same idea as tnt.VisdomLogger, but with more access to</span>
<span class="sd"> plotly properties directly, with the downside of being less flexible. Also,</span>
Expand Down Expand Up @@ -205,7 +204,7 @@ <h1>Source code for pytorchart.Loggers.tracelogger</h1><div class="highlight"><p
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_viz</span>

<div class="viewcode-block" id="TraceLogger.save"><a class="viewcode-back" href="../../../source/pytorchart.Loggers.html#pytorchart.Loggers.tracelogger.TraceLogger.save">[docs]</a> <span class="k">def</span> <span class="nf">save</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
<div class="viewcode-block" id="TraceLogger.save"><a class="viewcode-back" href="../../../source/pytorchart.html#pytorchart.Loggers.tracelogger.TraceLogger.save">[docs]</a> <span class="k">def</span> <span class="nf">save</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> saves self, and saves the visdom enviornment.</span>

Expand Down Expand Up @@ -299,7 +298,7 @@ <h1>Source code for pytorchart.Loggers.tracelogger</h1><div class="highlight"><p

<span class="k">return</span> <span class="n">data_to_send</span>

<div class="viewcode-block" id="TraceLogger.log"><a class="viewcode-back" href="../../../source/pytorchart.Loggers.html#pytorchart.Loggers.tracelogger.TraceLogger.log">[docs]</a> <span class="k">def</span> <span class="nf">log</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">X</span><span class="p">,</span> <span class="n">Y</span><span class="p">):</span>
<div class="viewcode-block" id="TraceLogger.log"><a class="viewcode-back" href="../../../source/pytorchart.html#pytorchart.Loggers.tracelogger.TraceLogger.log">[docs]</a> <span class="k">def</span> <span class="nf">log</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">X</span><span class="p">,</span> <span class="n">Y</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Same interface as torchnet.log(), applies metadata to the X,Y Values,</span>
<span class="sd"> and sends them to the visdom plot.</span>
Expand Down
1 change: 0 additions & 1 deletion docs/_build/html/_modules/pytorchart/flexilogger.html
View file
Expand Up @@ -83,7 +83,6 @@
<li class="toctree-l1"><a class="reference internal" href="../../source/pytorchart.Loggers.html">pytorchart.Loggers package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../source/modules.html">pytorchart</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../source/pytorchart.html">flexilogger</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../source/pytorchart.html">tooledmodel</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../source/pytorchart.moremeters.html">moremeters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../source/pytorchart.presets.html">presets</a></li>
</ul>
Expand Down
1 change: 0 additions & 1 deletion docs/_build/html/_modules/pytorchart/modelutils/modellogger.html
View file
Expand Up @@ -83,7 +83,6 @@
<li class="toctree-l1"><a class="reference internal" href="../../../source/pytorchart.Loggers.html">pytorchart.Loggers package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../source/modules.html">pytorchart</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../source/pytorchart.html">flexilogger</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../source/pytorchart.html">tooledmodel</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../source/pytorchart.moremeters.html">moremeters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../source/pytorchart.presets.html">presets</a></li>
</ul>
Expand Down
1 change: 0 additions & 1 deletion docs/_build/html/_modules/pytorchart/moremeters/bestmeter.html
View file
Expand Up @@ -83,7 +83,6 @@
<li class="toctree-l1"><a class="reference internal" href="../../../source/pytorchart.Loggers.html">pytorchart.Loggers package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../source/modules.html">pytorchart</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../source/pytorchart.html">flexilogger</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../source/pytorchart.html">tooledmodel</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../source/pytorchart.moremeters.html">moremeters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../source/pytorchart.presets.html">presets</a></li>
</ul>
Expand Down
1 change: 0 additions & 1 deletion docs/_build/html/_modules/pytorchart/moremeters/image_meter.html
View file
Expand Up @@ -83,7 +83,6 @@
<li class="toctree-l1"><a class="reference internal" href="../../../source/pytorchart.Loggers.html">pytorchart.Loggers package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../source/modules.html">pytorchart</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../source/pytorchart.html">flexilogger</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../source/pytorchart.html">tooledmodel</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../source/pytorchart.moremeters.html">moremeters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../source/pytorchart.presets.html">presets</a></li>
</ul>
Expand Down
1 change: 0 additions & 1 deletion docs/_build/html/_modules/pytorchart/presets/functional.html
View file
Expand Up @@ -83,7 +83,6 @@
<li class="toctree-l1"><a class="reference internal" href="../../../source/pytorchart.Loggers.html">pytorchart.Loggers package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../source/modules.html">pytorchart</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../source/pytorchart.html">flexilogger</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../source/pytorchart.html">tooledmodel</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../source/pytorchart.moremeters.html">moremeters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../source/pytorchart.presets.html">presets</a></li>
</ul>
Expand Down
1 change: 0 additions & 1 deletion docs/_build/html/_modules/pytorchart/presets/preconfigured.html
View file
Expand Up @@ -83,7 +83,6 @@
<li class="toctree-l1"><a class="reference internal" href="../../../source/pytorchart.Loggers.html">pytorchart.Loggers package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../source/modules.html">pytorchart</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../source/pytorchart.html">flexilogger</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../source/pytorchart.html">tooledmodel</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../source/pytorchart.moremeters.html">moremeters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../source/pytorchart.presets.html">presets</a></li>
</ul>
Expand Down
1 change: 0 additions & 1 deletion docs/_build/html/_modules/pytorchart/tooledmodel.html
View file
Expand Up @@ -83,7 +83,6 @@
<li class="toctree-l1"><a class="reference internal" href="../../source/pytorchart.Loggers.html">pytorchart.Loggers package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../source/modules.html">pytorchart</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../source/pytorchart.html">flexilogger</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../source/pytorchart.html">tooledmodel</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../source/pytorchart.moremeters.html">moremeters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../source/pytorchart.presets.html">presets</a></li>
</ul>
Expand Down
1 change: 0 additions & 1 deletion docs/_build/html/_sources/index.rst.txt
View file
Expand Up @@ -14,7 +14,6 @@ Welcome to pytorchart's documentation!
source/pytorchart.Loggers
source/modules
flexilogger <source/pytorchart.rst>
tooledmodel <source/pytorchart.rst>
moremeters <source/pytorchart.moremeters.rst>
presets <source/pytorchart.presets.rst>

Expand Down
13 changes: 8 additions & 5 deletions docs/_build/html/_sources/source/pytorchart.rst.txt
View file
@@ -1,5 +1,7 @@
pytorchart package
==================
# .. include:: ../../README.md


.. toctree::

Expand All @@ -11,15 +13,16 @@ pytorchart package
FlexLogger module
-----------------------------

.. autoclass:: pytorchart.flexilogger.FlexLogger
.. automodule:: pytorchart.flexilogger
:members:
:undoc-members:


pytorchart.tooledmodel module
-----------------------------

.. automodule:: pytorchart.tooledmodel
:members:
:undoc-members:

.. automodule:: pytorchart.Loggers.tracelogger
:members:
:undoc-members:


13 changes: 7 additions & 6 deletions docs/_build/html/genindex.html
View file
Expand Up @@ -84,7 +84,6 @@
<li class="toctree-l1"><a class="reference internal" href="source/pytorchart.Loggers.html">pytorchart.Loggers package</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/modules.html">pytorchart</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/pytorchart.html">flexilogger</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/pytorchart.html">tooledmodel</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/pytorchart.moremeters.html">moremeters</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/pytorchart.presets.html">presets</a></li>
</ul>
Expand Down Expand Up @@ -294,7 +293,7 @@ <h2 id="L">L</h2>
<li><a href="source/pytorchart.html#pytorchart.flexilogger.FlexLogger.log">log() (pytorchart.flexilogger.FlexLogger method)</a>

<ul>
<li><a href="source/pytorchart.Loggers.html#pytorchart.Loggers.tracelogger.TraceLogger.log">(pytorchart.Loggers.tracelogger.TraceLogger method)</a>
<li><a href="source/pytorchart.Loggers.html#pytorchart.Loggers.tracelogger.TraceLogger.log">(pytorchart.Loggers.tracelogger.TraceLogger method)</a>, <a href="source/pytorchart.html#pytorchart.Loggers.tracelogger.TraceLogger.log">[1]</a>
</li>
</ul></li>
</ul></td>
Expand All @@ -305,7 +304,9 @@ <h2 id="P">P</h2>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="source/pytorchart.presets.html#pytorchart.presets.preconfigured.preset_names">preset_names() (in module pytorchart.presets.preconfigured)</a>
</li>
<li><a href="source/pytorchart.Loggers.html#module-pytorchart.Loggers.tracelogger">pytorchart.Loggers.tracelogger (module)</a>
<li><a href="source/pytorchart.html#module-pytorchart.flexilogger">pytorchart.flexilogger (module)</a>
</li>
<li><a href="source/pytorchart.Loggers.html#module-pytorchart.Loggers.tracelogger">pytorchart.Loggers.tracelogger (module)</a>, <a href="source/pytorchart.html#module-pytorchart.Loggers.tracelogger">[1]</a>
</li>
<li><a href="source/pytorchart.moremeters.html#module-pytorchart.moremeters">pytorchart.moremeters (module)</a>
</li>
Expand Down Expand Up @@ -356,7 +357,7 @@ <h2 id="S">S</h2>
<li><a href="source/pytorchart.html#pytorchart.flexilogger.FlexLogger.save">save() (pytorchart.flexilogger.FlexLogger method)</a>

<ul>
<li><a href="source/pytorchart.Loggers.html#pytorchart.Loggers.tracelogger.TraceLogger.save">(pytorchart.Loggers.tracelogger.TraceLogger method)</a>
<li><a href="source/pytorchart.Loggers.html#pytorchart.Loggers.tracelogger.TraceLogger.save">(pytorchart.Loggers.tracelogger.TraceLogger method)</a>, <a href="source/pytorchart.html#pytorchart.Loggers.tracelogger.TraceLogger.save">[1]</a>
</li>
</ul></li>
</ul></td>
Expand All @@ -373,7 +374,7 @@ <h2 id="S">S</h2>
<h2 id="T">T</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="source/pytorchart.Loggers.html#pytorchart.Loggers.tracelogger.TraceLogger">TraceLogger (class in pytorchart.Loggers.tracelogger)</a>
<li><a href="source/pytorchart.Loggers.html#pytorchart.Loggers.tracelogger.TraceLogger">TraceLogger (class in pytorchart.Loggers.tracelogger)</a>, <a href="source/pytorchart.html#pytorchart.Loggers.tracelogger.TraceLogger">[1]</a>
</li>
</ul></td>
</tr></table>
Expand Down Expand Up @@ -401,7 +402,7 @@ <h2 id="V">V</h2>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="source/pytorchart.html#pytorchart.flexilogger.FlexLogger.vis">vis (pytorchart.flexilogger.FlexLogger attribute)</a>
</li>
<li><a href="source/pytorchart.Loggers.html#pytorchart.Loggers.tracelogger.TraceLogger.viz">viz (pytorchart.Loggers.tracelogger.TraceLogger attribute)</a>
<li><a href="source/pytorchart.Loggers.html#pytorchart.Loggers.tracelogger.TraceLogger.viz">viz (pytorchart.Loggers.tracelogger.TraceLogger attribute)</a>, <a href="source/pytorchart.html#pytorchart.Loggers.tracelogger.TraceLogger.viz">[1]</a>
</li>
</ul></td>
</tr></table>
Expand Down
2 changes: 0 additions & 2 deletions docs/_build/html/index.html
View file
Expand Up @@ -84,7 +84,6 @@
<li class="toctree-l1"><a class="reference internal" href="source/pytorchart.Loggers.html">pytorchart.Loggers package</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/modules.html">pytorchart</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/pytorchart.html">flexilogger</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/pytorchart.html">tooledmodel</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/pytorchart.moremeters.html">moremeters</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/pytorchart.presets.html">presets</a></li>
</ul>
Expand Down Expand Up @@ -160,7 +159,6 @@ <h1>Welcome to pytorchart’s documentation!<a class="headerlink" href="#welcome
<li class="toctree-l1"><a class="reference internal" href="source/pytorchart.Loggers.html">pytorchart.Loggers package</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/modules.html">pytorchart</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/pytorchart.html">flexilogger</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/pytorchart.html">tooledmodel</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/pytorchart.moremeters.html">moremeters</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/pytorchart.presets.html">presets</a></li>
</ul>
Expand Down
Binary file modified docs/_build/html/objects.inv
View file
Binary file not shown.
8 changes: 6 additions & 2 deletions docs/_build/html/py-modindex.html
View file
Expand Up @@ -86,7 +86,6 @@
<li class="toctree-l1"><a class="reference internal" href="source/pytorchart.Loggers.html">pytorchart.Loggers package</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/modules.html">pytorchart</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/pytorchart.html">flexilogger</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/pytorchart.html">tooledmodel</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/pytorchart.moremeters.html">moremeters</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/pytorchart.presets.html">presets</a></li>
</ul>
Expand Down Expand Up @@ -169,7 +168,12 @@ <h1>Python Module Index</h1>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="source/pytorchart.Loggers.html#module-pytorchart.Loggers.tracelogger"><code class="xref">pytorchart.Loggers.tracelogger</code></a></td><td>
<a href="source/pytorchart.html#module-pytorchart.flexilogger"><code class="xref">pytorchart.flexilogger</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="source/pytorchart.html#module-pytorchart.Loggers.tracelogger"><code class="xref">pytorchart.Loggers.tracelogger</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
Expand Down
1 change: 0 additions & 1 deletion docs/_build/html/search.html
View file
Expand Up @@ -83,7 +83,6 @@
<li class="toctree-l1"><a class="reference internal" href="source/pytorchart.Loggers.html">pytorchart.Loggers package</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/modules.html">pytorchart</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/pytorchart.html">flexilogger</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/pytorchart.html">tooledmodel</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/pytorchart.moremeters.html">moremeters</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/pytorchart.presets.html">presets</a></li>
</ul>
Expand Down

0 comments on commit 7f8501e

Please sign in to comment.