Skip to content

Commit f7fe54b

Browse files
committed
try fixing doc build
1 parent f36f35b commit f7fe54b

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

src/lightning/pytorch/loggers/tensorboard.py

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -274,11 +274,17 @@ def _get_next_version(self) -> int:
274274
@override
275275
@rank_zero_experiment
276276
def experiment(self) -> "SummaryWriter":
277-
"""Returns the underlying TensorBoard summary writer object. Allows you to use TensorBoard logging features
278-
directly in your :class:`~lightning.pytorch.core.LightningModule` or anywhere else in your code with:
277+
"""Returns the underlying TensorBoard summary writer object.
278+
279+
Allows you to use TensorBoard logging features directly in your
280+
:class:`~lightning.pytorch.core.LightningModule` or anywhere else in your code with:
279281
280282
`logger.experiment.some_tensorboard_function()`
281283
284+
Returns:
285+
The :class:`torch.utils.tensorboard.SummaryWriter` or :class:`tensorboardX.SummaryWriter`
286+
depending on which is available.
287+
282288
Example::
283289
284290
class LitModel(LightningModule):

0 commit comments

Comments
 (0)