[Not finished] Allow customized parameter grouping for automatic optimzier configuration. #20742
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.
Make a minor change during automatic optimizer configuration
E.g.
If one want to add weight decay to
weight
groups only (L2 regularization), he/she can usually use named_parameters to iterate over the model parameter to determine if one parameter should be put into theweight
ed group, or remain unregulated. However, this seems impossible when using CLI for automatic configuration. Although one can still write theconfigure_optimizers
him/herself, but I think making this minor change would give users a faster path to do such things without creating a bunch of codes.What does this PR do?
As shown in the commit message, this PR changes the src/lightning/pytorch/cli.py, adding a new separate private object method,
LightningCLI._get_model_parameters()
. The return of this method is exactlyself.model.parameters()
. And during the automatic optimizer configuration, instead of getting model parameters directly, CLI object will use this method to obtain the model parameters.The default behavior is just as the original: get model parameters directly.
However, if one would like to create an optimizer receiving named_parameters (e.g. giving learning rate or L2 factor to different parameter groups), it could customize its own CLI class, just overriding this method, and write his own optimizer. At the same time, it does not need to write a bunch of codes in
configure_optimizers
of the LightningModule, nor caring about parameter passing in.And for users who do not rely on this functionality, the default behavior remains unchanged.
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--20742.org.readthedocs.build/en/20742/