Refactor/move args to kwargs #833
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SkafteNicki
added
documentation
SkafteNicki
requested review from
edenlightning,
Borda,
justusschock,
tchaton,
ananyahjha93,
ethanwharris and
SeanNaren
as code owners
Co-authored-by: Justus Schock <12886177+justusschock@users.noreply.github.com>
Borda
reviewed
Feb 10, 2022
SkafteNicki
commented
Feb 11, 2022
Borda
reviewed
Feb 16, 2022
Sorry, my intension was that all should just be |
Borda
approved these changes
Feb 16, 2022
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
…orchLightning/metrics into refactor/move_args_to_kwargs
for more information, see https://pre-commit.ci
justusschock
approved these changes
Feb 21, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What does this PR do?
Move the three common arguments
dist_sync_on_step,process_groupanddist_sync_fnto akwargsargument.The arguments are only meant for real power-users and therefore it does not make sense that they need to be directly available as arguments. This solution is complete backwards compatible and it is therefore more a question about getting more clean documentation as we do not need to repeat theses arguments everywhere.
Currently only updated one metric so we can agree on the refactor before applying it to all other metrics.
Before submitting
PR review
Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in Github issues there's a high chance it will not be merged.
Did you have fun?
Make sure you had fun coding 🙃