Fix rendering and codacy

Author: FilippoOlivo

pina/collector.py

@@ -118,7 +118,7 @@ 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.
-        :class:`~pina.condition.domain_equation_condition.
+        :class:`~pina.condition.domain_equation_condition.\
         DomainEquationCondition`).
         """
 

pina/data/data_module.py

@@ -244,7 +244,7 @@ def __new__(cls, dataset, shuffle):
 
 class PinaDataModule(LightningDataModule):
     """
-    This class extends :class:`lightning.pytorch.LightningDataModule`,
+    This class extends :class:`~lightning.pytorch.core.LightningDataModule`,
     allowing proper creation and management of different types of datasets
     defined in PINA.
     """
@@ -268,24 +268,24 @@ def __init__(
         :param AbstractProblem 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].
+            must be in the range [0, 1].
         :param float test_size: Fraction of elements in the test split. It must
-        be in the range [0, 1].
+            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].
+            must be in the range [0, 1].
         :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
+            entire dataset is returned in a single batch. Default is ``None``.
+        :type batch_size: int
         :param bool shuffle: Whether to shuffle the dataset before splitting.
-            Default True.
+            Default ``Tru``e.
         :param bool repeat: Whether to repeat the dataset indefinitely.
-            Default False.
+            Default ``False``.
         :param automatic_batching: Whether to enable automatic batching.
-            Default False.
+            Default ``False``.
         :param int num_workers: Number of worker threads for data loading.
-            Default 0 (serial loading).
+            Default ``0`` (serial loading).
         :param bool pin_memory: Whether to use pinned memory for faster data
-            transfer to GPU. Default False.
+            transfer to GPU. Default ``False``.
 
         :raises ValueError: If at least one of the splits is negative.
         :raises ValueError: If the sum of the splits is different from 1.
@@ -643,7 +643,7 @@ def input(self):
         Return all the input points coming from all the datasets.
 
         :return: The input points for training.
-        :rtype dict
+        :rtype: dict
         """
 
         to_return = {}

pina/data/dataset.py

@@ -12,12 +12,13 @@ class PinaDatasetFactory:
     """
     Factory class for the PINA dataset.
 
-    Depending on the type inside the conditions, it creates a different dataset
-    object:
+    Depending on the data type inside the conditions, it instanciate an object
+    belonging to the appropriate subclass of 
+    :class:`~pina.data.dataset.PinaDataset`. The possible subclasses are:
 
-    - :class:`~pina.data.dataset.PinaTensorDataset` for handling
+    - :class:`~pina.data.dataset.PinaTensorDataset`, for handling \
         :class:`torch.Tensor` and :class:`~pina.label_tensor.LabelTensor` data.
-    - :class:`~pina.data.dataset.PinaGraphDataset` for handling
+    - :class:`~pina.data.dataset.PinaGraphDataset`, for handling \
         :class:`~pina.graph.Graph` and :class:`~torch_geometric.data.Data` data.
     """
 
@@ -33,8 +34,7 @@ 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: pina.data.dataset.PinaTensorDataset |
-            pina.data.dataset.PinaGraphDataset
+        :rtype: PinaTensorDataset | PinaGraphDataset
 
         :raises ValueError: If an empty dictionary is provided.
         """
@@ -74,22 +74,25 @@ def _is_graph_dataset(conditions_dict):
 
 class PinaDataset(Dataset, ABC):
     """
-    Abstract class for the PINA dataset. It defines the common interface for
-    :class:`~pina.data.dataset.PinaTensorDataset` and
+    Abstract class for the PINA dataset which extends the PyTorch
+    :class:`~torch.utils.data.Dataset` class. It defines the common interface
+    for :class:`~pina.data.dataset.PinaTensorDataset` and
     :class:`~pina.data.dataset.PinaGraphDataset` classes.
     """
 
     def __init__(
         self, conditions_dict, max_conditions_lengths, automatic_batching
     ):
         """
-        Initialize :class:`~pina.data.dataset.PinaDataset` instance by storing
-        the provided conditions dictionary, and the automatic batching flag.
-
-        :param dict conditions_dict: Dictionary containing the conditions with
-            data.
-        :param dict max_conditions_lengths: Specifies the maximum number of data
-            points to include in a single batch for each condition.
+        Initialize the instance by storing the conditions dictionary, the
+        maximum number of items per conditions to consider, and the automatic
+        batching flag.
+
+        :param dict conditions_dict: A dictionary mapping condition names to
+            their respective data. Each key represents a condition name, and the
+            corresponding value is a dictionary containing the associated data.
+        :param dict max_conditions_lengths: Maximum number of data points that
+            can be included in a single batch per condition.
         :param bool automatic_batching: Indicates whether PyTorch automatic
             batching is enabled in
             :class:`~pina.data.data_module.PinaDataModule`.
@@ -258,8 +261,8 @@ def _create_tensor_batch(self, data):
         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
-            number of data points.
+        :param data: torch.Tensor object of shape ``(N, ...)`` where ``N`` is
+            the number of data objects.
         :type data: torch.Tensor | LabelTensor
         :return: Reshaped tensor object.
         :rtype: torch.Tensor | LabelTensor
@@ -275,7 +278,7 @@ def create_batch(self, data):
         :param data: List of items to collate in a single batch.
         :type data: list[Data] | list[Graph]
         :return: Batch object.
-        :rtype: Batch | PinaBatch
+        :rtype: Batch | LabelBatch
         """
 
         if isinstance(data[0], Data):

pina/graph.py

@@ -23,9 +23,8 @@ def __new__(
         Create a new instance of the :class:`~pina.graph.Graph` class by
         checking the consistency of the input data and storing the attributes.
 
-        :param kwargs: Parameters used to initialize the
+        :param dict kwargs: Parameters used to initialize the
             :class:`~pina.graph.Graph` object.
-        :type kwargs: dict
         :return: A new instance of the :class:`~pina.graph.Graph` class.
         :rtype: Graph
         """
@@ -56,8 +55,8 @@ def __init__(
         :param x: Optional tensor of node features ``(N, F)`` where ``F`` is the
             number of features per node.
         :type x: torch.Tensor, LabelTensor
-        :param torch.Tensor edge_index: A tensor of shape ``(2, E)`` representing
-            the indices of the graph's edges.
+        :param torch.Tensor edge_index: A tensor of shape ``(2, E)``
+            representing the indices of the graph's edges.
         :param pos: A tensor of shape ``(N, D)`` representing the positions of
             ``N`` points in ``D``-dimensional space.
         :type pos: torch.Tensor | LabelTensor
@@ -80,8 +79,7 @@ def _check_type_consistency(self, **kwargs):
         """
         Check the consistency of the types of the input data.
 
-        :param kwargs: Attributes to be checked for consistency.
-        :type kwargs: dict
+        :param dict kwargs: Attributes to be checked for consistency.
         """
         # default types, specified in cls.__new__, by default they are Nont
         # if specified in **kwargs they get override
@@ -134,7 +132,8 @@ def _check_edge_attr_consistency(edge_attr, edge_index):
         Check if the edge attribute tensor is consistent in type and shape
         with the edge index.
 
-        :param torch.Tensor edge_attr: The edge attribute tensor.
+        :param edge_attr: The edge attribute tensor.
+        :type edge_attr: torch.Tensor | LabelTensor
         :param torch.Tensor edge_index: The edge index tensor.
         :raises ValueError: If the edge attribute tensor is not consistent.
         """
@@ -156,8 +155,11 @@ def _check_x_consistency(x, pos=None):
         Check if the input tensor x is consistent with the position tensor
         `pos`.
 
-        :param torch.Tensor x: The input tensor.
-        :param torch.Tensor pos: The position tensor.
+        :param x: The input tensor.
+        :type x: torch.Tensor | LabelTensor
+        :param pos: The position tensor.
+        :type pos: torch.Tensor | LabelTensor
+        :raises ValueError: If the input tensor is not consistent.
         """
         if x is not None:
             check_consistency(x, (torch.Tensor, LabelTensor))
@@ -166,9 +168,6 @@ def _check_x_consistency(x, pos=None):
             if pos is not None:
                 if x.size(0) != pos.size(0):
                     raise ValueError("Inconsistent number of nodes.")
-            if pos is not None:
-                if x.size(0) != pos.size(0):
-                    raise ValueError("Inconsistent number of nodes.")
 
     @staticmethod
     def _preprocess_edge_index(edge_index, undirected):
@@ -292,7 +291,7 @@ def _build_edge_attr(pos, edge_index):
 class RadiusGraph(GraphBuilder):
     """
     Extends the :class:`~pina.graph.GraphBuilder` class to compute
-    edge_index based on a radius. Each point is connected to all the points
+    ``edge_index`` based on a radius. Each point is connected to all the points
     within the radius.
     """
 
@@ -305,11 +304,10 @@ def __new__(cls, pos, radius, **kwargs):
             ``N`` points in ``D``-dimensional space.
         :type pos: torch.Tensor | LabelTensor
         :param float radius: The radius within which points are connected.
-        :param kwargs: Additional keyword arguments to be passed to the
-            :class:`~pina.graph.GraphBuilder` and :class:`~pina.graph.Graph`
-            constructors.
-        :return: A :class:`~pina.graph.Graph` instance containing the input
-            information and the computed ``edge_index``.
+        :param dict kwargs: The additional keyword arguments to be passed to
+            :class:`GraphBuilder` and :class:`Graph` classes.
+        :return: A :class:`~pina.graph.Graph` instance with the computed
+            ``edge_index``.
         :rtype: Graph
         """
         edge_index = cls.compute_radius_graph(pos, radius)
@@ -318,16 +316,16 @@ def __new__(cls, pos, radius, **kwargs):
     @staticmethod
     def compute_radius_graph(points, radius):
         """
-        Computes ``edge_index`` for a given set of points base on the radius.
-        Each point is connected to all the points within the radius.
+        Computes the ``edge_index`` based on the radius. Each point is connected
+        to all the points within the radius.
 
         :param points: A tensor of shape ``(N, D)`` representing the positions
             of ``N`` points in ``D``-dimensional space.
         :type points: torch.Tensor | LabelTensor
-        :param float radius: The number of nearest neighbors to find for each
-            point.
-        :rtype torch.Tensor: A tensor of shape ``(2, E)``, where ``E`` is the
-            number of edges, representing the edge indices of the KNN graph.
+        :param float radius: The radius within which points are connected.
+        :return: A tensor of shape ``(2, E)``, with ``E`` number of edges,
+            representing the edge indices of the graph.
+        :rtype: torch.Tensor
         """
         dist = torch.cdist(points, points, p=2)
         return (
@@ -340,7 +338,7 @@ def compute_radius_graph(points, radius):
 class KNNGraph(GraphBuilder):
     """
     Extends the :class:`~pina.graph.GraphBuilder` class to compute
-    edge_index based on a K-nearest neighbors algorithm.
+    ``edge_index`` based on a K-nearest neighbors algorithm.
     """
 
     def __new__(cls, pos, neighbours, **kwargs):
@@ -353,54 +351,57 @@ def __new__(cls, pos, neighbours, **kwargs):
         :type pos: torch.Tensor | LabelTensor
         :param int neighbours: The number of nearest neighbors to consider when
             building the graph.
-        :Keyword Arguments:
-            The additional keyword arguments to be passed to GraphBuilder
-            and Graph classes
+        :param dict kwargs: The additional keyword arguments to be passed to
+            :class:`GraphBuilder` and :class:`Graph` classes.
 
-        :return: A :class:`~pina.graph.Graph` instance containg the
-            information passed in input and the computed ``edge_index``
+        :return: A :class:`~pina.graph.Graph` instance with the computed
+            ``edge_index``.
         :rtype: Graph
         """
 
         edge_index = cls.compute_knn_graph(pos, neighbours)
         return super().__new__(cls, pos=pos, edge_index=edge_index, **kwargs)
 
     @staticmethod
-    def compute_knn_graph(points, k):
+    def compute_knn_graph(points, neighbours):
         """
-        Computes the edge_index based k-nearest neighbors graph algorithm
+        Computes the ``edge_index`` based on the K-nearest neighbors algorithm.
 
         :param points: A tensor of shape ``(N, D)`` representing the positions
             of ``N`` points in ``D``-dimensional space.
         :type points: torch.Tensor | LabelTensor
-        :param int k: The number of nearest neighbors to find for each point.
-        :return: A tensor of shape ``(2, E)``, where ``E`` is the number of
-            edges, representing the edge indices of the KNN graph.
+        :param int neighbours: The number of nearest neighbors to consider when
+            building the graph.
+        :return: A tensor of shape ``(2, E)``, with ``E`` number of edges,
+            representing the edge indices of the graph.
         :rtype: torch.Tensor
         """
 
         dist = torch.cdist(points, points, p=2)
-        knn_indices = torch.topk(dist, k=k + 1, largest=False).indices[:, 1:]
-        row = torch.arange(points.size(0)).repeat_interleave(k)
+        knn_indices = torch.topk(dist, k=neighbours + 1, largest=False).indices[
+            :, 1:
+        ]
+        row = torch.arange(points.size(0)).repeat_interleave(neighbours)
         col = knn_indices.flatten()
         return torch.stack([row, col], dim=0).as_subclass(torch.Tensor)
 
 
 class LabelBatch(Batch):
     """
-    Add extract function to torch_geometric Batch object
+    Extends the :class:`~torch_geometric.data.Batch` class to include
+    :class:`~pina.label_tensor.LabelTensor` objects.
     """
 
     @classmethod
     def from_data_list(cls, data_list):
         """
         Create a Batch object from a list of :class:`~torch_geometric.data.Data`
-        objects.
+        or :class:`~pina.graph.Graph` objects.
 
         :param data_list: List of :class:`~torch_geometric.data.Data` or
             :class:`~pina.graph.Graph` objects.
         :type data_list: list[Data] | list[Graph]
-        :return: A Batch object containing the data in the list
+        :return: A :class:`Batch` object containing the input data.
         :rtype: Batch
         """
         # Store the labels of Data/Graph objects (all data have the same labels)

pina/label_tensor.py

@@ -216,10 +216,10 @@ def _init_labels_from_list(self, labels):
     def extract(self, labels_to_extract):
         """
         Extract the subset of the original tensor by returning all the positions
-        corresponding to the passed ``label_to_extract``. If ``label_to_extract``
-        is a dictionary, the keys are the dimension names and the values are the
-        labels to extract. If a single label or a list of labels is passed, the
-        last dimension is considered.
+        corresponding to the passed ``label_to_extract``. If
+        ``label_to_extract`` is a dictionary, the keys are the dimension names
+        and the values are the labels to extract. If a single label or a list
+        of labels is passed, the last dimension is considered.
 
         :Example:
             >>> from pina import LabelTensor

pina/model/feed_forward.py

@@ -154,7 +154,7 @@ def __init__(
         :param transformer_nets: The two :class:`torch.nn.Module` acting as
             transformer network. The input dimension of both networks must be
             equal to ``input_dimensions``, and the output dimension must be
-            equal to ``inner_size``. If ``None``, two 
+            equal to ``inner_size``. If ``None``, two
             :class:`~pina.model.block.residual.EnhancedLinear` layers are used.
             Default is ``None``.
         :type transformer_nets: list[torch.nn.Module] | tuple[torch.nn.Module]