Skip to content

Commit 100fddf

Browse files
committed
refactor: adopt _src pattern and migrate core components
- 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.
1 parent f12173e commit 100fddf

158 files changed

Lines changed: 1743 additions & 1666 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

pina/__init__.py

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,24 @@
1-
"""Module for the Pina library."""
1+
"""
2+
PINA: Physics-Informed Neural Analysis.
3+
4+
A specialized framework for Scientific Machine Learning (SciML), providing
5+
tools for Physics-Informed Neural Networks (PINNs), Neural Operators,
6+
and data-driven physical modeling.
7+
"""
28

39
__all__ = [
4-
"Trainer",
510
"LabelTensor",
11+
"Trainer",
612
"Condition",
713
"PinaDataModule",
814
"Graph",
915
"SolverInterface",
1016
"MultiSolverInterface",
1117
]
1218

13-
from .label_tensor import LabelTensor
14-
from .graph import Graph
15-
from .solver import SolverInterface, MultiSolverInterface
16-
from .trainer import Trainer
17-
from .condition.condition import Condition
18-
from .data import PinaDataModule
19+
from pina._src.core.label_tensor import LabelTensor
20+
from pina._src.core.graph import Graph
21+
from pina._src.solver.solver import SolverInterface, MultiSolverInterface
22+
from pina._src.core.trainer import Trainer
23+
from pina._src.condition.condition import Condition
24+
from pina._src.data.data_module import PinaDataModule

pina/_src/__init__.py

Whitespace-only changes.

pina/_src/adaptive_function/__init__.py

Whitespace-only changes.

pina/adaptive_function/adaptive_function.py renamed to pina/_src/adaptive_function/adaptive_function.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
"""Module for the Adaptive Functions."""
22

33
import torch
4-
from ..utils import check_consistency
5-
from .adaptive_function_interface import AdaptiveActivationFunctionInterface
4+
from pina._src.core.utils import check_consistency
5+
from pina._src.adaptive_function.adaptive_function_interface import AdaptiveActivationFunctionInterface
66

77

88
class AdaptiveReLU(AdaptiveActivationFunctionInterface):

pina/adaptive_function/adaptive_function_interface.py renamed to pina/_src/adaptive_function/adaptive_function_interface.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
from abc import ABCMeta
44
import torch
5-
from ..utils import check_consistency, is_function
5+
from pina._src.core.utils import check_consistency, is_function
66

77

88
class AdaptiveActivationFunctionInterface(torch.nn.Module, metaclass=ABCMeta):

pina/_src/callback/__init__.py

Whitespace-only changes.

pina/_src/callback/optim/__init__.py

Whitespace-only changes.

pina/callback/optim/switch_optimizer.py renamed to pina/_src/callback/optim/switch_optimizer.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
"""Module for the SwitchOptimizer callback."""
22

33
from lightning.pytorch.callbacks import Callback
4-
from ...optim import TorchOptimizer
5-
from ...utils import check_consistency
4+
from pina._src.optim.torch_optimizer import TorchOptimizer
5+
from pina._src.core.utils import check_consistency
66

77

88
class SwitchOptimizer(Callback):

pina/callback/optim/switch_scheduler.py renamed to pina/_src/callback/optim/switch_scheduler.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
"""Module for the SwitchScheduler callback."""
22

33
from lightning.pytorch.callbacks import Callback
4-
from ...optim import TorchScheduler
5-
from ...utils import check_consistency, check_positive_integer
4+
from pina._src.optim.torch_scheduler import TorchScheduler
5+
from pina._src.core.utils import check_consistency, check_positive_integer
66

77

88
class SwitchScheduler(Callback):

pina/_src/callback/processing/__init__.py

Whitespace-only changes.

0 commit comments

Comments
 (0)