Skip to content

Commit 3cdc147

Browse files
ritoban23bhimrazy
authored andcommitted
Fix trainer.fit docstring render bug (Lightning-AI#21362)
* Fix trainer.fit docstring render bug * retrigger:to check the real isue * add a workaround to fix --------- Co-authored-by: Bhimraj Yadav <[email protected]>
1 parent e872b58 commit 3cdc147

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/lightning/pytorch/trainer/trainer.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -563,14 +563,16 @@ def fit(
563563
recommend using ``weights_only=True``. For more information, please refer to the
564564
`PyTorch Developer Notes on Serialization Semantics <https://docs.pytorch.org/docs/main/notes/serialization.html#id3>`_.
565565
566+
For more information about multiple dataloaders, see this :ref:`section <multiple-dataloaders>`.
567+
568+
:rtype: :py:obj:`None`
569+
566570
Raises:
567571
TypeError:
568572
If ``model`` is not :class:`~lightning.pytorch.core.LightningModule` for torch version less than
569573
2.0.0 and if ``model`` is not :class:`~lightning.pytorch.core.LightningModule` or
570574
:class:`torch._dynamo.OptimizedModule` for torch versions greater than or equal to 2.0.0 .
571575
572-
For more information about multiple dataloaders, see this :ref:`section <multiple-dataloaders>`.
573-
574576
"""
575577
model = _maybe_unwrap_optimized(model)
576578
self.strategy._lightning_module = model

0 commit comments

Comments
 (0)