From e780671fd06bb7a05685308f0fa615b9e018d585 Mon Sep 17 00:00:00 2001 From: giovanni Date: Fri, 14 Mar 2025 00:19:18 +0100 Subject: [PATCH] black formatter --- pina/domain/ellipsoid.py | 2 +- pina/equation/equation.py | 2 +- pina/equation/equation_interface.py | 2 +- pina/problem/zoo/allen_cahn.py | 2 +- pina/problem/zoo/helmholtz.py | 2 +- pina/solver/garom.py | 4 ++-- pina/solver/solver.py | 3 ++- pina/trainer.py | 2 +- 8 files changed, 10 insertions(+), 9 deletions(-) diff --git a/pina/domain/ellipsoid.py b/pina/domain/ellipsoid.py index 5411e46..4b75be8 100644 --- a/pina/domain/ellipsoid.py +++ b/pina/domain/ellipsoid.py @@ -27,7 +27,7 @@ class EllipsoidDomain(DomainInterface): Sampling for dimensions greater or equal to 10 could result in a shrinkage of the ellipsoid, which degrades the quality of the samples. For dimensions higher than 10, see the following reference. - + .. seealso:: **Original reference**: Dezert, Jean, and Musso, Christian. *An efficient method for generating points uniformly distributed diff --git a/pina/equation/equation.py b/pina/equation/equation.py index fef4642..60b538e 100644 --- a/pina/equation/equation.py +++ b/pina/equation/equation.py @@ -36,7 +36,7 @@ class Equation(EquationInterface): :class:`torch.nn.Module` instance. :param dict params_: Dictionary of unknown parameters, associated with a :class:`~pina.problem.inverse_problem.InverseProblem` instance. - If the equation is not related to a + If the equation is not related to a :class:`~pina.problem.inverse_problem.InverseProblem` instance, the parameters must be initialized to ``None``. Default is ``None``. :return: The computed residual of the equation. diff --git a/pina/equation/equation_interface.py b/pina/equation/equation_interface.py index 66b210c..bb0b9b5 100644 --- a/pina/equation/equation_interface.py +++ b/pina/equation/equation_interface.py @@ -10,7 +10,7 @@ class EquationInterface(metaclass=ABCMeta): Equations in PINA simplify the training process. When defining a problem, each equation passed to a :class:`~pina.condition.condition.Condition` object must be either an :class:`~pina.equation.equation.Equation` or a - :class:`~pina.equation.system_equation.SystemEquation` instance. + :class:`~pina.equation.system_equation.SystemEquation` instance. An :class:`~pina.equation.equation.Equation` is a wrapper for a callable function, while :class:`~pina.equation.system_equation.SystemEquation` diff --git a/pina/problem/zoo/allen_cahn.py b/pina/problem/zoo/allen_cahn.py index 7fae38f..4e05eaf 100644 --- a/pina/problem/zoo/allen_cahn.py +++ b/pina/problem/zoo/allen_cahn.py @@ -49,7 +49,7 @@ class AllenCahnProblem(TimeDependentProblem, SpatialProblem): Computer Methods in Applied Mechanics and Engineering 421 (2024): 116805 DOI: `10.1016/ j.cma.2024.116805 `_. - + :Example: >>> problem = AllenCahnProblem() """ diff --git a/pina/problem/zoo/helmholtz.py b/pina/problem/zoo/helmholtz.py index 85ec73a..34d3893 100644 --- a/pina/problem/zoo/helmholtz.py +++ b/pina/problem/zoo/helmholtz.py @@ -53,7 +53,7 @@ class HelmholtzProblem(SpatialProblem): **Original reference**: Si, Chenhao, et al. *Complex Physics-Informed Neural Network.* arXiv preprint arXiv:2502.04917 (2025). DOI: `arXiv:2502.04917 `_. - + :Example: >>> problem = HelmholtzProblem() """ diff --git a/pina/solver/garom.py b/pina/solver/garom.py index 8b633f7..2f763a7 100644 --- a/pina/solver/garom.py +++ b/pina/solver/garom.py @@ -40,7 +40,7 @@ class GAROM(MultiSolverInterface): ): """ Initialization of the :class:`GAROM` class. - + :param AbstractProblem problem: The formulation of the problem. :param torch.nn.Module generator: The generator model. :param torch.nn.Module discriminator: The discriminator model. @@ -50,7 +50,7 @@ class GAROM(MultiSolverInterface): :param Optimizer optimizer_generator: The optimizer for the generator. If `None`, the :class:`torch.optim.Adam` optimizer is used. Default is ``None``. - :param Optimizer optimizer_discriminator: The optimizer for the + :param Optimizer optimizer_discriminator: The optimizer for the discriminator. If `None`, the :class:`torch.optim.Adam` optimizer is used. Default is ``None``. :param Scheduler scheduler_generator: The learning rate scheduler for diff --git a/pina/solver/solver.py b/pina/solver/solver.py index f533d5e..2a173b3 100644 --- a/pina/solver/solver.py +++ b/pina/solver/solver.py @@ -63,7 +63,7 @@ class SolverInterface(lightning.pytorch.LightningModule, metaclass=ABCMeta): def _check_solver_consistency(self, problem): """ Check the consistency of the solver with the problem formulation. - + :param AbstractProblem problem: The problem to be solved. """ for condition in problem.conditions.values(): @@ -290,6 +290,7 @@ class SingleSolverInterface(SolverInterface, metaclass=ABCMeta): """ Base class for PINA solvers using a single :class:`torch.nn.Module`. """ + def __init__( self, problem, diff --git a/pina/trainer.py b/pina/trainer.py index 0d82bdd..0a84f56 100644 --- a/pina/trainer.py +++ b/pina/trainer.py @@ -34,7 +34,7 @@ class Trainer(lightning.pytorch.Trainer): """ Initialization of the :class:`Trainer` class. - :param SolverInterface solver: A + :param SolverInterface solver: A :class:`~pina.solver.solver.SolverInterface` solver used to solve a :class:`~pina.problem.abstract_problem.AbstractProblem`. :param int batch_size: The number of samples per batch to load.