update deprecated messages (#810)

* update deprecated messages

* formatting

* fix docs tags
This commit is contained in:
Jirka Borovec
2020-02-11 07:41:15 -05:00
committed by GitHub
parent ed26c177b2
commit 853c4c1e7b
18 changed files with 63 additions and 52 deletions
+1 -1
View File
@@ -2,7 +2,7 @@
:class: hidden-section
Callbacks
===========
=========
.. automodule:: pytorch_lightning.callbacks
:exclude-members:
_del_model,
+3 -1
View File
@@ -348,8 +348,10 @@ def linkcode_resolve(domain, info):
autodoc_member_order = 'groupwise'
autoclass_content = 'both'
# the options are fixed and will be soon in release,
# see https://github.com/sphinx-doc/sphinx/issues/5459
autodoc_default_options = {
'members': True,
'members': None,
'special-members': '__call__',
'undoc-members': True,
# 'exclude-members': '__weakref__',
+4 -4
View File
@@ -2,7 +2,7 @@ Experiment Logging
===================
Comet.ml
^^^^^^^^^^
^^^^^^^^
`Comet.ml <https://www.comet.ml/site/>`_ is a third-party logger.
To use CometLogger as your logger do the following.
@@ -63,7 +63,7 @@ The Neptune.ai is available anywhere in your LightningModule
self.logger.experiment.add_image('generated_images', some_img, 0)
Tensorboard
^^^^^^^^^^^^^
^^^^^^^^^^^
To use `Tensorboard <https://pytorch.org/docs/stable/tensorboard.html>`_ as your logger do the following.
@@ -88,7 +88,7 @@ The TensorBoardLogger is available anywhere in your LightningModule
Test Tube
^^^^^^^^^^^^^
^^^^^^^^^
`Test Tube <https://github.com/williamFalcon/test-tube>`_ is a tensorboard logger but with nicer file structure.
To use TestTube as your logger do the following.
@@ -113,7 +113,7 @@ The TestTubeLogger is available anywhere in your LightningModule
self.logger.experiment.add_image('generated_images', some_img, 0)
Wandb
^^^^^^^^^^^^^
^^^^^
`Wandb <https://www.wandb.com/>`_ is a third-party logger.
To use Wandb as your logger do the following.
+6 -6
View File
@@ -7,7 +7,7 @@ used in each experiment.
Control logging frequency
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^
It may slow training down to log every single batch. Trainer has an option to log every k batches instead.
@@ -17,7 +17,7 @@ It may slow training down to log every single batch. Trainer has an option to lo
Trainer(row_log_interval=10)
Control log writing frequency
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Writing to a logger can be expensive. In Lightning you can set the interval at which you
want to log using this trainer flag.
@@ -30,7 +30,7 @@ want to log using this trainer flag.
Trainer(log_save_interval=k)
Log metrics
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^
To plot metrics into whatever logger you passed in (tensorboard, comet, neptune, etc...)
@@ -90,7 +90,7 @@ For instance, here we log images using tensorboard.
return results
Modify progress bar
^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^
Each return dict from the training_end, validation_end, testing_end and training_step also has
a key called "progress_bar".
@@ -108,7 +108,7 @@ Here we show the validation loss in the progress bar
return results
Snapshot hyperparameters
^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^
When training a model, it's useful to know what hyperparams went into that model.
When Lightning creates a checkpoint, it stores a key "hparams" with the hyperparams.
@@ -122,7 +122,7 @@ when using the TestTubeLogger or the TensorBoardLogger, all hyperparams will sho
in the `hparams tab <https://pytorch.org/docs/stable/tensorboard.html#torch.utils.tensorboard.writer.SummaryWriter.add_hparams>`_.
Snapshot code
^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^
Loggers also allow you to snapshot a copy of the code used in this experiment.
For example, TestTubeLogger does this with a flag:
+1 -1
View File
@@ -17,7 +17,7 @@ To run the test set after training completes, use this method
Test pre-trained model
-----------------
----------------------
To run the test set on a pretrained model, use this method.
.. code-block:: python
+2 -1
View File
@@ -2,7 +2,8 @@
:class: hidden-section
Trainer
===========
=======
.. automodule:: pytorch_lightning.trainer
:members: fit, test
:exclude-members: