Fix Python 3.6 f-string compatibility, and condense documentation for FNO classes
#5
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
All parameters besides n_modes.* args are repeated verbatim in documentation. This has already caused drift in maintaining the docstrings for the class. Remove repeated parameters and let the subclasses refer back up to the superclass' documentation.
|
Closing this in favor of neuraloperator#209 against |
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.
There are still several instances of
f"{x=}"in the repo, which causes issues when trying to import the library in to Python 3.6. Drop the=in these f-string to fix this problem.Additionally, the repeated docstrings between base class
FNOand subclassesFNOndmake maintaining documentation more work than it needs to be. The parameters are used identically in the base- and subclass, and in some cases the subclass documentation is already out of date. Delete the repeated parameter comments in favor of referring users back up to the full documentation ofFNO(tested in a localmakeofsphinx-gallery).Lastly, run
blackon touched files.Previous PR: #4
Reviewer(s): @zongyi-li @JeanKossaifi