Skip to content

Conversation

@theblackfly
Copy link
Contributor

In the first code block in the optimizers doc training_step(...) should take self as the first argument. It's missing at the moment. It's a simple but necessary fix.

What does this PR do?

Not discussed in Github issues as far as I'm aware. It's a simple typo-fix in one of the code-snippets in the documentation.

Before submitting

  • [n/a] Was this discussed/approved via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • [n/a] Did you make sure to update the documentation with your changes? (if necessary)
  • [n/a] Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • [n/a] Did you update the CHANGELOG? (not for typos, docs, test updates, or internal minor changes/refactorings)

PR 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:

  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

`training_step(...)` should take `self` as the first argument. It's a simple but necessary fix.
@Borda Borda added the docs Documentation related label May 18, 2021
@Borda Borda enabled auto-merge (squash) May 18, 2021 18:59
@codecov
Copy link

codecov bot commented May 18, 2021

Codecov Report

Merging #7598 (53d0abc) into master (20f6337) will decrease coverage by 5%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master   #7598    +/-   ##
=======================================
- Coverage      92%     88%    -5%     
=======================================
  Files         197     197            
  Lines       12878   12878            
=======================================
- Hits        11899   11312   -587     
- Misses        979    1566   +587     

@awaelchli awaelchli added the ready PRs ready to be merged label May 19, 2021
@Borda Borda merged commit 922c0a6 into Lightning-AI:master May 19, 2021
@Borda Borda mentioned this pull request May 25, 2021
@awaelchli awaelchli added this to the v1.4 milestone May 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation related ready PRs ready to be merged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants