Skip to content

Commit

Permalink
Add usage of Jupyter magic command for loggers (#12333)
Browse files Browse the repository at this point in the history
Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>
Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>
  • Loading branch information
3 people committed Mar 29, 2022
1 parent 42169a2 commit c6cb634
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions docs/source/common/loggers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,19 @@ The :class:`~pytorch_lightning.loggers.TensorBoardLogger` is available anywhere
some_img = fake_image()
self.logger.experiment.add_image("generated_images", some_img, 0)

To see your logs, run the following command in the terminal:

.. code-block:: bash
tensorboard --logdir=<logging_folder>
To visualize tensorboard in a jupyter notebook environment, run the following command in a jupyter cell:

.. code-block:: bash
%reload_ext tensorboard
%tensorboard --logdir=<logging_folder>
.. seealso::
:class:`~pytorch_lightning.loggers.TensorBoardLogger` docs.

Expand Down Expand Up @@ -217,6 +230,23 @@ The :class:`~pytorch_lightning.loggers.WandbLogger` is available anywhere except
# Option 2 for specifically logging images
self.logger.log_image(key="generated_images", images=[some_img])
To visualize using wandb in a jupyter notebook environment use the following magic line command:

.. code-block:: shell
%%wandb
# Your training loop here
To display any existing dashboards, sweeps or reports directly in your notebook using the %wandb magic:

.. code-block:: shell
# Display a project workspace
%wandb USERNAME/PROJECT
More information is available `here <https://docs.wandb.ai/guides/track/jupyter>`__.

.. seealso::
- :class:`~pytorch_lightning.loggers.WandbLogger` docs.
- `W&B Documentation <https://docs.wandb.ai/integrations/lightning>`__
Expand Down

0 comments on commit c6cb634

Please sign in to comment.