Do not warn when the name key is used in the lr_scheduler dict

[carmocca]

What does this PR do?

Fixes bug reported in slack cc @pvnieo

I followed the example provided here: https://pytorch-lightning.readthedocs.io/en/latest/generated/pytorch_lightning.callbacks.LearningRateMonitor.html?highlight=LearningRateMonitor

def configure_optimizer(self):
    optimizer = torch.optim.Adam(...)
    lr_scheduler = {'scheduler': torch.optim.lr_scheduler.LambdaLR(optimizer, ...)
                    'name': 'my_logging_name'}
    return [optimizer], [lr_scheduler]

but I'm getting the following warning:

python3.8/site-packages/pytorch_lightning/utilities/distributed.py:45: RuntimeWarning: Found unsupported keys in the lr scheduler dict: ['name']

Before submitting

• Was this discussed/approved via a Github issue? (no need for typos and docs improvements)
• 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? Otherwise, we ask you to create a separate PR for every change.
• [n/a] Did you make sure to update the documentation with your changes?
• Did you write any new necessary tests?
• Did you verify new and existing tests pass locally with your changes?
• If you made a notable change (that affects users), did you update the CHANGELOG?

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; Bugfixes should be including in bug-fix release milestones (m.f.X) and features should be included in (m.X.b) releases.

[codecov]

Codecov Report

Merging #5057 (b4af7b6) into master (16feb51) will increase coverage by 0%.
The diff coverage is 100%.

@@          Coverage Diff           @@
##           master   #5057   +/-   ##
======================================
  Coverage      93%     93%           
======================================
  Files         134     134           
  Lines        9907    9907           
======================================
+ Hits         9205    9206    +1     
+ Misses        702     701    -1     

[Borda]

can you clarify what is the fix? :]

[carmocca]

can you clarify what is the fix? :]

These are the lines which produce the warning:

https://github.com/PyTorchLightning/pytorch-lightning/blob/2c3d43dcb503cf2f8fc8a4b30d4ab6f986f348f1/pytorch_lightning/trainer/optimizers.py#L106-L108

so to avoid it, we need to include name in the default_config dict which is used for user input validation and for the parsing of the scheduler structure.

[rohitgr7]

what's this name used for BTW?

[carmocca]

what's this name used for BTW?

To have custom names in the LearningRateMonitor. So my_custom_name instead of lr-Adam (default if using Adam)

[rohitgr7]

add this to docs too? https://pytorch-lightning.readthedocs.io/en/latest/lightning_module.html#configure-optimizers

[rohitgr7]

LGTM

[tchaton]

LGTM !