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 cc5b5d7 commit 5986daf
Show file tree
Hide file tree
Showing 31 changed files with 89 additions and 753 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/modules.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/source/pytorchart.doctree
View file
Binary file not shown.
1 change: 1 addition & 0 deletions docs/_build/html/_modules/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../source/pytorchart.html">pytorchart package</a></li>
<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>
Expand Down
1 change: 1 addition & 0 deletions docs/_build/html/_modules/pytorchart/Loggers/tracelogger.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../source/pytorchart.html">pytorchart package</a></li>
<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>
Expand Down
1 change: 1 addition & 0 deletions docs/_build/html/_modules/pytorchart/flexilogger.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../source/pytorchart.html">pytorchart package</a></li>
<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>
Expand Down
21 changes: 11 additions & 10 deletions docs/_build/html/_modules/pytorchart/modelutils/modellogger.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../source/pytorchart.html">pytorchart package</a></li>
<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>
Expand Down Expand Up @@ -153,7 +154,7 @@ <h1>Source code for pytorchart.modelutils.modellogger</h1><div class="highlight"
<span class="c1"># from .tooledmodel import TooledModel</span>


<div class="viewcode-block" id="TooledModelLogger"><a class="viewcode-back" href="../../../source/pytorchart.modelutils.html#pytorchart.modelutils.modellogger.TooledModelLogger">[docs]</a><span class="k">class</span> <span class="nc">TooledModelLogger</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<div class="viewcode-block" id="TooledModelLogger"><a class="viewcode-back" href="../../../source/modules.html#pytorchart.modelutils.modellogger.TooledModelLogger">[docs]</a><span class="k">class</span> <span class="nc">TooledModelLogger</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>

<span class="sd"> Combines a flexlogger and a TooledModel.</span>
Expand Down Expand Up @@ -237,7 +238,7 @@ <h1>Source code for pytorchart.modelutils.modellogger</h1><div class="highlight"
<span class="bp">self</span><span class="o">.</span><span class="n">_tm_to_logger</span><span class="p">[</span><span class="n">meter_name</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="n">k</span><span class="p">,</span> <span class="n">metric_type</span><span class="p">,</span> <span class="n">metric</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_Logger</span> <span class="o">=</span> <span class="n">FlexLogger</span><span class="p">(</span><span class="n">plots</span><span class="p">,</span> <span class="n">meters</span><span class="p">)</span>

<div class="viewcode-block" id="TooledModelLogger.generete_custom_plot"><a class="viewcode-back" href="../../../source/pytorchart.modelutils.html#pytorchart.modelutils.modellogger.TooledModelLogger.generete_custom_plot">[docs]</a> <span class="k">def</span> <span class="nf">generete_custom_plot</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data_dict</span><span class="p">,</span> <span class="n">plots</span><span class="p">,</span> <span class="n">meters</span><span class="p">):</span>
<div class="viewcode-block" id="TooledModelLogger.generete_custom_plot"><a class="viewcode-back" href="../../../source/modules.html#pytorchart.modelutils.modellogger.TooledModelLogger.generete_custom_plot">[docs]</a> <span class="k">def</span> <span class="nf">generete_custom_plot</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data_dict</span><span class="p">,</span> <span class="n">plots</span><span class="p">,</span> <span class="n">meters</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>

<span class="sd"> :param data_dict:</span>
Expand All @@ -247,7 +248,7 @@ <h1>Source code for pytorchart.modelutils.modellogger</h1><div class="highlight"
<span class="sd"> &quot;&quot;&quot;</span></div>
<span class="bp">self</span><span class="o">.</span><span class="n">_Logger</span> <span class="o">=</span> <span class="n">FlexLogger</span><span class="p">(</span><span class="n">plots</span><span class="p">,</span> <span class="n">meters</span><span class="p">)</span>

<div class="viewcode-block" id="TooledModelLogger.step"><a class="viewcode-back" href="../../../source/pytorchart.modelutils.html#pytorchart.modelutils.modellogger.TooledModelLogger.step">[docs]</a> <span class="k">def</span> <span class="nf">step</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">X</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">log</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">keys</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">reset</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<div class="viewcode-block" id="TooledModelLogger.step"><a class="viewcode-back" href="../../../source/modules.html#pytorchart.modelutils.modellogger.TooledModelLogger.step">[docs]</a> <span class="k">def</span> <span class="nf">step</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">X</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">log</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">keys</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">reset</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>

<span class="sd"> :param X:</span>
Expand All @@ -270,25 +271,25 @@ <h1>Source code for pytorchart.modelutils.modellogger</h1><div class="highlight"
<span class="bp">self</span><span class="o">.</span><span class="n">_Logger</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="n">X</span><span class="o">=</span><span class="n">X</span><span class="p">,</span> <span class="n">keys</span><span class="o">=</span><span class="n">keys</span><span class="p">,</span> <span class="n">reset</span><span class="o">=</span><span class="n">reset</span><span class="p">)</span>

<span class="c1"># Passthrough APIs - should I just subclass?</span>
<div class="viewcode-block" id="TooledModelLogger.add"><a class="viewcode-back" href="../../../source/pytorchart.modelutils.html#pytorchart.modelutils.modellogger.TooledModelLogger.add">[docs]</a> <span class="k">def</span> <span class="nf">add</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">update_dict</span><span class="p">):</span></div>
<div class="viewcode-block" id="TooledModelLogger.add"><a class="viewcode-back" href="../../../source/modules.html#pytorchart.modelutils.modellogger.TooledModelLogger.add">[docs]</a> <span class="k">def</span> <span class="nf">add</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">update_dict</span><span class="p">):</span></div>
<span class="bp">self</span><span class="o">.</span><span class="n">_Logger</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">update_dict</span><span class="p">)</span>

<div class="viewcode-block" id="TooledModelLogger.log"><a class="viewcode-back" href="../../../source/pytorchart.modelutils.html#pytorchart.modelutils.modellogger.TooledModelLogger.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="o">**</span><span class="n">kwargs</span><span class="p">):</span></div>
<div class="viewcode-block" id="TooledModelLogger.log"><a class="viewcode-back" href="../../../source/modules.html#pytorchart.modelutils.modellogger.TooledModelLogger.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="o">**</span><span class="n">kwargs</span><span class="p">):</span></div>
<span class="bp">self</span><span class="o">.</span><span class="n">_Logger</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>

<div class="viewcode-block" id="TooledModelLogger.reset"><a class="viewcode-back" href="../../../source/pytorchart.modelutils.html#pytorchart.modelutils.modellogger.TooledModelLogger.reset">[docs]</a> <span class="k">def</span> <span class="nf">reset</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span></div>
<div class="viewcode-block" id="TooledModelLogger.reset"><a class="viewcode-back" href="../../../source/modules.html#pytorchart.modelutils.modellogger.TooledModelLogger.reset">[docs]</a> <span class="k">def</span> <span class="nf">reset</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span></div>
<span class="bp">self</span><span class="o">.</span><span class="n">_Logger</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>

<div class="viewcode-block" id="TooledModelLogger.clear"><a class="viewcode-back" href="../../../source/pytorchart.modelutils.html#pytorchart.modelutils.modellogger.TooledModelLogger.clear">[docs]</a> <span class="k">def</span> <span class="nf">clear</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span></div>
<div class="viewcode-block" id="TooledModelLogger.clear"><a class="viewcode-back" href="../../../source/modules.html#pytorchart.modelutils.modellogger.TooledModelLogger.clear">[docs]</a> <span class="k">def</span> <span class="nf">clear</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span></div>
<span class="bp">self</span><span class="o">.</span><span class="n">_TM</span><span class="o">.</span><span class="n">clear</span><span class="p">()</span>

<div class="viewcode-block" id="TooledModelLogger.table"><a class="viewcode-back" href="../../../source/pytorchart.modelutils.html#pytorchart.modelutils.modellogger.TooledModelLogger.table">[docs]</a> <span class="k">def</span> <span class="nf">table</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span></div>
<div class="viewcode-block" id="TooledModelLogger.table"><a class="viewcode-back" href="../../../source/modules.html#pytorchart.modelutils.modellogger.TooledModelLogger.table">[docs]</a> <span class="k">def</span> <span class="nf">table</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span></div>
<span class="bp">self</span><span class="o">.</span><span class="n">_TM</span><span class="o">.</span><span class="n">table</span><span class="p">()</span>

<div class="viewcode-block" id="TooledModelLogger.get_handles"><a class="viewcode-back" href="../../../source/pytorchart.modelutils.html#pytorchart.modelutils.modellogger.TooledModelLogger.get_handles">[docs]</a> <span class="k">def</span> <span class="nf">get_handles</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span></div>
<div class="viewcode-block" id="TooledModelLogger.get_handles"><a class="viewcode-back" href="../../../source/modules.html#pytorchart.modelutils.modellogger.TooledModelLogger.get_handles">[docs]</a> <span class="k">def</span> <span class="nf">get_handles</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span></div>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_TM</span><span class="o">.</span><span class="n">get_handles</span><span class="p">()</span>

<div class="viewcode-block" id="TooledModelLogger.get_dict"><a class="viewcode-back" href="../../../source/pytorchart.modelutils.html#pytorchart.modelutils.modellogger.TooledModelLogger.get_dict">[docs]</a> <span class="k">def</span> <span class="nf">get_dict</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span></div></div>
<div class="viewcode-block" id="TooledModelLogger.get_dict"><a class="viewcode-back" href="../../../source/modules.html#pytorchart.modelutils.modellogger.TooledModelLogger.get_dict">[docs]</a> <span class="k">def</span> <span class="nf">get_dict</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span></div></div>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_TM</span><span class="o">.</span><span class="n">get_dict</span><span class="p">()</span>


Expand Down
1 change: 1 addition & 0 deletions docs/_build/html/_modules/pytorchart/moremeters/bestmeter.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../source/pytorchart.html">pytorchart package</a></li>
<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>
Expand Down
1 change: 1 addition & 0 deletions docs/_build/html/_modules/pytorchart/moremeters/image_meter.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../source/pytorchart.html">pytorchart package</a></li>
<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>
Expand Down
1 change: 1 addition & 0 deletions docs/_build/html/_modules/pytorchart/presets/functional.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../source/pytorchart.html">pytorchart package</a></li>
<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>
Expand Down
1 change: 1 addition & 0 deletions docs/_build/html/_modules/pytorchart/presets/preconfigured.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../source/pytorchart.html">pytorchart package</a></li>
<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>
Expand Down
3 changes: 2 additions & 1 deletion docs/_build/html/_modules/pytorchart/tooledmodel.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../source/pytorchart.html">pytorchart package</a></li>
<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>
Expand Down Expand Up @@ -149,7 +150,7 @@

<h1>Source code for pytorchart.tooledmodel</h1><div class="highlight"><pre>
<span></span><span class="kn">import</span> <span class="nn">torch</span>
<span class="kn">from</span> <span class="nn">pytorchart.modelutils.modellogger</span> <span class="k">import</span> <span class="n">FlexLogger</span>
<span class="kn">from</span> <span class="nn">.</span> <span class="k">import</span> <span class="n">FlexLogger</span>
<span class="kn">from</span> <span class="nn">torch.autograd</span> <span class="k">import</span> <span class="n">Variable</span>


Expand Down
1 change: 1 addition & 0 deletions docs/_build/html/_sources/index.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Welcome to pytorchart's documentation!

source/pytorchart
source/pytorchart.Loggers
source/modules
flexilogger <source/pytorchart.rst>
tooledmodel <source/pytorchart.rst>
moremeters <source/pytorchart.moremeters.rst>
Expand Down
11 changes: 1 addition & 10 deletions docs/_build/html/_sources/source/modules.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,8 @@ pytorchart
==========

.. toctree::
:maxdepth: 4
:maxdepth: 1

Loggers <pytorchart.Loggers.rst>
flexilogger <pytorchart.rst>
tooledmodel <pytorchart.rst>


modellogger module
----------------------------------------

.. automodule:: pytorchart.modelutils.modellogger
:members:
:undoc-members:

8 changes: 2 additions & 6 deletions docs/_build/html/_sources/source/pytorchart.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,14 @@ pytorchart package
pytorchart.presets


pytorchart.flexilogger module
FlexLogger module
-----------------------------

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


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


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

Expand Down

0 comments on commit 5986daf

Please sign in to comment.