fix rendering part 1

This commit is contained in:
giovanni
2025-03-13 22:31:26 +01:00
committed by Nicola Demo
parent 5d908a291d
commit e0ad4dc8a0
15 changed files with 89 additions and 63 deletions

View File

@@ -6,8 +6,9 @@ from .equation_interface import EquationInterface
class Equation(EquationInterface):
"""
Implementation of the Equation class. Every ``equation`` passed to a
:class:`~pina.condition.Condition` object must be either a :class:`Equation`
or a :class:`~pina.equation.SystemEquation` instance.
:class:`~pina.condition.condition.Condition` object must be either an
instance of :class:`Equation` or
:class:`~pina.equation.system_equation.SystemEquation`.
"""
def __init__(self, equation):
@@ -32,10 +33,11 @@ class Equation(EquationInterface):
:param LabelTensor input_: Input points where the equation is evaluated.
:param LabelTensor output_: Output tensor, eventually produced by a
:class:`~torch.nn.Module` instance.
:class:`torch.nn.Module` instance.
:param dict params_: Dictionary of unknown parameters, associated with a
:class:`~pina.problem.InverseProblem` instance. If the equation is
not related to a :class:`~pina.problem.InverseProblem` instance, the
:class:`~pina.problem.inverse_problem.InverseProblem` instance.
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.
:rtype: LabelTensor