Repository navigation
fix(aggregation): move class docstrings above required deps in CAGradWeighting and _NashMTLWeighting - #825
Closed
adityawaghamare wants to merge 1 commit into
Closed
fix(aggregation): move class docstrings above required deps in CAGradWeighting and _NashMTLWeighting#825adityawaghamare wants to merge 1 commit into
adityawaghamare wants to merge 1 commit into
Conversation
…Weighting and _NashMTLWeighting - Closes SimplexLab#807 - Files: src/torchjd/aggregation/_cagrad.py, src/torchjd/aggregation/_nash_mtl.py Signed-off-by: Aditya Waghamare <adityawaghmare8694@gmail.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Moved class docstrings above
_REQUIRED_DEPSand_INSTALL_HINTinCAGradWeightingand_NashMTLWeightingso that Python correctly assigns them as class docstrings (__doc__) rather than expression statements.Changes
src/torchjd/aggregation/_cagrad.pyto place the docstring ofCAGradWeightingbefore_REQUIRED_DEPSand_INSTALL_HINT.src/torchjd/aggregation/_nash_mtl.pyto place the docstring of_NashMTLWeightingbefore_REQUIRED_DEPSand_INSTALL_HINT.Verification
CAGradWeighting.__doc__and_NashMTLWeighting.__doc__are correctly populated and no longerNone.Closes #807