mirror of
https://github.com/wassname/pytorch-lightning.git
synced 2026-09-18 12:50:58 +08:00
278 lines
8.7 KiB
HTML
278 lines
8.7 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="description" content="Documentation for Pytorch Pytorch-Lightning, the researcher version of keras.">
|
|
|
|
<link rel="shortcut icon" href="img/favicon.ico">
|
|
<title>PYTORCH-LIGHTNING DOCUMENTATION - Pytorch lightning Documentation</title>
|
|
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
|
|
|
|
<link rel="stylesheet" href="css/theme.css" type="text/css" />
|
|
<link rel="stylesheet" href="css/theme_extra.css" type="text/css" />
|
|
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css">
|
|
|
|
<script>
|
|
// Current page data
|
|
var mkdocs_page_name = "PYTORCH-LIGHTNING DOCUMENTATION";
|
|
var mkdocs_page_input_path = "index.md";
|
|
var mkdocs_page_url = null;
|
|
</script>
|
|
|
|
<script src="js/jquery-2.1.1.min.js" defer></script>
|
|
<script src="js/modernizr-2.8.3.min.js" defer></script>
|
|
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-nav-search">
|
|
<a href="." class="icon icon-home"> Pytorch lightning Documentation</a>
|
|
<div role="search">
|
|
<form id ="rtd-search-form" class="wy-form" action="./search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
<ul class="current">
|
|
|
|
|
|
<li class="toctree-l1 current">
|
|
|
|
<a class="current" href=".">PYTORCH-LIGHTNING DOCUMENTATION</a>
|
|
<ul class="subnav">
|
|
|
|
<li class="toctree-l2"><a href="#pytorch-lightning-documentation">PYTORCH-LIGHTNING DOCUMENTATION</a></li>
|
|
|
|
<ul>
|
|
|
|
<li><a class="toctree-l3" href="#quick-start">Quick start</a></li>
|
|
|
|
<li><a class="toctree-l3" href="#quick-start-examples">Quick start examples</a></li>
|
|
|
|
<li><a class="toctree-l3" href="#training-loop">Training loop</a></li>
|
|
|
|
<li><a class="toctree-l3" href="#validation-loop">Validation loop</a></li>
|
|
|
|
<li><a class="toctree-l3" href="#distributed-training">Distributed training</a></li>
|
|
|
|
<li><a class="toctree-l3" href="#checkpointing">Checkpointing</a></li>
|
|
|
|
<li><a class="toctree-l3" href="#computing-cluster-slurm">Computing cluster (SLURM)</a></li>
|
|
|
|
</ul>
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<span class="caption-text">Pytorch Lightning</span>
|
|
<ul class="subnav">
|
|
<li class="">
|
|
|
|
<a class="" href="Pytorch-Lightning/LightningModule/">Lightning module</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<span class="caption-text">Trainer</span>
|
|
<ul class="subnav">
|
|
<li class="">
|
|
|
|
<a class="" href="Trainer/">Trainer</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="Trainer/Checkpointing/">Checkpointing</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="Trainer/Distributed training/">Distributed training</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="Trainer/Logging/">Logging</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="Trainer/SLURM Managed Cluster/">SLURM Managed Cluster</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="Trainer/Training Loop/">Training Loop</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="Trainer/Validation loop/">Validation loop</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="Trainer/debugging/">Debugging</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="Trainer/hooks/">Hooks</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href=".">Pytorch lightning Documentation</a>
|
|
</nav>
|
|
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href=".">Docs</a> »</li>
|
|
|
|
|
|
|
|
<li>PYTORCH-LIGHTNING DOCUMENTATION</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
<a href="https://github.com/williamFalcon/pytorch-lightning/edit/master/docs/index.md"
|
|
class="icon icon-github"> Edit on GitHub</a>
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main">
|
|
<div class="section">
|
|
|
|
<h1 id="pytorch-lightning-documentation">PYTORCH-LIGHTNING DOCUMENTATION</h1>
|
|
<h6 id="quick-start">Quick start</h6>
|
|
<ul>
|
|
<li><a href="Pytorch-Lightning/LightningModule/">Define a LightningModule</a> </li>
|
|
<li>Set up the trainer </li>
|
|
</ul>
|
|
<h6 id="quick-start-examples">Quick start examples</h6>
|
|
<ul>
|
|
<li>CPU example </li>
|
|
<li>Single GPU example </li>
|
|
<li>Multi-gpu example </li>
|
|
<li>SLURM cluster grid search example </li>
|
|
</ul>
|
|
<h6 id="training-loop">Training loop</h6>
|
|
<ul>
|
|
<li>Accumulate gradients</li>
|
|
<li>Check GPU usage</li>
|
|
<li>Check which gradients are nan</li>
|
|
<li>Check validation every n epochs</li>
|
|
<li>Display metrics in progress bar</li>
|
|
<li>Force training for min or max epochs</li>
|
|
<li>Inspect gradient norms</li>
|
|
<li>Hooks</li>
|
|
<li>Learning rate annealing</li>
|
|
<li>Make model overfit on subset of data</li>
|
|
<li>Multiple optimizers (like GANs)</li>
|
|
<li>Set how much of the training set to check (1-100%)</li>
|
|
<li>training_step function</li>
|
|
</ul>
|
|
<h6 id="validation-loop">Validation loop</h6>
|
|
<ul>
|
|
<li>Display metrics in progress bar</li>
|
|
<li>hooks</li>
|
|
<li>Set how much of the validation set to check (1-100%)</li>
|
|
<li>Set validation check frequency within 1 training epoch (1-100%)</li>
|
|
<li>validation_step function</li>
|
|
<li>Why does validation run first for 5 steps?</li>
|
|
</ul>
|
|
<h6 id="distributed-training">Distributed training</h6>
|
|
<ul>
|
|
<li>Single-gpu </li>
|
|
<li>Multi-gpu </li>
|
|
<li>Multi-node </li>
|
|
<li>16-bit mixed precision</li>
|
|
</ul>
|
|
<h6 id="checkpointing">Checkpointing</h6>
|
|
<ul>
|
|
<li>Model saving</li>
|
|
<li>Model loading </li>
|
|
</ul>
|
|
<h6 id="computing-cluster-slurm">Computing cluster (SLURM)</h6>
|
|
<ul>
|
|
<li>Automatic checkpointing </li>
|
|
<li>Automatic saving, loading </li>
|
|
<li>Running grid search on a cluster </li>
|
|
<li>Walltime auto-resubmit </li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="Pytorch-Lightning/LightningModule/" class="btn btn-neutral float-right" title="Lightning module">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
|
|
</div>
|
|
|
|
Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" style="cursor: pointer">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<a href="https://github.com/williamFalcon/pytorch-lightning/" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
|
|
|
|
|
|
|
|
<span style="margin-left: 15px"><a href="Pytorch-Lightning/LightningModule/" style="color: #fcfcfc">Next »</a></span>
|
|
|
|
</span>
|
|
</div>
|
|
<script>var base_url = '.';</script>
|
|
<script src="js/theme.js" defer></script>
|
|
<script src="search/main.js" defer></script>
|
|
|
|
</body>
|
|
</html>
|
|
|
|
<!--
|
|
MkDocs version : 1.0.4
|
|
Build Date UTC : 2019-06-27 17:47:30
|
|
-->
|