diff --git a/docs/source/callbacks.rst b/docs/source/callbacks.rst new file mode 100644 index 00000000..ae8dd25f --- /dev/null +++ b/docs/source/callbacks.rst @@ -0,0 +1,14 @@ +.. role:: hidden + :class: hidden-section + +Callbacks +=========== +.. automodule:: pytorch_lightning.callbacks + :exclude-members: + _del_model, + _save_model, + on_epoch_end, + on_train_end, + on_epoch_begin, + check_monitor_top_k, + on_train_begin, \ No newline at end of file diff --git a/docs/source/common-cases.rst b/docs/source/common-cases.rst new file mode 100644 index 00000000..7b96a93d --- /dev/null +++ b/docs/source/common-cases.rst @@ -0,0 +1,21 @@ +Multi-gpu (same node) training +============================== + +Multi-node training +==================== + +16-bit precision +================= + +gradient clipping +================= + +modifying training via hooks +============================= + + + +.. toctree:: + :maxdepth: 3 + + pl_examples \ No newline at end of file diff --git a/docs/source/lightning-module.rst b/docs/source/lightning-module.rst new file mode 100644 index 00000000..93c81537 --- /dev/null +++ b/docs/source/lightning-module.rst @@ -0,0 +1,10 @@ +.. role:: hidden + :class: hidden-section + +LightningModule +=========== +.. automodule:: pytorch_lightning.core + :exclude-members: + _abc_impl, + summarize, + diff --git a/docs/source/logging.rst b/docs/source/logging.rst new file mode 100644 index 00000000..24f49f0a --- /dev/null +++ b/docs/source/logging.rst @@ -0,0 +1,12 @@ +.. role:: hidden + :class: hidden-section + +Logging +=========== +.. automodule:: pytorch_lightning.logging + :exclude-members: + _abc_impl, + _save_model, + on_epoch_end, + on_train_end, + on_epoch_begin, diff --git a/docs/source/modules.rst b/docs/source/modules.rst new file mode 100644 index 00000000..e4c51218 --- /dev/null +++ b/docs/source/modules.rst @@ -0,0 +1,7 @@ +pl_examples +=========== + +.. toctree:: + :maxdepth: 4 + + pl_examples diff --git a/docs/source/trainer.rst b/docs/source/trainer.rst new file mode 100644 index 00000000..db2657dc --- /dev/null +++ b/docs/source/trainer.rst @@ -0,0 +1,21 @@ +.. role:: hidden + :class: hidden-section + +Trainer +=========== +.. automodule:: pytorch_lightning.trainer + :members: fit, test + :exclude-members: + run_pretrain_routine, + _abc_impl, + _Trainer__set_root_gpu, + _Trainer__init_optimizers, + _Trainer__parse_gpu_ids, + _Trainer__configure_schedulers, + data_parallel, + num_gpus, + slurm_job_id, + tng_tqdm_dic, + training_tqdm_dict, + init_optimizers, + configure_schedulers diff --git a/docs/source/tutorials.rst b/docs/source/tutorials.rst new file mode 100644 index 00000000..7b66d141 --- /dev/null +++ b/docs/source/tutorials.rst @@ -0,0 +1,20 @@ +Refactoring PyTorch into Lightning +================================== +`Tutorial `_ + +Start a research project +========================= +`Research seed `_ + +Basic Lightning use +==================== +`Tutorial `_ + +9 key Lightning tricks +======================== +`Tutorial <9 key speed features in Pytorch-Lightning>`_ + +Multi-node training on SLURM +============================= +`Tutorial `_ +