132 lines
3.0 KiB
ReStructuredText
132 lines
3.0 KiB
ReStructuredText
.. 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.
|
|
|
|
PyTorch Lightning Documentation
|
|
===============================
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:name: start
|
|
:caption: Getting started
|
|
|
|
new-project
|
|
converting
|
|
rapid_prototyping_templates
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:name: guides
|
|
:caption: Best practices
|
|
|
|
style_guide
|
|
performance
|
|
Lightning project template<https://github.com/PyTorchLightning/pytorch-lightning-conference-seed>
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:name: pl_docs
|
|
:caption: Lightning API
|
|
|
|
lightning_module
|
|
trainer
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:name: docs
|
|
:caption: Optional extensions
|
|
|
|
callbacks
|
|
datamodules
|
|
logging
|
|
metrics
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:name: Tutorials
|
|
:caption: Tutorials
|
|
|
|
introduction_guide
|
|
PyTorch Lightning 101 class <https://www.youtube.com/playlist?list=PLaMu-SDt_RB5NUm67hU2pdE75j6KaIOv2>
|
|
From PyTorch to PyTorch Lightning [Blog] <https://towardsdatascience.com/from-pytorch-to-pytorch-lightning-a-gentle-introduction-b371b7caaf09>
|
|
From PyTorch to PyTorch Lightning [Video] <https://www.youtube.com/watch?v=QHww1JH7IDU>
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:name: Bolts
|
|
:caption: Bolts
|
|
|
|
bolts
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
: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>
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:name: Common Use Cases
|
|
:caption: Common Use Cases
|
|
|
|
cloud_training
|
|
amp
|
|
slurm
|
|
child_modules
|
|
debugging
|
|
loggers
|
|
early_stopping
|
|
fast_training
|
|
hyperparameters
|
|
lr_finder
|
|
multi_gpu
|
|
multiple_loaders
|
|
weights_loading
|
|
optimizers
|
|
profiler
|
|
single_gpu
|
|
sequences
|
|
training_tricks
|
|
transfer_learning
|
|
tpu
|
|
test_set
|
|
production_inference
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:name: Partner Domain Frameworks
|
|
:caption: Partner Domain Frameworks
|
|
|
|
asr_tts
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:name: community
|
|
:caption: Community
|
|
|
|
|
|
CODE_OF_CONDUCT.md
|
|
CONTRIBUTING.md
|
|
BECOMING_A_CORE_CONTRIBUTOR.md
|
|
governance.md
|
|
CHANGELOG.md
|
|
|
|
Indices and tables
|
|
------------------
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`search`
|