Fixed typo in docs for optimizer_idx #5310
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There were four instances where `optimizer_idx` was the argument for **`optimizer_step()`** under [Step optimizers at arbitrary intervals][#link-to-docs]. However, instead of using it what was being used inside (erroneously) was `optimizer_i`. [#link-to-docs]: https://pytorch-lightning.readthedocs.io/en/latest/optimizers.html#step-optimizers-at-arbitrary-intervals
Fixed typo in docs for optimizer_idx
sugatoray
requested review from
awaelchli,
Borda,
edenlightning and
tchaton
as code owners
Codecov Report
@@ Coverage Diff @@
## master #5310 +/- ##
======================================
Coverage 93% 93%
======================================
Files 134 134
Lines 9950 9950
======================================
Hits 9261 9261
Misses 689 689 |
Borda
approved these changes
Dec 30, 2020
SkafteNicki
approved these changes
Dec 30, 2020
ydcjeff
approved these changes
Dec 31, 2020
s-rog
approved these changes
Dec 31, 2020
Borda
pushed a commit
that referenced
this pull request
Jan 6, 2021
There were four instances where `optimizer_idx` was the argument for **`optimizer_step()`** under [Step optimizers at arbitrary intervals][#link-to-docs]. However, instead of using it what was being used inside (erroneously) was `optimizer_i`. [#link-to-docs]: https://pytorch-lightning.readthedocs.io/en/latest/optimizers.html#step-optimizers-at-arbitrary-intervals (cherry picked from commit dd98a60)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There were four instances where
optimizer_idxwas the argument foroptimizer_step()under Step optimizers at arbitrary intervals. However, instead of using it what was being used inside (erroneously) wasoptimizer_i.What does this PR do?
This fixes some typos as explained above and in issue #5309.
Before submitting
This was discussed in slack under channel
#documentation. Link to discussion ⭐NA: typo correction in docsNA: typo correction in docsPR review
Anyone in the community is free to review the PR once the tests have passed.
Before you start reviewing make sure you have read Review guidelines. In short, see the following bullet-list:
Did you have fun?
Make sure you had fun coding 🙃