Physics latent dynamics fd documentation #19
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
added 22 commits
October 28, 2024 13:56
I also removed the multheadedattention activation type (plus the associated apply_attention function) because they did not make sense in this class. I have now documented the MLP class, but need to add documentation to the autoencoder class.
I added comments + doc strings to the Autoencoder class.
gplasdi had an instance of np.Inf (which is depricated). I also fixed a typo in latent_spaces.py
I also reformatted enums.py
I still need to document the actual gplasdi class, but have done everything else in the file. I also made small tweaks to comments in other files.
I think I will move onto the LatentDynamics/Physics files before moving onto workflow.py
I forgot to add the "name" argument to the arguments list in the doc-string for the "InputParser" class. I added a breif description of what "name" does.
This one was... hard. Wow this code was intracate and difficult to parse. I think I did it, however. I think I documented the Stencil class. I did not document specific sub-classes.. I think the docstring in Stencil should make it clear what the subclasses do. I probably need to give these comments another look... but this took me like 5 hours. I am done for now.
I qucikly realized, however, that I could not document these files without understanding fd.py... so I did that one first (see the previous commit). I will hopefully finish the LatentDynamics stuff in the next commit or two.
I meant to add these into the previous commit but forgot to save the file. Oops. Anyway, with these additions, the latent_dynamics files are now fully documented.
This should have gone in a few commits ago but did not. I only changed a few lines, nothing major.
I haven't totaly finished, but I added documentation to most of the base Physics class + the Burgers1D subclass. I still do not know what the Offline subclass thing does, and haven't looked too much into how we compute the Burgers' residual... but I think I got most of the documentation in this commit. I also made a minor tweak to latent_space.py... the bulk of the changes in this commit are in the physics sub-dictionary, however.
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.
Added documentation to Physics + Latent Dynamics + FD. 5 files have changed: fd.py, both files in ./Physics, and both files in ./Latent_Dynamics. The code is the same, it just now has proper documentation.
I meant to make this pull request this last week but forgot.