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

Deployed fbc2cfd with MkDocs version: 1.0.4

Browse Source
This commit is contained in:
William Falcon
2019-10-01 05:34:27 -05:00
parent e77709ff8b
commit 3c34e029ed
23 changed files with 555 additions and 458 deletions
Download Patch File Download Diff File Expand all files Collapse all files
LightningModule/RequiredTrainerInterface/index.html
+50 -50
View File
@@ -34,7 +34,7 @@
<meta name="lang:search.tokenizer" content="[\s\-]+">
<link rel="shortcut icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.4.2">
<meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.4.0">
@@ -42,7 +42,7 @@
<link rel="stylesheet" href="../../assets/stylesheets/application.30686662.css">
<link rel="stylesheet" href="../../assets/stylesheets/application.0284f74d.css">
@@ -171,7 +171,7 @@
<main class="md-main" role="main">
<main class="md-main">
<div class="md-main__inner md-grid" data-md-component="container">
@@ -276,21 +276,21 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="#minimal-example" class="md-nav__link">
<a href="#minimal-example" title="Minimal example" class="md-nav__link">
Minimal example
</a>
</li>
<li class="md-nav__item">
<a href="#how-do-these-methods-fit-into-the-broader-training" class="md-nav__link">
<a href="#how-do-these-methods-fit-into-the-broader-training" title="How do these methods fit into the broader training?" class="md-nav__link">
How do these methods fit into the broader training?
</a>
</li>
<li class="md-nav__item">
<a href="#required-methods" class="md-nav__link">
<a href="#required-methods" title="Required Methods" class="md-nav__link">
Required Methods
</a>
@@ -298,14 +298,14 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#training_step" class="md-nav__link">
<a href="#training_step" title="training_step" class="md-nav__link">
training_step
</a>
</li>
<li class="md-nav__item">
<a href="#train_dataloader" class="md-nav__link">
<a href="#train_dataloader" title="train_dataloader" class="md-nav__link">
train_dataloader
</a>
@@ -313,7 +313,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#return" class="md-nav__link">
<a href="#return" title="Return" class="md-nav__link">
Return
</a>
@@ -325,7 +325,7 @@
</li>
<li class="md-nav__item">
<a href="#configure_optimizers" class="md-nav__link">
<a href="#configure_optimizers" title="configure_optimizers" class="md-nav__link">
configure_optimizers
</a>
@@ -333,7 +333,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#return_1" class="md-nav__link">
<a href="#return_1" title="Return" class="md-nav__link">
Return
</a>
@@ -350,7 +350,7 @@
</li>
<li class="md-nav__item">
<a href="#optional-methods" class="md-nav__link">
<a href="#optional-methods" title="Optional Methods" class="md-nav__link">
Optional Methods
</a>
@@ -358,35 +358,35 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#validation_step" class="md-nav__link">
<a href="#validation_step" title="validation_step" class="md-nav__link">
validation_step
</a>
</li>
<li class="md-nav__item">
<a href="#validation_end" class="md-nav__link">
<a href="#validation_end" title="validation_end" class="md-nav__link">
validation_end
</a>
</li>
<li class="md-nav__item">
<a href="#test_step" class="md-nav__link">
<a href="#test_step" title="test_step" class="md-nav__link">
test_step
</a>
</li>
<li class="md-nav__item">
<a href="#test_end" class="md-nav__link">
<a href="#test_end" title="test_end" class="md-nav__link">
test_end
</a>
</li>
<li class="md-nav__item">
<a href="#on_save_checkpoint" class="md-nav__link">
<a href="#on_save_checkpoint" title="on_save_checkpoint" class="md-nav__link">
on_save_checkpoint
</a>
@@ -394,7 +394,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#return_2" class="md-nav__link">
<a href="#return_2" title="Return" class="md-nav__link">
Return
</a>
@@ -406,7 +406,7 @@
</li>
<li class="md-nav__item">
<a href="#on_load_checkpoint" class="md-nav__link">
<a href="#on_load_checkpoint" title="on_load_checkpoint" class="md-nav__link">
on_load_checkpoint
</a>
@@ -414,7 +414,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#return_3" class="md-nav__link">
<a href="#return_3" title="Return" class="md-nav__link">
Return
</a>
@@ -426,7 +426,7 @@
</li>
<li class="md-nav__item">
<a href="#val_dataloader" class="md-nav__link">
<a href="#val_dataloader" title="val_dataloader" class="md-nav__link">
val_dataloader
</a>
@@ -434,7 +434,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#return_4" class="md-nav__link">
<a href="#return_4" title="Return" class="md-nav__link">
Return
</a>
@@ -446,7 +446,7 @@
</li>
<li class="md-nav__item">
<a href="#test_dataloader" class="md-nav__link">
<a href="#test_dataloader" title="test_dataloader" class="md-nav__link">
test_dataloader
</a>
@@ -454,7 +454,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#return_5" class="md-nav__link">
<a href="#return_5" title="Return" class="md-nav__link">
Return
</a>
@@ -466,7 +466,7 @@
</li>
<li class="md-nav__item">
<a href="#add_model_specific_args" class="md-nav__link">
<a href="#add_model_specific_args" title="add_model_specific_args" class="md-nav__link">
add_model_specific_args
</a>
@@ -474,7 +474,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#return_6" class="md-nav__link">
<a href="#return_6" title="Return" class="md-nav__link">
Return
</a>
@@ -731,21 +731,21 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="#minimal-example" class="md-nav__link">
<a href="#minimal-example" title="Minimal example" class="md-nav__link">
Minimal example
</a>
</li>
<li class="md-nav__item">
<a href="#how-do-these-methods-fit-into-the-broader-training" class="md-nav__link">
<a href="#how-do-these-methods-fit-into-the-broader-training" title="How do these methods fit into the broader training?" class="md-nav__link">
How do these methods fit into the broader training?
</a>
</li>
<li class="md-nav__item">
<a href="#required-methods" class="md-nav__link">
<a href="#required-methods" title="Required Methods" class="md-nav__link">
Required Methods
</a>
@@ -753,14 +753,14 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#training_step" class="md-nav__link">
<a href="#training_step" title="training_step" class="md-nav__link">
training_step
</a>
</li>
<li class="md-nav__item">
<a href="#train_dataloader" class="md-nav__link">
<a href="#train_dataloader" title="train_dataloader" class="md-nav__link">
train_dataloader
</a>
@@ -768,7 +768,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#return" class="md-nav__link">
<a href="#return" title="Return" class="md-nav__link">
Return
</a>
@@ -780,7 +780,7 @@
</li>
<li class="md-nav__item">
<a href="#configure_optimizers" class="md-nav__link">
<a href="#configure_optimizers" title="configure_optimizers" class="md-nav__link">
configure_optimizers
</a>
@@ -788,7 +788,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#return_1" class="md-nav__link">
<a href="#return_1" title="Return" class="md-nav__link">
Return
</a>
@@ -805,7 +805,7 @@
</li>
<li class="md-nav__item">
<a href="#optional-methods" class="md-nav__link">
<a href="#optional-methods" title="Optional Methods" class="md-nav__link">
Optional Methods
</a>
@@ -813,35 +813,35 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#validation_step" class="md-nav__link">
<a href="#validation_step" title="validation_step" class="md-nav__link">
validation_step
</a>
</li>
<li class="md-nav__item">
<a href="#validation_end" class="md-nav__link">
<a href="#validation_end" title="validation_end" class="md-nav__link">
validation_end
</a>
</li>
<li class="md-nav__item">
<a href="#test_step" class="md-nav__link">
<a href="#test_step" title="test_step" class="md-nav__link">
test_step
</a>
</li>
<li class="md-nav__item">
<a href="#test_end" class="md-nav__link">
<a href="#test_end" title="test_end" class="md-nav__link">
test_end
</a>
</li>
<li class="md-nav__item">
<a href="#on_save_checkpoint" class="md-nav__link">
<a href="#on_save_checkpoint" title="on_save_checkpoint" class="md-nav__link">
on_save_checkpoint
</a>
@@ -849,7 +849,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#return_2" class="md-nav__link">
<a href="#return_2" title="Return" class="md-nav__link">
Return
</a>
@@ -861,7 +861,7 @@
</li>
<li class="md-nav__item">
<a href="#on_load_checkpoint" class="md-nav__link">
<a href="#on_load_checkpoint" title="on_load_checkpoint" class="md-nav__link">
on_load_checkpoint
</a>
@@ -869,7 +869,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#return_3" class="md-nav__link">
<a href="#return_3" title="Return" class="md-nav__link">
Return
</a>
@@ -881,7 +881,7 @@
</li>
<li class="md-nav__item">
<a href="#val_dataloader" class="md-nav__link">
<a href="#val_dataloader" title="val_dataloader" class="md-nav__link">
val_dataloader
</a>
@@ -889,7 +889,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#return_4" class="md-nav__link">
<a href="#return_4" title="Return" class="md-nav__link">
Return
</a>
@@ -901,7 +901,7 @@
</li>
<li class="md-nav__item">
<a href="#test_dataloader" class="md-nav__link">
<a href="#test_dataloader" title="test_dataloader" class="md-nav__link">
test_dataloader
</a>
@@ -909,7 +909,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#return_5" class="md-nav__link">
<a href="#return_5" title="Return" class="md-nav__link">
Return
</a>
@@ -921,7 +921,7 @@
</li>
<li class="md-nav__item">
<a href="#add_model_specific_args" class="md-nav__link">
<a href="#add_model_specific_args" title="add_model_specific_args" class="md-nav__link">
add_model_specific_args
</a>
@@ -929,7 +929,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#return_6" class="md-nav__link">
<a href="#return_6" title="Return" class="md-nav__link">
Return
</a>
@@ -2047,7 +2047,7 @@ The <a href="https://williamfalcon.github.io/test-tube/hyperparameter_optimizati
</div>
<script src="../../assets/javascripts/application.c648116f.js"></script>
<script src="../../assets/javascripts/application.245445c6.js"></script>
<script>app.initialize({version:"1.0.4",url:{base:"../.."}})</script>
LightningModule/methods/index.html
+10 -10
View File
@@ -34,7 +34,7 @@
<meta name="lang:search.tokenizer" content="[\s\-]+">
<link rel="shortcut icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.4.2">
<meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.4.0">
@@ -42,7 +42,7 @@
<link rel="stylesheet" href="../../assets/stylesheets/application.30686662.css">
<link rel="stylesheet" href="../../assets/stylesheets/application.0284f74d.css">
@@ -171,7 +171,7 @@
<main class="md-main" role="main">
<main class="md-main">
<div class="md-main__inner md-grid" data-md-component="container">
@@ -284,21 +284,21 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="#freeze" class="md-nav__link">
<a href="#freeze" title="freeze" class="md-nav__link">
freeze
</a>
</li>
<li class="md-nav__item">
<a href="#load_from_metrics" class="md-nav__link">
<a href="#load_from_metrics" title="load_from_metrics" class="md-nav__link">
load_from_metrics
</a>
</li>
<li class="md-nav__item">
<a href="#unfreeze" class="md-nav__link">
<a href="#unfreeze" title="unfreeze" class="md-nav__link">
unfreeze
</a>
@@ -531,21 +531,21 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="#freeze" class="md-nav__link">
<a href="#freeze" title="freeze" class="md-nav__link">
freeze
</a>
</li>
<li class="md-nav__item">
<a href="#load_from_metrics" class="md-nav__link">
<a href="#load_from_metrics" title="load_from_metrics" class="md-nav__link">
load_from_metrics
</a>
</li>
<li class="md-nav__item">
<a href="#unfreeze" class="md-nav__link">
<a href="#unfreeze" title="unfreeze" class="md-nav__link">
unfreeze
</a>
@@ -716,7 +716,7 @@ The meta_tags.csv file can be found in the test-tube experiment save_dir.
</div>
<script src="../../assets/javascripts/application.c648116f.js"></script>
<script src="../../assets/javascripts/application.245445c6.js"></script>
<script>app.initialize({version:"1.0.4",url:{base:"../.."}})</script>
LightningModule/properties/index.html
+37 -29
View File
@@ -34,7 +34,7 @@
<meta name="lang:search.tokenizer" content="[\s\-]+">
<link rel="shortcut icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.4.2">
<meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.4.0">
@@ -42,7 +42,7 @@
<link rel="stylesheet" href="../../assets/stylesheets/application.30686662.css">
<link rel="stylesheet" href="../../assets/stylesheets/application.0284f74d.css">
@@ -171,7 +171,7 @@
<main class="md-main" role="main">
<main class="md-main">
<div class="md-main__inner md-grid" data-md-component="container">
@@ -296,56 +296,56 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="#current_epoch" class="md-nav__link">
<a href="#current_epoch" title="current_epoch" class="md-nav__link">
current_epoch
</a>
</li>
<li class="md-nav__item">
<a href="#dtype" class="md-nav__link">
<a href="#dtype" title="dtype" class="md-nav__link">
dtype
</a>
</li>
<li class="md-nav__item">
<a href="#experiment" class="md-nav__link">
experiment
<a href="#logger" title="logger" class="md-nav__link">
logger
</a>
</li>
<li class="md-nav__item">
<a href="#global_step" class="md-nav__link">
<a href="#global_step" title="global_step" class="md-nav__link">
global_step
</a>
</li>
<li class="md-nav__item">
<a href="#gradient_clip_val" class="md-nav__link">
<a href="#gradient_clip_val" title="gradient_clip_val" class="md-nav__link">
gradient_clip_val
</a>
</li>
<li class="md-nav__item">
<a href="#on_gpu" class="md-nav__link">
<a href="#on_gpu" title="on_gpu" class="md-nav__link">
on_gpu
</a>
</li>
<li class="md-nav__item">
<a href="#trainer" class="md-nav__link">
<a href="#trainer" title="trainer" class="md-nav__link">
trainer
</a>
</li>
<li class="md-nav__item">
<a href="#debugging" class="md-nav__link">
<a href="#debugging" title="Debugging" class="md-nav__link">
Debugging
</a>
@@ -353,7 +353,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#example_input_array" class="md-nav__link">
<a href="#example_input_array" title="example_input_array" class="md-nav__link">
example_input_array
</a>
@@ -579,56 +579,56 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="#current_epoch" class="md-nav__link">
<a href="#current_epoch" title="current_epoch" class="md-nav__link">
current_epoch
</a>
</li>
<li class="md-nav__item">
<a href="#dtype" class="md-nav__link">
<a href="#dtype" title="dtype" class="md-nav__link">
dtype
</a>
</li>
<li class="md-nav__item">
<a href="#experiment" class="md-nav__link">
experiment
<a href="#logger" title="logger" class="md-nav__link">
logger
</a>
</li>
<li class="md-nav__item">
<a href="#global_step" class="md-nav__link">
<a href="#global_step" title="global_step" class="md-nav__link">
global_step
</a>
</li>
<li class="md-nav__item">
<a href="#gradient_clip_val" class="md-nav__link">
<a href="#gradient_clip_val" title="gradient_clip_val" class="md-nav__link">
gradient_clip_val
</a>
</li>
<li class="md-nav__item">
<a href="#on_gpu" class="md-nav__link">
<a href="#on_gpu" title="on_gpu" class="md-nav__link">
on_gpu
</a>
</li>
<li class="md-nav__item">
<a href="#trainer" class="md-nav__link">
<a href="#trainer" title="trainer" class="md-nav__link">
trainer
</a>
</li>
<li class="md-nav__item">
<a href="#debugging" class="md-nav__link">
<a href="#debugging" title="Debugging" class="md-nav__link">
Debugging
</a>
@@ -636,7 +636,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#example_input_array" class="md-nav__link">
<a href="#example_input_array" title="example_input_array" class="md-nav__link">
example_input_array
</a>
@@ -676,13 +676,21 @@
<h4 id="dtype">dtype</h4>
<p>Current dtype </p>
<hr />
<h4 id="experiment">experiment</h4>
<p>An instance of test-tube Experiment which you can use to log anything for tensorboard (subclass of <a href="https://pytorch.org/docs/stable/tensorboard.html">PyTorch SummaryWriter</a>). </p>
<h4 id="logger">logger</h4>
<p>A reference to the logger you passed into trainer. </p>
<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre>1</pre></div></td><td class="code"><div class="codehilite"><pre><span></span><span class="n">Trainer</span><span class="p">(</span><span class="n">logger</span><span class="o">=</span><span class="n">your_logger</span><span class="p">)</span>
</pre></div>
</td></tr></table>
<p>Call it from anywhere in your LightningModule to add metrics, images, etc... whatever your logger supports. </p>
<p>Here is an example using the Test-tube logger (which is a wrapper on <a href="https://pytorch.org/docs/stable/tensorboard.html">PyTorch SummaryWriter</a> with versioned folder structure). </p>
<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre>1
2
3</pre></div></td><td class="code"><div class="codehilite"><pre><span></span><span class="bp">self</span><span class="o">.</span><span class="n">experiment</span><span class="o">.</span><span class="n">add_embedding</span><span class="p">(</span><span class="o">...</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">experiment</span><span class="o">.</span><span class="n">log</span><span class="p">({</span><span class="s1">&#39;val_loss&#39;</span><span class="p">:</span> <span class="mf">0.9</span><span class="p">})</span>
<span class="bp">self</span><span class="o">.</span><span class="n">experiment</span><span class="o">.</span><span class="n">add_scalars</span><span class="p">(</span><span class="o">...</span><span class="p">)</span>
3
4</pre></div></td><td class="code"><div class="codehilite"><pre><span></span><span class="c1"># if logger is a tensorboard logger or test-tube experiment</span>
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">add_embedding</span><span class="p">(</span><span class="o">...</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">log</span><span class="p">({</span><span class="s1">&#39;val_loss&#39;</span><span class="p">:</span> <span class="mf">0.9</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">add_scalars</span><span class="p">(</span><span class="o">...</span><span class="p">)</span>
</pre></div>
</td></tr></table>
@@ -788,7 +796,7 @@ to get a print out of sizes coming into and out of every layer. </p>
</div>
<script src="../../assets/javascripts/application.c648116f.js"></script>
<script src="../../assets/javascripts/application.245445c6.js"></script>
<script>app.initialize({version:"1.0.4",url:{base:"../.."}})</script>