tensorboardX.SummaryWriter

Author: Borda

docs/source-fabric/conf.py

@@ -293,7 +293,7 @@
     ("py:class", "transformer_engine.*"),
     ("py:class", "bitsandbytes.*"),
     # loggers
-    ('py:class', 'tensorboardX.writer.SummaryWriter'),  # todo: this is unexpected as the imports locally works
+    ('py:class', 'tensorboardX.SummaryWriter'),  # todo: this is unexpected as the imports locally works
 ]
 
 # -- Options for todo extension ----------------------------------------------

docs/source-pytorch/conf.py

@@ -377,7 +377,7 @@ def _load_py_module(name: str, location: str) -> ModuleType:
     # missing in generated API
     ("py:exc", "MisconfigurationException"),
     # TODO: generated list of all existing ATM, need to be fixed
-    ('py:class', 'tensorboardX.writer.SummaryWriter'),
+    ('py:class', 'tensorboardX.SummaryWriter'),
     ("py:class", "AveragedModel"),
     ("py:class", "CometExperiment"),
     ("py:meth", "DataModule.__init__"),

src/lightning/fabric/loggers/tensorboard.py

@@ -43,7 +43,7 @@
 class TensorBoardLogger(Logger):
     r"""Log to local file system in `TensorBoard <https://www.tensorflow.org/tensorboard>`_ format.
 
-    Implemented using :class:`~tensorboardX.writer.SummaryWriter`. Logs are saved to
+    Implemented using :class:`~tensorboardX.SummaryWriter`. Logs are saved to
     ``os.path.join(root_dir, name, version)``. This is the recommended logger in Lightning Fabric.
 
     Args:
@@ -60,7 +60,7 @@ class TensorBoardLogger(Logger):
         sub_dir: Sub-directory to group TensorBoard logs. If a ``sub_dir`` argument is passed
             then logs are saved in ``/root_dir/name/version/sub_dir/``. Defaults to ``None`` in which case
             logs are saved in ``/root_dir/name/version/``.
-        \**kwargs: Additional arguments used by :class:`tensorboardX.writer.SummaryWriter` can be passed as keyword
+        \**kwargs: Additional arguments used by :class:`tensorboardX.SummaryWriter` can be passed as keyword
             arguments in this logger. To automatically flush to disk, `max_queue` sets the size
             of the queue for pending logs before flushing. `flush_secs` determines how many seconds
             elapses before flushing.

src/lightning/pytorch/loggers/tensorboard.py

@@ -39,7 +39,7 @@
 class TensorBoardLogger(Logger, FabricTensorBoardLogger):
     r"""Log to local or remote file system in `TensorBoard <https://www.tensorflow.org/tensorboard>`_ format.
 
-    Implemented using :class:`~tensorboardX.writer.SummaryWriter`. Logs are saved to
+    Implemented using :class:`~tensorboardX.SummaryWriter`. Logs are saved to
     ``os.path.join(save_dir, name, version)``. This is the default logger in Lightning, it comes
     preinstalled.
 
@@ -74,7 +74,7 @@ class TensorBoardLogger(Logger, FabricTensorBoardLogger):
         sub_dir: Sub-directory to group TensorBoard logs. If a sub_dir argument is passed
             then logs are saved in ``/save_dir/name/version/sub_dir/``. Defaults to ``None`` in which
             logs are saved in ``/save_dir/name/version/``.
-        \**kwargs: Additional arguments used by :class:`tensorboardX.writer.SummaryWriter` can be passed as keyword
+        \**kwargs: Additional arguments used by :class:`tensorboardX.SummaryWriter` can be passed as keyword
             arguments in this logger. To automatically flush to disk, `max_queue` sets the size
             of the queue for pending logs before flushing. `flush_secs` determines how many seconds
             elapses before flushing.