Skip to content

Commit cac9ffa

Browse files
leoleoasdBorda
authored andcommitted
Document how to use TensorBoardLogger with fsspec (#16320)
(cherry picked from commit 0360a6b)
1 parent 10754de commit cac9ffa

File tree

4 files changed

+10
-2
lines changed

4 files changed

+10
-2
lines changed

docs/source-pytorch/api_references.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,8 @@ core
8383
~saving.ModelIO
8484

8585

86+
.. _loggers-api-references:
87+
8688
loggers
8789
-------
8890

docs/source-pytorch/common/remote_fs.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ Working with different filesystems can be accomplished by appending a protocol l
1717
trainer = Trainer(default_root_dir="s3://my_bucket/data/")
1818
trainer.fit(model)
1919
20-
You could pass custom paths to loggers for logging data.
20+
21+
For logging, remote filesystem support depends on the particular logger integration being used. Consult :ref:`the documentation of the individual logger <loggers-api-references>` for more details.
2122

2223
.. code-block:: python
2324

src/pytorch_lightning/loggers/csv_logs.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ class ExperimentWriter(_FabricExperimentWriter):
4242
Currently, supports to log hyperparameters and metrics in YAML and CSV
4343
format, respectively.
4444
45+
This logger supports logging to remote filesystems via ``fsspec``. Make sure you have it installed.
46+
4547
Args:
4648
log_dir: Directory for the experiment logs
4749
"""

src/pytorch_lightning/loggers/tensorboard.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,15 @@
4646

4747
class TensorBoardLogger(Logger, FabricTensorBoardLogger):
4848
r"""
49-
Log to local file system in `TensorBoard <https://www.tensorflow.org/tensorboard>`_ format.
49+
Log to local or remote file system in `TensorBoard <https://www.tensorflow.org/tensorboard>`_ format.
5050
5151
Implemented using :class:`~tensorboardX.SummaryWriter`. Logs are saved to
5252
``os.path.join(save_dir, name, version)``. This is the default logger in Lightning, it comes
5353
preinstalled.
5454
55+
This logger supports logging to remote filesystems via ``fsspec``. Make sure you have it installed
56+
and you don't have tensorflow (otherwise it will use tf.io.gfile instead of fsspec).
57+
5558
Example:
5659
5760
.. testcode::

0 commit comments

Comments
 (0)