parent
bf2067a609
commit
6950874ae0
|
@ -21,8 +21,10 @@ PyTorch Lightning Documentation
|
|||
:name: guides
|
||||
:caption: Best practices
|
||||
|
||||
performance
|
||||
style_guide
|
||||
performance
|
||||
Lightning project template<https://github.com/PyTorchLightning/pytorch-lightning-conference-seed>
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
@ -75,13 +77,6 @@ PyTorch Lightning Documentation
|
|||
SimCLR <https://pytorch-lightning-bolts.readthedocs.io/en/latest/self_supervised_models.html#simclr>
|
||||
VAE <https://pytorch-lightning-bolts.readthedocs.io/en/latest/autoencoders.html#basic-vae>
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:name: project structure
|
||||
:caption: Recommended Lightning Project Layout
|
||||
|
||||
Lightning project seed <https://github.com/PyTorchLightning/pytorch-lightning-conference-seed>
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:name: Common Use Cases
|
||||
|
|
|
@ -119,6 +119,10 @@ Step 1: Define LightningModule
|
|||
optimizer = torch.optim.Adam(self.parameters(), lr=1e-3)
|
||||
return optimizer
|
||||
|
||||
.. figure:: https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/pl_docs/model_system.png
|
||||
:width: 800
|
||||
|
||||
|
||||
A :class:`~pytorch_lightning.core.LightningModule` defines a *system* such as:
|
||||
|
||||
- `Autoencoder <https://github.com/PyTorchLightning/pytorch-lightning-bolts/blob/master/pl_bolts/models/autoencoders/basic_ae/basic_ae_module.py>`_
|
||||
|
|
|
@ -1,8 +1,11 @@
|
|||
.. _performance:
|
||||
|
||||
Fast Performance
|
||||
================
|
||||
Here are some best practices to increase your performance.
|
||||
Fast performance tips
|
||||
=====================
|
||||
Lightning builds in all the micro-optimizations we can find to increase your performance.
|
||||
But we can only automate so much.
|
||||
|
||||
Here are some additional things you can do to increase your performance.
|
||||
|
||||
----------
|
||||
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
###########
|
||||
Style Guide
|
||||
Style guide
|
||||
###########
|
||||
A main goal of Lightning is to improve readability and reproducibility. Imagine looking into any GitHub repo,
|
||||
finding a lightning module and knowing exactly where to look to find the things you care about.
|
||||
|
@ -15,6 +15,10 @@ These are best practices about structuring your LightningModule
|
|||
|
||||
Systems vs models
|
||||
=================
|
||||
|
||||
.. figure:: https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/pl_docs/model_system.png
|
||||
:width: 800
|
||||
|
||||
The main principle behind a LightningModule is that a full system should be self-contained.
|
||||
In Lightning we differentiate between a system and a model.
|
||||
|
||||
|
|
Loading…
Reference in New Issue