File tree Expand file tree Collapse file tree 1 file changed +8
-2
lines changed
src/lightning/pytorch/loggers Expand file tree Collapse file tree 1 file changed +8
-2
lines changed Original file line number Diff line number Diff 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):
You can’t perform that action at this time.
0 commit comments