Update references to DeepXDE in about code and README
#20
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
Reviewer's Guide by SourceryThis pull request rewrites the Class diagram showing the main components affected by the rewriteclassDiagram
class Problem {
+call_bc_errors()
}
class Trainer {
+train()
+evaluate()
}
class FunctionSpace {
+PowerSeries
}
class Geometry {
<<interface>>
}
class ICBC {
<<interface>>
}
class NeuralNetwork {
<<interface>>
}
Problem --> Trainer
Problem --> Geometry
Problem --> ICBC
Problem --> NeuralNetwork
Problem --> FunctionSpace
note for Problem "Rewritten from DeepXDE"
note for Trainer "Enhanced with BDP ecosystem"
File-Level Changes
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @chaoming0625 - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider standardizing the format of DeepXDE attribution comments across files - some have extra blank lines while others don't
- In setup.py, either use dynamic versioning or hardcoded version string, but not both uncommented options
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| @@ -32,8 +32,8 @@ | |||
| if len(sys.argv) > 2 and sys.argv[2] == '--python-tag=py3': | |||
| version = version | |||
| else: | |||
| # version += '.post{}'.format(time.strftime("%Y%m%d", time.localtime())) | |||
| version += 'post20250106' | |||
| version += '.post{}'.format(time.strftime("%Y%m%d", time.localtime())) | |||
There was a problem hiding this comment.
suggestion (code-quality): Replace call to format with f-string (use-fstring-for-formatting)
Suggested change
| version += '.post{}'.format(time.strftime("%Y%m%d", time.localtime())) | |
| version += f'.post{time.strftime("%Y%m%d", time.localtime())}' |
Open
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.
This pull request includes several changes to the
PINNxlibrary, primarily focusing on rewriting the codebase to align with the originalDeepXDElibrary while incorporating the enhancements from the Brain Dynamics Programming (BDP) ecosystem. The most important changes include updates to documentation, file rewrites, and licensing modifications.Documentation updates:
README.md: Updated the description to clarify thatPINNxis a rewrite ofDeepXDEand enhanced by the BDP ecosystem.docs/index.rst: Revised the introduction to specify thatPINNxis rewritten according toDeepXDEand enhanced by the BDP ecosystem.File rewrites:
pinnx/_trainer.py,pinnx/callbacks.py,pinnx/fnspace.py,pinnx/metrics.py,pinnx/nn/deeponet.py,pinnx/nn/deeponet_strategy.py: Added comments indicating that these files are rewrites of the original files inDeepXDE. [1] [2] [3] [4] [5] [6]Licensing modifications:
pinnx/geometry/base.py,pinnx/geometry/geometry_1d.py,pinnx/geometry/geometry_2d.py,pinnx/geometry/geometry_3d.py,pinnx/geometry/geometry_nd.py,pinnx/geometry/pointcloud.py,pinnx/geometry/timedomain.py,pinnx/icbc/base.py,pinnx/icbc/boundary_conditions.py,pinnx/icbc/initial_conditions.py,pinnx/nn/base.py. These files now include comments indicating they are rewrites of the original files inDeepXDE. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11]Other changes:
pinnx/nn/__init__.py: Reordered imports to improve code organization.Summary by Sourcery
Refactor the PINNx library to align with the original DeepXDE codebase and incorporate enhancements from the BDP ecosystem. Update documentation to reflect these changes.
Enhancements:
Documentation:
Tests: