-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Fix trainer.fit docstring render bug #21362
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Fix trainer.fit docstring render bug #21362
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests.
Additional details and impacted files@@ Coverage Diff @@
## master #21362 +/- ##
=========================================
- Coverage 87% 79% -8%
=========================================
Files 269 266 -3
Lines 23744 23689 -55
=========================================
- Hits 20572 18671 -1901
- Misses 3172 5018 +1846 |
|
Hi @ritoban23, thanks for choosing to make PyTorch Lightning more awesome. Can you please look at failing doc tests? |
|
I'm wondering why the note is necessary and why it is not the same issue e.g. here:
However, it may would fix the problem and be more concise to just move the "For more.." sentence up, just below the parameters, like it is done in validate, test and predict: pytorch-lightning/src/lightning/pytorch/trainer/trainer.py Lines 663 to 677 in a4315bf
|
What does this PR do?
Fixes a documentation rendering bug in
trainer.fitwhere:rtype: Nonewas incorrectly displayed.The fix wraps the "For more information about multiple dataloaders" text in a proper RST
.. note::directive, ensuring correct Sphinx formatting and preventing spurious:rtype:output.Fixes #21356
Before submitting
PR review
Anyone in the community is welcome to review the PR.
Before you start reviewing, make sure you have read the review guidelines. In short, see the following bullet-list:
Reviewer checklist
📚 Documentation preview 📚: https://pytorch-lightning--21362.org.readthedocs.build/en/21362/