Formatting

* Adding black as dev dependency
* Formatting pina code
* Formatting tests

Author: dario-coscia

pina/__init__.py

@@ -1,16 +1,16 @@
 __all__ = [
     "Trainer",
-    "LabelTensor", 
+    "LabelTensor",
     "Condition",
     "PinaDataModule",
-    'Graph',
+    "Graph",
     "SolverInterface",
-    "MultiSolverInterface"
+    "MultiSolverInterface",
 ]
 
 from .label_tensor import LabelTensor
 from .graph import Graph
 from .solver import SolverInterface, MultiSolverInterface
 from .trainer import Trainer
 from .condition.condition import Condition
-from .data import PinaDataModule
+from .data import PinaDataModule

pina/adaptive_function/adaptive_function.py

@@ -1,4 +1,4 @@
-""" Module for adaptive functions. """
+"""Module for adaptive functions."""
 
 import torch
 from ..utils import check_consistency

pina/adaptive_function/adaptive_function_interface.py

@@ -1,4 +1,4 @@
-""" Module for adaptive functions. """
+"""Module for adaptive functions."""
 
 import torch
 

pina/adaptive_functions/__init__.py

@@ -8,6 +8,7 @@
 warnings.formatwarning = custom_warning_format
 warnings.filterwarnings("always", category=DeprecationWarning)
 warnings.warn(
-            f"'pina.adaptive_functions' is deprecated and will be removed "
-            f"in future versions. Please use 'pina.adaptive_function' instead.",
-            DeprecationWarning)
+    f"'pina.adaptive_functions' is deprecated and will be removed "
+    f"in future versions. Please use 'pina.adaptive_function' instead.",
+    DeprecationWarning,
+)

pina/callback/adaptive_refinement_callback.py

@@ -67,7 +67,7 @@ def _compute_residual(self, trainer):
         # compute residual
         res_loss = {}
         tot_loss = []
-        for location in self._sampling_locations: #TODO fix for new collector
+        for location in self._sampling_locations:  # TODO fix for new collector
             condition = solver.problem.conditions[location]
             pts = solver.problem.input_pts[location]
             # send points to correct device

pina/callback/processing_callback.py

@@ -26,7 +26,7 @@ def __init__(self, metrics_to_track=None):
         super().__init__()
         self._collection = []
         # Default to tracking 'train_loss' and 'val_loss' if not specified
-        self.metrics_to_track = metrics_to_track or ['train_loss', 'val_loss']
+        self.metrics_to_track = metrics_to_track or ["train_loss", "val_loss"]
 
     def on_train_epoch_end(self, trainer, pl_module):
         """
@@ -40,7 +40,8 @@ def on_train_epoch_end(self, trainer, pl_module):
         if trainer.current_epoch > 0:
             # Append only the tracked metrics to avoid unnecessary data
             tracked_metrics = {
-                k: v for k, v in trainer.logged_metrics.items() 
+                k: v
+                for k, v in trainer.logged_metrics.items()
                 if k in self.metrics_to_track
             }
             self._collection.append(copy.deepcopy(tracked_metrics))
@@ -57,16 +58,18 @@ def metrics(self):
             return {}
 
         # Get intersection of keys across all collected dictionaries
-        common_keys = set(self._collection[0]).intersection(*self._collection[1:])
-        
+        common_keys = set(self._collection[0]).intersection(
+            *self._collection[1:]
+        )
+
         # Stack the metric values for common keys and return
         return {
             k: torch.stack([dic[k] for dic in self._collection])
-            for k in common_keys if k in self.metrics_to_track
+            for k in common_keys
+            if k in self.metrics_to_track
         }
 
 
-
 class PINAProgressBar(TQDMProgressBar):
 
     BAR_FORMAT = "{l_bar}{bar}| {n_fmt}/{total_fmt} [{elapsed}<{remaining}, {rate_noinv_fmt}{postfix}]"
@@ -142,7 +145,8 @@ def on_fit_start(self, trainer, pl_module):
         for key in self._sorted_metrics:
             if (
                 key not in trainer.solver.problem.conditions.keys()
-                and key != "train" and key != "val"
+                and key != "train"
+                and key != "val"
             ):
                 raise KeyError(f"Key '{key}' is not present in the dictionary")
         # add the loss pedix

pina/callbacks/__init__.py

@@ -8,6 +8,7 @@
 warnings.formatwarning = custom_warning_format
 warnings.filterwarnings("always", category=DeprecationWarning)
 warnings.warn(
-            f"'pina.callbacks' is deprecated and will be removed "
-            f"in future versions. Please use 'pina.callback' instead.",
-            DeprecationWarning)
+    f"'pina.callbacks' is deprecated and will be removed "
+    f"in future versions. Please use 'pina.callback' instead.",
+    DeprecationWarning,
+)

pina/collector.py

@@ -1,6 +1,7 @@
 """
 # TODO
 """
+
 from .graph import Graph
 from .utils import check_consistency
 
@@ -14,14 +15,12 @@ def __init__(self, problem):
         # those variables are used for the dataloading
         self._data_collections = {name: {} for name in self.problem.conditions}
         self.conditions_name = {
-            i: name
-            for i, name in enumerate(self.problem.conditions)
+            i: name for i, name in enumerate(self.problem.conditions)
         }
 
         # variables used to check that all conditions are sampled
         self._is_conditions_ready = {
-            name: False
-            for name in self.problem.conditions
+            name: False for name in self.problem.conditions
         }
         self.full = False
 
@@ -51,13 +50,16 @@ def store_fixed_data(self):
         for condition_name, condition in self.problem.conditions.items():
             # if the condition is not ready and domain is not attribute
             # of condition, we get and store the data
-            if (not self._is_conditions_ready[condition_name]) and (not hasattr(
-                    condition, "domain")):
+            if (not self._is_conditions_ready[condition_name]) and (
+                not hasattr(condition, "domain")
+            ):
                 # get data
                 keys = condition.__slots__
                 values = [getattr(condition, name) for name in keys]
-                values = [value.data if isinstance(
-                    value, Graph) else value for value in values]
+                values = [
+                    value.data if isinstance(value, Graph) else value
+                    for value in values
+                ]
                 self.data_collections[condition_name] = dict(zip(keys, values))
                 # condition now is ready
                 self._is_conditions_ready[condition_name] = True
@@ -74,6 +76,6 @@ def store_sample_domains(self):
             samples = self.problem.discretised_domains[condition.domain]
 
             self.data_collections[condition_name] = {
-                'input_points': samples,
-                'equation': condition.equation
+                "input_points": samples,
+                "equation": condition.equation,
             }

pina/condition/__init__.py

@@ -1,12 +1,12 @@
 __all__ = [
-    'Condition',
-    'ConditionInterface',
-    'DomainEquationCondition',
-    'InputPointsEquationCondition',
-    'InputOutputPointsCondition',
+    "Condition",
+    "ConditionInterface",
+    "DomainEquationCondition",
+    "InputPointsEquationCondition",
+    "InputOutputPointsCondition",
 ]
 
 from .condition_interface import ConditionInterface
 from .domain_equation_condition import DomainEquationCondition
 from .input_equation_condition import InputPointsEquationCondition
-from .input_output_condition import InputOutputPointsCondition
+from .input_output_condition import InputOutputPointsCondition

pina/condition/condition.py

@@ -1,4 +1,4 @@
-""" Condition module. """
+"""Condition module."""
 
 from .domain_equation_condition import DomainEquationCondition
 from .input_equation_condition import InputPointsEquationCondition
@@ -11,6 +11,7 @@
 warnings.formatwarning = custom_warning_format
 warnings.filterwarnings("always", category=DeprecationWarning)
 
+
 class Condition:
     """
     The class ``Condition`` is used to represent the constraints (physical
@@ -44,24 +45,30 @@ class Condition:
     """
 
     __slots__ = list(
-        set(InputOutputPointsCondition.__slots__ +
-            InputPointsEquationCondition.__slots__ +
-            DomainEquationCondition.__slots__ +
-            DataConditionInterface.__slots__))
+        set(
+            InputOutputPointsCondition.__slots__
+            + InputPointsEquationCondition.__slots__
+            + DomainEquationCondition.__slots__
+            + DataConditionInterface.__slots__
+        )
+    )
 
     def __new__(cls, *args, **kwargs):
 
         if len(args) != 0:
-            raise ValueError("Condition takes only the following keyword "
-                             f"arguments: {Condition.__slots__}.")
+            raise ValueError(
+                "Condition takes only the following keyword "
+                f"arguments: {Condition.__slots__}."
+            )
 
         # back-compatibility 0.1
-        if 'location' in kwargs.keys():
-            kwargs['domain'] = kwargs.pop('location')
+        if "location" in kwargs.keys():
+            kwargs["domain"] = kwargs.pop("location")
             warnings.warn(
-            f"'location' is deprecated and will be removed "
-            f"in future versions. Please use 'domain' instead.",
-            DeprecationWarning)
+                f"'location' is deprecated and will be removed "
+                f"in future versions. Please use 'domain' instead.",
+                DeprecationWarning,
+            )
 
         sorted_keys = sorted(kwargs.keys())