rename AbstractProblem as BaseProblem

Author: GiovanniCanali

docs/source/_rst/_code.rst

@@ -209,7 +209,7 @@ Problems
     :titlesonly:
 
     ProblemInterface <problem/problem_interface.rst>
-    AbstractProblem <problem/abstract_problem.rst>
+    BaseProblem <problem/base_problem.rst>
     InverseProblem <problem/inverse_problem.rst>
     ParametricProblem <problem/parametric_problem.rst>
     SpatialProblem <problem/spatial_problem.rst>

docs/source/_rst/problem/abstract_problem.rst

@@ -0,0 +1,9 @@
+Base Problem
+===============
+.. currentmodule:: pina.problem.base_problem
+
+.. automodule:: pina._src.problem.base_problem
+
+.. autoclass:: pina._src.problem.base_problem.BaseProblem
+    :members:
+    :show-inheritance:

docs/source/_rst/problem/base_problem.rst

@@ -12,7 +12,7 @@ class Condition:
     """
     The :class:`Condition` class is a core component of the PINA framework that
     provides a unified interface to define heterogeneous constraints that must
-    be satisfied by a :class:`~pina.problem.abstract_problem.AbstractProblem`.
+    be satisfied by a :class:`~pina.problem.base_problem.BaseProblem`.
 
     It encapsulates all types of constraints - physical, boundary, initial, or
     data-driven - that the solver must satisfy during training. The specific

pina/_src/condition/condition.py

@@ -42,7 +42,7 @@ def problem(self):
         Return the problem associated with this condition.
 
         :return: Problem associated with this condition.
-        :rtype: ~pina.problem.abstract_problem.AbstractProblem
+        :rtype: ~pina.problem.base_problem.BaseProblem
         """
         return self._problem
 
@@ -51,8 +51,8 @@ def problem(self, value):
         """
         Set the problem associated with this condition.
 
-        :param pina.problem.abstract_problem.AbstractProblem value: The problem
-            to associate with this condition
+        :param pina.problem.base_problem.BaseProblem value: The problem to
+            associate with this condition.
         """
         self._problem = value
 

pina/_src/condition/condition_base.py

@@ -25,7 +25,7 @@ def problem(self):
         Return the problem associated with this condition.
 
         :return: Problem associated with this condition.
-        :rtype: ~pina.problem.abstract_problem.AbstractProblem
+        :rtype: ~pina.problem.base_problem.BaseProblem
         """
 
     @problem.setter
@@ -34,7 +34,7 @@ def problem(self, value):
         """
         Set the problem associated with this condition.
 
-        :param pina.problem.abstract_problem.AbstractProblem value: The problem
+        :param pina.problem.base_problem.BaseProblem value: The problem
             to associate with this condition
         """
 

pina/_src/condition/condition_interface.py

@@ -48,7 +48,7 @@ def __init__(
 
         :param SolverInterface solver: A
             :class:`~pina.solver.solver.SolverInterface` solver used to solve a
-            :class:`~pina.problem.abstract_problem.AbstractProblem`.
+            :class:`~pina.problem.base_problem.BaseProblem`.
         :param int batch_size: The number of samples per batch to load.
             If ``None``, all samples are loaded and data is not batched.
             Default is ``None``.
@@ -184,7 +184,7 @@ def __init__(
     def _move_to_device(self):
         """
         Moves the ``unknown_parameters`` of an instance of
-        :class:`~pina.problem.abstract_problem.AbstractProblem` to the
+        :class:`~pina.problem.base_problem.BaseProblem` to the
         :class:`Trainer` device.
         """
         device = self._accelerator_connector._parallel_devices[0]

pina/_src/core/trainer.py

@@ -93,9 +93,9 @@ def labelize_forward(forward, input_variables, output_variables):
 
     :param Callable forward: The forward function of a :class:`torch.nn.Module`.
     :param list[str] input_variables: The names of the input variables of a
-        :class:`~pina.problem.abstract_problem.AbstractProblem`.
+        :class:`~pina.problem.base_problem.BaseProblem`.
     :param list[str] output_variables: The names of the output variables of a
-        :class:`~pina.problem.abstract_problem.AbstractProblem`.
+        :class:`~pina.problem.base_problem.BaseProblem`.
     :return: The decorated forward function.
     :rtype: Callable
     """

pina/_src/core/utils.py

@@ -84,7 +84,7 @@ def __init__(
         """
         Initialize the object and creating datasets based on the input problem.
 
-        :param AbstractProblem problem: The problem containing the data on which
+        :param BaseProblem problem: The problem containing the data on which
             to create the datasets and dataloaders.
         :param float train_size: Fraction of elements in the training split. It
             must be in the range [0, 1].

pina/_src/data/data_module.py

@@ -1,5 +1,6 @@
-"""Module for the AbstractProblem class."""
+"""Module for the BaseProblem class."""
 
+import warnings
 from copy import deepcopy
 from pina._src.problem.problem_interface import ProblemInterface
 from pina._src.domain.domain_interface import DomainInterface
@@ -15,7 +16,7 @@
 )
 
 
-class AbstractProblem(ProblemInterface):
+class BaseProblem(ProblemInterface):
     """
     Base class for all problems, implementing common functionality.
 
@@ -31,7 +32,7 @@ class AbstractProblem(ProblemInterface):
 
     def __init__(self):
         """
-        Initialization of the :class:`AbstractProblem` class.
+        Initialization of the :class:`BaseProblem` class.
         """
         self._discretised_domains = {}
 
@@ -294,3 +295,14 @@ def are_all_domains_discretised(self):
         :rtype: bool
         """
         return all(d in self.discretised_domains for d in self.domains)
+
+
+# Back-compatibility with version 0.2, to be removed soon
+class AbstractProblem(BaseProblem):
+    def __init__(self, *args, **kwargs):
+        warnings.warn(
+            "AbstractProblem is deprecated, use BaseProblem instead",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        super().__init__(*args, **kwargs)