Tmp fixes

Author: FilippoOlivo

pina/collector.py

@@ -37,10 +37,11 @@ def __init__(self, problem):
     @property
     def full(self):
         """
-        Returns True if the collector is full. The collector is considered full
-        if all conditions have entries in the data_collection dictionary.
+        Returns ``True`` if the collector is full. The collector is considered
+        full if all conditions have entries in the ``data_collection``
+        dictionary.
 
-        :return: True if all conditions are ready, False otherwise.
+        :return: ``True`` if all conditions are ready, ``False`` otherwise.
         :rtype: bool
         """
 
@@ -49,9 +50,9 @@ def full(self):
     @full.setter
     def full(self, value):
         """
-        Set the full variable.
+        Set the ``_full`` variable.
 
-        :param bool value: The value to set the full property to.
+        :param bool value: The value to set the ``_full`` variable.
         """
 
         check_consistency(value, bool)
@@ -117,7 +118,8 @@ def store_sample_domains(self):
         """
         Store inside data collections the sampled data of the problem. These
         comes from the conditions that require sampling (e.g.
-        DomainEquationCondition).
+        :class:`~pina.condition.domain_equation_condition.
+        DomainEquationCondition`).
         """
 
         for condition_name in self.problem.conditions:

pina/condition/condition.py

@@ -32,7 +32,7 @@ class Condition:
     The class ``Condition`` is used to represent the constraints (physical
     equations, boundary conditions, etc.) that should be satisfied in the
     problem at hand. Condition objects are used to formulate the
-    PINA :obj:`pina.problem.abstract_problem.AbstractProblem` object.
+    PINA :class:`~pina.problem.abstract_problem.AbstractProblem` object.
     Conditions can be specified in four ways:
 
         1. By specifying the input and target of the condition; in such a
@@ -61,7 +61,7 @@ class Condition:
         input, there are different implementations of the condition. For more
         details, see :class:`~pina.condition.data_condition.DataCondition`.
 
-    Example::
+    :Example:
 
     >>> from pina import Condition
     >>> condition = Condition(

pina/condition/data_condition.py

@@ -28,7 +28,7 @@ class DataCondition(ConditionInterface):
     def __new__(cls, input, conditional_variables=None):
         """
         Instantiate the appropriate subclass of :class:`DataCondition` based on
-        the type of `input`.
+        the type of ``input``.
 
         :param input: Input data for the condition.
         :type input: torch.Tensor | LabelTensor | Graph |
@@ -72,7 +72,7 @@ def __init__(self, input, conditional_variables=None):
         :type conditional_variables: torch.Tensor or LabelTensor
 
         .. note::
-            If either `input` is composed by a list of
+            If either ``input`` is composed by a list of
             :class:`~pina.graph.Graph` or :class:`~torch_geometric.data.Data`,
             all elements must have the same structure (keys and data
             types)

pina/condition/input_equation_condition.py

@@ -29,7 +29,7 @@ class InputEquationCondition(ConditionInterface):
     def __new__(cls, input, equation):
         """
         Instantiate the appropriate subclass of :class:`InputEquationCondition`
-        based on the type of `input`.
+        based on the type of ``input``.
 
         :param input: Input data for the condition.
         :type input: LabelTensor | Graph |  list[Graph] | tuple[Graph]
@@ -74,7 +74,7 @@ def __init__(self, input, equation):
             equation function.
 
         .. note::
-            If `input` is composed by a list of :class:`~pina.graph.Graph`
+            If ``input`` is composed by a list of :class:`~pina.graph.Graph`
             objects, all elements must have the same structure (keys and data
             types). Moreover, at least one attribute must be a
             :class:`~pina.label_tensor.LabelTensor`.

pina/condition/input_target_condition.py

@@ -52,7 +52,7 @@ def __new__(cls, input, target):
             GraphInputTensorTargetCondition |
             pina.condition.input_target_condition.GraphInputGraphTargetCondition
 
-        :raises ValueError: If `input` and/or `target` are not of type
+        :raises ValueError: If ``input`` and/or ``target`` are not of type
             :class:`torch.Tensor`, :class:`~pina.label_tensor.LabelTensor`,
             :class:`~pina.graph.Graph`, or :class:`~torch_geometric.data.Data`.
         """
@@ -94,7 +94,7 @@ def __new__(cls, input, target):
 
     def __init__(self, input, target):
         """
-        Initialize the object by storing the `input` and `target` data.
+        Initialize the object by storing the ``input`` and ``target`` data.
 
         :param input: Input data for the condition.
         :type input: torch.Tensor | LabelTensor | Graph | Data | list[Graph] |
@@ -104,7 +104,7 @@ def __init__(self, input, target):
             list[Data] | tuple[Graph] | tuple[Data]
 
         .. note::
-            If either `input` or `target` are composed by a list of
+            If either ``input`` or ``target`` are composed by a list of
             :class:`~pina.graph.Graph` or :class:`~torch_geometric.data.Data`
             objects, all elements must have the same structure (keys and data
             types)
@@ -130,14 +130,14 @@ def _check_input_target_len(input, target):
 class TensorInputTensorTargetCondition(InputTargetCondition):
     """
     InputTargetCondition subclass for :class:`torch.Tensor` or
-    :class:`~pina.label_tensor.LabelTensor` `input` and `target` data.
+    :class:`~pina.label_tensor.LabelTensor` ``input`` and ``target`` data.
     """
 
 
 class TensorInputGraphTargetCondition(InputTargetCondition):
     """
     InputTargetCondition subclass for :class:`torch.Tensor` or
-    :class:`~pina.label_tensor.LabelTensor` `input` and
+    :class:`~pina.label_tensor.LabelTensor` ``input`` and
     :class:`~pina.graph.Graph` or :class:`~torch_geometric.data.Data` `target`
     data.
     """
@@ -146,13 +146,13 @@ class TensorInputGraphTargetCondition(InputTargetCondition):
 class GraphInputTensorTargetCondition(InputTargetCondition):
     """
     InputTargetCondition subclass for :class:`~pina.graph.Graph` o
-    :class:`~torch_geometric.data.Data` `input` and :class:`torch.Tensor` or
-    :class:`~pina.label_tensor.LabelTensor` `target` data.
+    :class:`~torch_geometric.data.Data` ``input`` and :class:`torch.Tensor` or
+    :class:`~pina.label_tensor.LabelTensor` ``target`` data.
     """
 
 
 class GraphInputGraphTargetCondition(InputTargetCondition):
     """
     InputTargetCondition subclass for :class:`~pina.graph.Graph`/
-    :class:`~torch_geometric.data.Data` `input` and `target` data.
+    :class:`~torch_geometric.data.Data` ``input`` and ``target`` data.
     """

pina/data/data_module.py

@@ -17,7 +17,7 @@
 
 class DummyDataloader:
     """
-    Dataloader used when batch size is `None`. It returns the entire dataset
+    Dataloader used when batch size is ``None``. It returns the entire dataset
     in a single batch.
     """
 
@@ -38,7 +38,7 @@ def __init__(self, dataset):
         :param dataset: The dataset object to be processed.
         :type dataset: PinaDataset
 
-        .. note:: This data loader is used when the batch size is `None`.
+        .. note:: This data loader is used when the batch size is ``None``.
         """
 
         if (
@@ -273,7 +273,7 @@ def __init__(
         be in the range [0, 1].
         :param float val_size: Fraction of elements in the validation split. It
         must be in the range [0, 1].
-        :param batch_size: The batch size used for training. If `None`, the
+        :param batch_size: The batch size used for training. If ``None``, the
             entire dataset is returned in a single batch.
         :type batch_size: int | None
         :param bool shuffle: Whether to shuffle the dataset before splitting.

pina/data/dataset.py

@@ -33,8 +33,8 @@ def __new__(cls, conditions_dict, **kwargs):
         :param dict conditions_dict: Dictionary containing all the conditions
             to be included in the dataset instance.
         :return: A subclass of :class:`~pina.data.dataset.PinaDataset`.
-        :rtype: :class:`~pina.data.dataset.PinaTensorDataset` |
-            :class:`~pina.data.dataset.PinaGraphDataset`
+        :rtype: pina.data.dataset.PinaTensorDataset |
+            pina.data.dataset.PinaGraphDataset
 
         :raises ValueError: If an empty dictionary is provided.
         """
@@ -255,7 +255,7 @@ def _create_graph_batch(self, data):
 
     def _create_tensor_batch(self, data):
         """
-        Reshape properly `data` tensor to be processed handle by the graph
+        Reshape properly ``data`` tensor to be processed handle by the graph
         based models.
 
         :param data: torch.Tensor object of shape (N, ...) where N is the