Skip to content
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

Update docs for multiple optimizers in 2.0 #16588

Merged
merged 12 commits into from
Feb 1, 2023

Conversation

awaelchli
Copy link
Contributor

@awaelchli awaelchli commented Feb 1, 2023

What does this PR do?

For a summary of changes to how multiple optimizers are handled in the new version, see #16539.
This PR brings the necessary documentation changes.

Before submitting

  • 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?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • 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

Did you have fun?

I made sure I had fun coding 🙃

cc @Borda

@awaelchli awaelchli added docs Documentation related optimization labels Feb 1, 2023
@github-actions github-actions bot added the pl Generic label for PyTorch Lightning package label Feb 1, 2023
@awaelchli awaelchli added this to the 2.0 milestone Feb 1, 2023
@awaelchli awaelchli self-assigned this Feb 1, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Feb 1, 2023

⚡ Required checks status: All passing 🟢

Groups summary

🟢 pytorch_lightning: Docs
Check ID Status
make-doctest (pytorch) success
make-html (pytorch) success

These checks are required after the changes to docs/source-pytorch/common/lightning_module.rst, docs/source-pytorch/common/optimization.rst, docs/source-pytorch/guides/speed.rst, docs/source-pytorch/model/build_model_advanced.rst, docs/source-pytorch/model/manual_optimization.rst, docs/source-pytorch/starter/introduction.rst.


Thank you for your contribution! 💜

Note
This comment is automatically generated and updates for 60 minutes every 180 seconds. If you have any other questions, contact carmocca for help.

@mergify mergify bot added the ready PRs ready to be merged label Feb 1, 2023
@awaelchli awaelchli enabled auto-merge (squash) February 1, 2023 17:05
@awaelchli awaelchli merged commit 01b152f into master Feb 1, 2023
@awaelchli awaelchli deleted the removal/optimizer-loop-docs branch February 1, 2023 17:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related optimization pl Generic label for PyTorch Lightning package ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants