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.

Sign up for GitHub

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

Jump to bottom

Use a dataclass as the scheduler config #11443

Merged
merged 21 commits into from
Jan 18, 2022
Merged

Use a dataclass as the scheduler config #11443

merged 21 commits into from
Jan 18, 2022

Conversation

carmocca
Copy link
Contributor

@carmocca carmocca commented Jan 12, 2022 •
edited
Loading

What does this PR do?

Closes #11211
Part of #7037

  • Deprecates trainer.lr_schedulrs which still needs to return a dict for compatibility.
  • Adds trainer.lr_scheduler_configs which does return a list of LRSchedulerConfig dataclasses.

If anybody has a better name than lr_scheduler_config, let me know.

Follow-ups:

Resolve:

# TODO: rename to `lr_scheduler_configs` to match the property in the `Trainer`

Does your PR introduce any breaking changes? If yes, please list them.

None

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)
  • [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?
  • Did you list all the breaking changes introduced by this pull request?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or internal minor changes/refactorings)

PR review

  • 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

cc @Borda @justusschock @awaelchli @akihironitta @rohitgr7 @tchaton

@carmocca carmocca self-assigned this Jan 12, 2022
@carmocca carmocca added deprecation Includes a deprecation lr scheduler labels Jan 12, 2022
@carmocca carmocca added this to the 1.6 milestone Jan 12, 2022
@carmocca carmocca changed the title [WIP] Use a dataclass as the scheduler config Use a dataclass as the scheduler config Jan 12, 2022
carmocca
carmocca commented Jan 12, 2022
View reviewed changes
pytorch_lightning/strategies/strategy.py Outdated
@@ -52,6 +52,7 @@ def __init__(
self.checkpoint_io = checkpoint_io
self.precision_plugin = precision_plugin
self.optimizers: List[Optimizer] = []
# FIXME: rename to _config?
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's no need to rename this in this PR, but do we want to?

Copy link
Contributor

@akihironitta akihironitta Jan 13, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 for renaming it to lr_scheduler_configs. Should we have consistent variable names in the codebase, too? because currently, variable name lr_scheduler(s) is used for both configs and actual lr schedulers.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. Would you like to help with that after this PR is merged?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@akihironitta You are good to start this now. No need to deprecate because strategies are currently experimental so should be a simple rename

@carmocca carmocca marked this pull request as ready for review January 12, 2022 21:57
akihironitta
akihironitta approved these changes Jan 13, 2022
View reviewed changes
pytorch_lightning/strategies/strategy.py Outdated
@@ -52,6 +52,7 @@ def __init__(
self.checkpoint_io = checkpoint_io
self.precision_plugin = precision_plugin
self.optimizers: List[Optimizer] = []
# FIXME: rename to _config?
Copy link
Contributor

@akihironitta akihironitta Jan 13, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 for renaming it to lr_scheduler_configs. Should we have consistent variable names in the codebase, too? because currently, variable name lr_scheduler(s) is used for both configs and actual lr schedulers.

awaelchli
awaelchli approved these changes Jan 13, 2022
View reviewed changes
pytorch_lightning/core/optimizer.py Show resolved Hide resolved
pytorch_lightning/strategies/deepspeed.py Show resolved Hide resolved
pytorch_lightning/strategies/sharded_spawn.py Outdated Show resolved Hide resolved
pytorch_lightning/trainer/trainer.py Show resolved Hide resolved
@mergify mergify bot added the ready PRs ready to be merged label Jan 13, 2022
@mergify mergify bot removed the has conflicts label Jan 18, 2022
@carmocca carmocca enabled auto-merge (squash) January 18, 2022 15:28
rohitgr7
rohitgr7 approved these changes Jan 18, 2022
View reviewed changes
Copy link
Contributor

@rohitgr7 rohitgr7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!
small comments

pytorch_lightning/core/optimizer.py Outdated Show resolved Hide resolved
pytorch_lightning/core/lightning.py Outdated Show resolved Hide resolved
pytorch_lightning/trainer/trainer.py Show resolved Hide resolved
@carmocca carmocca merged commit 62818db into master Jan 18, 2022
@carmocca carmocca deleted the refactor/lr-sch-config-dataclass branch January 18, 2022 19:23
@akihironitta akihironitta mentioned this pull request Jan 20, 2022
Merged
9 tasks
@Borda Borda mentioned this pull request Mar 9, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@akihironitta akihironitta akihironitta approved these changes

@awaelchli awaelchli awaelchli approved these changes

@rohitgr7 rohitgr7 rohitgr7 approved these changes

@Borda Borda Borda approved these changes

@justusschock justusschock Awaiting requested review from justusschock justusschock is a code owner

@kaushikb11 kaushikb11 Awaiting requested review from kaushikb11

@SeanNaren SeanNaren Awaiting requested review from SeanNaren

@SkafteNicki SkafteNicki Awaiting requested review from SkafteNicki

@tchaton tchaton Awaiting requested review from tchaton tchaton is a code owner

@williamFalcon williamFalcon Awaiting requested review from williamFalcon

Assignees

@carmocca carmocca

Labels
code quality deprecation Includes a deprecation lr scheduler ready PRs ready to be merged refactor
Projects
None yet
Milestone
pl:1.6
Development

Successfully merging this pull request may close these issues.
5 participants
@carmocca @awaelchli @Borda @akihironitta @rohitgr7