Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add usage of Jupyter magic command for loggers #12333

Merged
merged 10 commits into from Mar 29, 2022
38 changes: 38 additions & 0 deletions docs/source/common/loggers.rst
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,31 @@ 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:
rohitgr7 marked this conversation as resolved.
Show resolved Hide resolved

.. code-block:: shell

%%wandb
manangoel99 marked this conversation as resolved.
Show resolved Hide resolved

# 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
# Display a single run
%wandb USERNAME/PROJECT/runs/RUN_ID
# Display a sweep
%wandb USERNAME/PROJECT/sweeps/SWEEP_ID
# Display a report
%wandb USERNAME/PROJECT/reports/REPORT_ID
# Specify the height of embedded iframe
%wandb USERNAME/PROJECT -h 2048

More information is available `here https://docs.wandb.ai/guides/track/jupyter`__.
rohitgr7 marked this conversation as resolved.
Show resolved Hide resolved

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