wassname/pytorch-lightning
1
0
Fork 0
mirror of https://github.com/wassname/pytorch-lightning.git synced 2026-09-09 11:32:07 +08:00
Code Issues Packages Projects Releases Wiki Activity

Deployed 9fa8120 with MkDocs version: 1.0.4

Browse Source
This commit is contained in:
William Falcon
2019-07-25 10:30:31 -05:00
parent 3536c7c427
commit 88bae42294
5 changed files with 23 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files
LightningModule/RequiredTrainerInterface/index.html
+7 -7
View File
@@ -887,7 +887,7 @@
<h1 id="lightning-module-interface">Lightning Module interface</h1>
<p>[<a href="https://github.com/williamFalcon/pytorch-lightning/blob/master/pytorch_lightning/root_module/root_module.py">Github Code</a>]</p>
<p>A lightning module is a strict superclass of nn.Module, it provides a standard interface for the trainer to interact with the model.</p>
<p>The easiest thing to do is copy <a href="../../examples/new_project_templates/lightning_module_template.py">this template</a> and modify accordingly. </p>
<p>The easiest thing to do is copy <a href="../../pytorch_lightning/examples/new_project_templates/lightning_module_template.py">this template</a> and modify accordingly. </p>
<p>Otherwise, to Define a Lightning Module, implement the following methods:</p>
<p><strong>Required</strong>: </p>
<ul>
@@ -1157,11 +1157,11 @@ Lightning will automatically restore current epoch, batch nb, etc. </p>
<hr />
<h3 id="tng_dataloader">tng_dataloader</h3>
<pre><code class="python">@property
<pre><code class="python">@ptl.data_loader
def tng_dataloader(self)
</code></pre>
<p>Called by lightning during training loop. Define it as a property.</p>
<p>Called by lightning during training loop. Make sure to use the @ptl.data_loader decorator, this ensures not calling this function until the data are needed.</p>
<h5 id="return_3">Return</h5>
<p>Pytorch DataLoader</p>
<p><strong>Example</strong></p>
@@ -1185,11 +1185,11 @@ def tng_dataloader(self):
<hr />
<h3 id="val_dataloader">val_dataloader</h3>
<pre><code class="python">@property
<pre><code class="python">@ptl.data_loader
def tng_dataloader(self)
</code></pre>
<p>Called by lightning during validation loop. Define it as a property.</p>
<p>Called by lightning during validation loop. Make sure to use the @ptl.data_loader decorator, this ensures not calling this function until the data are needed.</p>
<h5 id="return_4">Return</h5>
<p>Pytorch DataLoader</p>
<p><strong>Example</strong></p>
@@ -1213,11 +1213,11 @@ def val_dataloader(self):
<hr />
<h3 id="test_dataloader">test_dataloader</h3>
<pre><code class="python">@property
<pre><code class="python">@ptl.data_loader
def test_dataloader(self)
</code></pre>
<p>Called by lightning during test loop. Define it as a property.</p>
<p>Called by lightning during test loop. Make sure to use the @ptl.data_loader decorator, this ensures not calling this function until the data are needed.</p>
<h5 id="return_5">Return</h5>
<p>Pytorch DataLoader</p>
<p><strong>Example</strong></p>
doc_requirements.txt
+1
View File
@@ -0,0 +1 @@
mkdocs-material==4.4.0
search/search_index.json
+1 -1
View File
File diff suppressed because one or more lines are too long
sitemap.xml
+14 -14
View File
@@ -2,72 +2,72 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>None</loc>
<lastmod>2019-07-21</lastmod>
<lastmod>2019-07-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2019-07-21</lastmod>
<lastmod>2019-07-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2019-07-21</lastmod>
<lastmod>2019-07-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2019-07-21</lastmod>
<lastmod>2019-07-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2019-07-21</lastmod>
<lastmod>2019-07-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2019-07-21</lastmod>
<lastmod>2019-07-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2019-07-21</lastmod>
<lastmod>2019-07-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2019-07-21</lastmod>
<lastmod>2019-07-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2019-07-21</lastmod>
<lastmod>2019-07-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2019-07-21</lastmod>
<lastmod>2019-07-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2019-07-21</lastmod>
<lastmod>2019-07-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2019-07-21</lastmod>
<lastmod>2019-07-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2019-07-21</lastmod>
<lastmod>2019-07-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2019-07-21</lastmod>
<lastmod>2019-07-25</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>
sitemap.xml.gz
BIN
View File
Binary file not shown.