2019-11-28 17:48:55 +00:00
|
|
|
.. PyTorch-Lightning documentation master file, created by
|
|
|
|
sphinx-quickstart on Fri Nov 15 07:48:22 2019.
|
|
|
|
You can adapt this file completely to your liking, but it should at least
|
|
|
|
contain the root `toctree` directive.
|
|
|
|
|
2020-03-06 11:50:11 +00:00
|
|
|
PyTorch Lightning Documentation
|
2020-02-09 22:39:10 +00:00
|
|
|
===============================
|
2019-11-28 17:48:55 +00:00
|
|
|
|
2019-12-07 05:23:48 +00:00
|
|
|
.. toctree::
|
2020-01-17 11:03:31 +00:00
|
|
|
:maxdepth: 1
|
2019-12-07 05:23:48 +00:00
|
|
|
:name: start
|
2020-08-30 15:01:16 +00:00
|
|
|
:caption: Getting started
|
2019-12-07 05:23:48 +00:00
|
|
|
|
2020-08-20 15:45:28 +00:00
|
|
|
new-project
|
2020-08-30 15:01:16 +00:00
|
|
|
converting
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 1
|
|
|
|
:name: advanced
|
|
|
|
:caption: Advanced use
|
|
|
|
|
2020-03-03 17:22:52 +00:00
|
|
|
introduction_guide
|
2020-06-15 12:02:19 +00:00
|
|
|
performance
|
2019-12-07 05:23:48 +00:00
|
|
|
|
2020-08-30 13:31:36 +00:00
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 2
|
|
|
|
:name: pl_docs
|
|
|
|
:caption: Lightning API
|
|
|
|
|
|
|
|
lightning-module
|
|
|
|
trainer
|
|
|
|
|
2019-12-07 05:23:48 +00:00
|
|
|
.. toctree::
|
2020-03-06 00:53:05 +00:00
|
|
|
:maxdepth: 2
|
2019-12-07 05:23:48 +00:00
|
|
|
:name: docs
|
2020-08-30 13:31:36 +00:00
|
|
|
:caption: Optional extensions
|
2020-01-17 11:03:31 +00:00
|
|
|
|
|
|
|
callbacks
|
2020-07-26 05:38:55 +00:00
|
|
|
datamodules
|
2020-02-11 04:55:22 +00:00
|
|
|
loggers
|
2020-05-19 15:05:07 +00:00
|
|
|
metrics
|
2020-08-02 02:31:56 +00:00
|
|
|
results
|
2020-08-16 03:57:33 +00:00
|
|
|
|
2020-07-01 11:38:00 +00:00
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 1
|
|
|
|
:name: Bolts
|
|
|
|
:caption: Bolts
|
|
|
|
|
|
|
|
bolts
|
|
|
|
|
2020-01-17 11:03:31 +00:00
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 1
|
2020-08-30 13:31:36 +00:00
|
|
|
:name: Examples
|
|
|
|
:caption: Examples
|
|
|
|
|
|
|
|
community_examples
|
|
|
|
Autoencoder <https://pytorch-lightning-bolts.readthedocs.io/en/latest/autoencoders.html#autoencoders>
|
|
|
|
BYOL <https://pytorch-lightning-bolts.readthedocs.io/en/latest/self_supervised_models.html#byol>
|
|
|
|
DQN <https://pytorch-lightning-bolts.readthedocs.io/en/latest/reinforce_learn.html#deep-q-network-dqn>
|
|
|
|
GAN <https://pytorch-lightning-bolts.readthedocs.io/en/latest/gans.html#basic-gan>
|
|
|
|
GPT-2 <https://pytorch-lightning-bolts.readthedocs.io/en/latest/convolutional.html#gpt-2>
|
|
|
|
Image-GPT <https://pytorch-lightning-bolts.readthedocs.io/en/latest/convolutional.html#image-gpt>
|
|
|
|
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>
|
2020-01-17 11:03:31 +00:00
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 1
|
|
|
|
:name: Tutorials
|
|
|
|
:caption: Tutorials
|
|
|
|
|
2020-08-07 20:43:52 +00:00
|
|
|
PyTorch Lightning 101 class <https://www.youtube.com/playlist?list=PLaMu-SDt_RB5NUm67hU2pdE75j6KaIOv2>
|
2020-03-02 03:15:55 +00:00
|
|
|
From PyTorch to PyTorch Lightning <https://towardsdatascience.com/from-pytorch-to-pytorch-lightning-a-gentle-introduction-b371b7caaf09>
|
2020-06-17 14:53:48 +00:00
|
|
|
Video on how to refactor PyTorch into PyTorch Lightning <https://www.youtube.com/watch?v=QHww1JH7IDU>
|
2020-01-17 11:03:31 +00:00
|
|
|
|
2020-05-17 14:05:11 +00:00
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 1
|
|
|
|
:name: project structure
|
|
|
|
:caption: Recommended Lightning Project Layout
|
|
|
|
|
|
|
|
Lightning project seed <https://github.com/PyTorchLightning/pytorch-lightning-conference-seed>
|
|
|
|
|
2020-01-17 11:03:31 +00:00
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 1
|
|
|
|
:name: Common Use Cases
|
|
|
|
:caption: Common Use Cases
|
|
|
|
|
2020-02-11 04:55:22 +00:00
|
|
|
apex
|
|
|
|
slurm
|
2020-03-03 15:52:16 +00:00
|
|
|
child_modules
|
2020-02-11 04:55:22 +00:00
|
|
|
debugging
|
|
|
|
experiment_logging
|
|
|
|
experiment_reporting
|
|
|
|
early_stopping
|
|
|
|
fast_training
|
|
|
|
hooks
|
2020-03-03 15:52:16 +00:00
|
|
|
hyperparameters
|
2020-04-10 18:34:23 +00:00
|
|
|
lr_finder
|
2020-02-11 04:55:22 +00:00
|
|
|
multi_gpu
|
2020-04-08 15:38:12 +00:00
|
|
|
multiple_loaders
|
2020-03-02 22:12:22 +00:00
|
|
|
weights_loading
|
2020-03-03 21:42:49 +00:00
|
|
|
optimizers
|
|
|
|
profiler
|
2020-02-11 04:55:22 +00:00
|
|
|
single_gpu
|
|
|
|
sequences
|
|
|
|
training_tricks
|
2020-03-03 15:52:16 +00:00
|
|
|
transfer_learning
|
2020-02-17 21:01:20 +00:00
|
|
|
tpu
|
2020-02-11 04:55:22 +00:00
|
|
|
test_set
|
2020-07-31 10:27:57 +00:00
|
|
|
production_inference
|
2019-12-07 05:23:48 +00:00
|
|
|
|
2019-11-28 17:48:55 +00:00
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 1
|
2019-12-07 05:23:48 +00:00
|
|
|
:name: community
|
|
|
|
:caption: Community
|
2019-11-28 17:48:55 +00:00
|
|
|
|
2020-01-21 20:18:32 +00:00
|
|
|
|
2019-12-07 05:23:48 +00:00
|
|
|
CODE_OF_CONDUCT.md
|
|
|
|
CONTRIBUTING.md
|
|
|
|
BECOMING_A_CORE_CONTRIBUTOR.md
|
2020-01-17 11:03:31 +00:00
|
|
|
governance.md
|
2019-11-28 17:48:55 +00:00
|
|
|
|
|
|
|
Indices and tables
|
|
|
|
------------------
|
|
|
|
|
|
|
|
* :ref:`genindex`
|
|
|
|
* :ref:`modindex`
|
|
|
|
* :ref:`search`
|
2020-03-20 19:49:01 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
.. This is here to make sphinx aware of the modules but not throw an error/warning
|
|
|
|
.. toctree::
|
|
|
|
:hidden:
|
|
|
|
|
2020-05-04 20:53:06 +00:00
|
|
|
api/pytorch_lightning.core
|
|
|
|
api/pytorch_lightning.callbacks
|
|
|
|
api/pytorch_lightning.loggers
|
2020-05-19 15:05:07 +00:00
|
|
|
api/pytorch_lightning.metrics
|
2020-05-04 20:53:06 +00:00
|
|
|
api/pytorch_lightning.overrides
|
|
|
|
api/pytorch_lightning.profiler
|
|
|
|
api/pytorch_lightning.trainer
|
2020-05-17 14:05:11 +00:00
|
|
|
api/pytorch_lightning.utilities
|
2020-09-08 22:46:42 +00:00
|
|
|
api/pytorch_lightning.tuner
|