docstring for FNOGNO #202
Merged
docstring for FNOGNO #202
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
|
Thanks @dhpitt, this is great! Can you just use numpy style docstrings, see e.g. https://github.com/neuraloperator/neuraloperator/blob/main/neuralop/models/fno.py. |
neuralop/models/fnogno.py
Outdated
| ---------- | ||
| in_channels : _type_ | ||
| number of input channels | ||
| out_channels : _type_ |
There was a problem hiding this comment.
Suggested change
| out_channels : _type_ | |
| out_channels : int |
neuralop/models/fnogno.py
Outdated
|
|
||
| Parameters | ||
| ---------- | ||
| in_channels : _type_ |
There was a problem hiding this comment.
Suggested change
| in_channels : _type_ | |
| in_channels : int |
neuralop/models/fnogno.py
Outdated
| number of hidden channels in embedding block of FNO. Defaults to 256. | ||
| gno_coord_dim : int, optional | ||
| dimension of GNO input data. Defaults to 3. | ||
| gno_coord_embed_dim : _type_, optional |
neuralop/models/fnogno.py
Outdated
| options: 'linear_kernelonly' | ||
| 'linear' | ||
| 'nonlinear_kernelonly' | ||
| 'nonlinear' |
There was a problem hiding this comment.
Would be good to have a small explanation of each value here
neuralop/models/fnogno.py
Outdated
| How to perform domain padding. Defaults to 'one-sided'. | ||
| fno_fft_norm : str, optional | ||
| normalization param of torch.fft to use in FNO. Defaults to 'forward' | ||
| fno_SpectralConv : nn.Module, optional |
There was a problem hiding this comment.
I like to have directly default is ... instead of optional since having a default value makes it optional anyway.
|
Thanks @dhpitt! Merging. |
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.
FNOGNO needs a docstring! More documentation PRs to come.