Deploying to gh-pages from @ e2cd2c2 🚀

master/_sources/framework/generated/torchtnt.framework.callbacks.IterationTimeLogger.rst.txt

@@ -0,0 +1,10 @@
+.. role:: hidden
+    :class: hidden-section
+.. currentmodule:: torchtnt.framework.callbacks
+
+
+IterationTimeLogger
+===================
+
+.. autoclass:: IterationTimeLogger
+    :members:

master/framework/callbacks.html

@@ -547,13 +547,16 @@ <h2>Built-in callbacks<a class="headerlink" href="#built-in-callbacks" title="Pe
 <tr class="row-even"><td><a class="reference internal" href="generated/torchtnt.framework.callbacks.TensorBoardParameterMonitor.html#torchtnt.framework.callbacks.TensorBoardParameterMonitor" title="torchtnt.framework.callbacks.TensorBoardParameterMonitor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TensorBoardParameterMonitor</span></code></a></td>
 <td>A callback which logs module parameters as histograms to TensorBoard.</td>
 </tr>
-<tr class="row-odd"><td><a class="reference internal" href="generated/torchtnt.framework.callbacks.TorchSnapshotSaver.html#torchtnt.framework.callbacks.TorchSnapshotSaver" title="torchtnt.framework.callbacks.TorchSnapshotSaver"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TorchSnapshotSaver</span></code></a></td>
+<tr class="row-odd"><td><a class="reference internal" href="generated/torchtnt.framework.callbacks.IterationTimeLogger.html#torchtnt.framework.callbacks.IterationTimeLogger" title="torchtnt.framework.callbacks.IterationTimeLogger"><code class="xref py py-obj docutils literal notranslate"><span class="pre">IterationTimeLogger</span></code></a></td>
+<td>A callback which logs iteration times as scalars to TensorBoard.</td>
+</tr>
+<tr class="row-even"><td><a class="reference internal" href="generated/torchtnt.framework.callbacks.TorchSnapshotSaver.html#torchtnt.framework.callbacks.TorchSnapshotSaver" title="torchtnt.framework.callbacks.TorchSnapshotSaver"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TorchSnapshotSaver</span></code></a></td>
 <td>A callback which periodically saves the application state during training using <a class="reference external" href="https://pytorch.org/torchsnapshot/" target="_blank">TorchSnapshot</a>.</td>
 </tr>
-<tr class="row-even"><td><a class="reference internal" href="generated/torchtnt.framework.callbacks.TQDMProgressBar.html#torchtnt.framework.callbacks.TQDMProgressBar" title="torchtnt.framework.callbacks.TQDMProgressBar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TQDMProgressBar</span></code></a></td>
+<tr class="row-odd"><td><a class="reference internal" href="generated/torchtnt.framework.callbacks.TQDMProgressBar.html#torchtnt.framework.callbacks.TQDMProgressBar" title="torchtnt.framework.callbacks.TQDMProgressBar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TQDMProgressBar</span></code></a></td>
 <td>A callback for progress bar visualization in training, evaluation, and prediction.</td>
 </tr>
-<tr class="row-odd"><td><a class="reference internal" href="generated/torchtnt.framework.callbacks.TrainProgressMonitor.html#torchtnt.framework.callbacks.TrainProgressMonitor" title="torchtnt.framework.callbacks.TrainProgressMonitor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TrainProgressMonitor</span></code></a></td>
+<tr class="row-even"><td><a class="reference internal" href="generated/torchtnt.framework.callbacks.TrainProgressMonitor.html#torchtnt.framework.callbacks.TrainProgressMonitor" title="torchtnt.framework.callbacks.TrainProgressMonitor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TrainProgressMonitor</span></code></a></td>
 <td>A callback which logs training progress in terms of steps vs epochs.</td>
 </tr>
 </tbody>

master/framework/generated/torchtnt.framework.callbacks.TensorBoardParameterMonitor.html

@@ -33,7 +33,7 @@
   <link rel="stylesheet" href="../../_static/css/torchtnt.css" type="text/css" />
     <link rel="index" title="Index" href="../../genindex.html" />
     <link rel="search" title="Search" href="../../search.html" />
-    <link rel="next" title="TorchSnapshotSaver" href="torchtnt.framework.callbacks.TorchSnapshotSaver.html" />
+    <link rel="next" title="IterationTimeLogger" href="torchtnt.framework.callbacks.IterationTimeLogger.html" />
     <link rel="prev" title="SystemResourcesMonitor" href="torchtnt.framework.callbacks.SystemResourcesMonitor.html" />
   <!-- Google Tag Manager -->
     <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
@@ -392,7 +392,7 @@ <h1>TensorBoardParameterMonitor<a class="headerlink" href="#tensorboardparameter
 
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 
-        <a href="torchtnt.framework.callbacks.TorchSnapshotSaver.html" class="btn btn-neutral float-right" title="TorchSnapshotSaver" accesskey="n" rel="next">Next <img src="../../_static/images/chevron-right-orange.svg" class="next-page"></a>
+        <a href="torchtnt.framework.callbacks.IterationTimeLogger.html" class="btn btn-neutral float-right" title="IterationTimeLogger" accesskey="n" rel="next">Next <img src="../../_static/images/chevron-right-orange.svg" class="next-page"></a>
 
 
         <a href="torchtnt.framework.callbacks.SystemResourcesMonitor.html" class="btn btn-neutral" title="SystemResourcesMonitor" accesskey="p" rel="prev"><img src="../../_static/images/chevron-right-orange.svg" class="previous-page"> Previous</a>

master/framework/generated/torchtnt.framework.callbacks.TorchSnapshotSaver.html

@@ -34,7 +34,7 @@
     <link rel="index" title="Index" href="../../genindex.html" />
     <link rel="search" title="Search" href="../../search.html" />
     <link rel="next" title="TQDMProgressBar" href="torchtnt.framework.callbacks.TQDMProgressBar.html" />
-    <link rel="prev" title="TensorBoardParameterMonitor" href="torchtnt.framework.callbacks.TensorBoardParameterMonitor.html" />
+    <link rel="prev" title="IterationTimeLogger" href="torchtnt.framework.callbacks.IterationTimeLogger.html" />
   <!-- Google Tag Manager -->
     <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
     new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
@@ -494,7 +494,7 @@ <h1>TorchSnapshotSaver<a class="headerlink" href="#torchsnapshotsaver" title="Pe
         <a href="torchtnt.framework.callbacks.TQDMProgressBar.html" class="btn btn-neutral float-right" title="TQDMProgressBar" accesskey="n" rel="next">Next <img src="../../_static/images/chevron-right-orange.svg" class="next-page"></a>
 
 
-        <a href="torchtnt.framework.callbacks.TensorBoardParameterMonitor.html" class="btn btn-neutral" title="TensorBoardParameterMonitor" accesskey="p" rel="prev"><img src="../../_static/images/chevron-right-orange.svg" class="previous-page"> Previous</a>
+        <a href="torchtnt.framework.callbacks.IterationTimeLogger.html" class="btn btn-neutral" title="IterationTimeLogger" accesskey="p" rel="prev"><img src="../../_static/images/chevron-right-orange.svg" class="previous-page"> Previous</a>
 
     </div>
 

master/genindex.html

@@ -684,6 +684,8 @@ <h2 id="I">I</h2>
       <li><a href="utils/generated/torchtnt.utils.data.MultiDataLoader.html#torchtnt.utils.data.MultiDataLoader.iteration_strategy">iteration_strategy (torchtnt.utils.data.MultiDataLoader attribute)</a>
 </li>
       <li><a href="framework/state.html#torchtnt.framework.state.PhaseState.iteration_timer">iteration_timer (torchtnt.framework.state.PhaseState property)</a>
+</li>
+      <li><a href="framework/generated/torchtnt.framework.callbacks.IterationTimeLogger.html#torchtnt.framework.callbacks.IterationTimeLogger">IterationTimeLogger (class in torchtnt.framework.callbacks)</a>
 </li>
       <li><a href="utils/generated/torchtnt.utils.data.MultiDataLoader.html#torchtnt.utils.data.MultiDataLoader.iterator_cls">iterator_cls (torchtnt.utils.data.MultiDataLoader attribute)</a>
 </li>
@@ -954,8 +956,6 @@ <h2 id="O">O</h2>
         <li><a href="framework/unit.html#torchtnt.framework.unit.PredictUnit.on_predict_start">(torchtnt.framework.unit.PredictUnit method)</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="framework/auto_unit.html#torchtnt.framework.auto_unit.AutoPredictUnit.on_predict_step_end">on_predict_step_end() (torchtnt.framework.auto_unit.AutoPredictUnit method)</a>
 
       <ul>
@@ -970,6 +970,8 @@ <h2 id="O">O</h2>
         <li><a href="framework/generated/torchtnt.framework.callbacks.TQDMProgressBar.html#torchtnt.framework.callbacks.TQDMProgressBar.on_predict_step_end">(torchtnt.framework.callbacks.TQDMProgressBar method)</a>
 </li>
       </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="framework/callbacks.html#torchtnt.framework.callback.Callback.on_predict_step_start">on_predict_step_start() (torchtnt.framework.callback.Callback method)</a>
 
       <ul>
@@ -1040,6 +1042,8 @@ <h2 id="O">O</h2>
         <li><a href="framework/callbacks.html#torchtnt.framework.callback.Callback.on_train_step_end">(torchtnt.framework.callback.Callback method)</a>
 </li>
         <li><a href="framework/generated/torchtnt.framework.callbacks.GarbageCollector.html#torchtnt.framework.callbacks.GarbageCollector.on_train_step_end">(torchtnt.framework.callbacks.GarbageCollector method)</a>
+</li>
+        <li><a href="framework/generated/torchtnt.framework.callbacks.IterationTimeLogger.html#torchtnt.framework.callbacks.IterationTimeLogger.on_train_step_end">(torchtnt.framework.callbacks.IterationTimeLogger method)</a>
 </li>
         <li><a href="framework/generated/torchtnt.framework.callbacks.PyTorchProfiler.html#torchtnt.framework.callbacks.PyTorchProfiler.on_train_step_end">(torchtnt.framework.callbacks.PyTorchProfiler method)</a>
 </li>