refactor: adopt _src pattern and migrate core components
#763
+3,230
−3,025
Conversation
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
- Restructured the repository to separate internal logic (`pina/_src`) from the public API. - Migrated central components (Graph, LabelTensor, Operator, Trainer) into `pina/_src/core/` for better organization. - Updated all subpackage `__init__.py` files to expose a clean, flat import surface for users. - Standardized module docstrings across Solvers, Models, Equations, Domains, and Callbacks to improve documentation quality. - Optimized internal dictionary handling in tensor storage functions.
Collaborator
|
Hi @adendek ! Thanks for the PR. At the moment, all tests are failing, probably due to an import error. Can you check it? Also, the |
dario-coscia
requested review from
dario-coscia
and removed request for
a team
Author
|
I'fixed the UT and formatting. I guess they should be fine now. I'll need a little bit more time to update the docs. |
This branch was created to be able to run all tests using on my fork.
Author
|
Hello @dario-coscia, I have successfully refactored the Sphinx documentation to align with the new As shown in the latest CI run executed on my fork, the 
So the PR is ready to be reviewed. |
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.
Description
This PR resolves #756 by implementing a major structural refactor. Following the design patterns of modern scientific libraries like JAX and Optax, it introduces a
pina/_srcdirectory to house internal logic while exposing a clean, flat public API.API Stability Notice
The public interface remains unchanged. Existing user scripts and external calls to PINA classes will continue to work as expected. This refactor purely reorganizes the internal source code and "hoists" definitions to their respective package levels for cleaner access.
Key Changes
pina._src.core/module.Checklist