standardize module docstring

GiovanniCanali · GiovanniCanali · commit da98d61e7794 · 2025-03-14T16:33:18.000+01:00
diff --git a/pina/__init__.py b/pina/__init__.py
@@ -1,6 +1,4 @@
-"""
-Module for the Pina library.
-"""
+"""Module for the Pina library."""
 
 __all__ = [
     "Trainer",
diff --git a/pina/adaptive_function/__init__.py b/pina/adaptive_function/__init__.py
@@ -1,6 +1,4 @@
-"""
-Adaptive Activation Functions Module.
-"""
+"""Adaptive Activation Functions Module."""
 
 __all__ = [
     "AdaptiveActivationFunctionInterface",
diff --git a/pina/adaptive_function/adaptive_function.py b/pina/adaptive_function/adaptive_function.py
@@ -1,4 +1,4 @@
-"""Module for adaptive functions."""
+"""Module for the Adaptive Functions."""
 
 import torch
 from ..utils import check_consistency
diff --git a/pina/adaptive_function/adaptive_function_interface.py b/pina/adaptive_function/adaptive_function_interface.py
@@ -1,4 +1,4 @@
-"""Module for adaptive functions."""
+"""Module for the Adaptive Function interface."""
 
 from abc import ABCMeta
 import torch
diff --git a/pina/adaptive_functions/__init__.py b/pina/adaptive_functions/__init__.py
@@ -1,6 +1,4 @@
-"""
-Old module for adaptive functions. Deprecated in 0.2.0.
-"""
+"""Old module for adaptive functions. Deprecated in 0.2.0."""
 
 import warnings
 
diff --git a/pina/callback/__init__.py b/pina/callback/__init__.py
@@ -1,3 +1,5 @@
+"""Module for the Pina Callbacks."""
+
 __all__ = [
     "SwitchOptimizer",
     "R3Refinement",
diff --git a/pina/callback/adaptive_refinement_callback.py b/pina/callback/adaptive_refinement_callback.py
@@ -1,4 +1,4 @@
-"""PINA Callbacks Implementations"""
+"""Module for the R3Refinement callback."""
 
 import importlib.metadata
 import torch
diff --git a/pina/callback/linear_weight_update_callback.py b/pina/callback/linear_weight_update_callback.py
@@ -1,4 +1,4 @@
-"""PINA Callbacks Implementations"""
+"""Module for the LinearWeightUpdate callback."""
 
 import warnings
 from lightning.pytorch.callbacks import Callback
diff --git a/pina/callback/optimizer_callback.py b/pina/callback/optimizer_callback.py
@@ -1,4 +1,4 @@
-"""PINA Callbacks Implementations"""
+"""Module for the SwitchOptimizer callback."""
 
 from lightning.pytorch.callbacks import Callback
 from ..optim import TorchOptimizer
diff --git a/pina/callback/processing_callback.py b/pina/callback/processing_callback.py
@@ -1,4 +1,4 @@
-"""PINA Callbacks Implementations"""
+"""Module for the Processing Callbacks."""
 
 import copy
 import torch
diff --git a/pina/callbacks/__init__.py b/pina/callbacks/__init__.py
@@ -1,6 +1,4 @@
-"""
-Old module for callbacks. Deprecated in 0.2.0.
-"""
+"""Old module for callbacks. Deprecated in 0.2.0."""
 
 import warnings
 
diff --git a/pina/collector.py b/pina/collector.py
@@ -1,6 +1,4 @@
-"""
-Module for the Collector class.
-"""
+"""Module for the Collector class."""
 
 from .graph import Graph
 from .utils import check_consistency
diff --git a/pina/condition/__init__.py b/pina/condition/__init__.py
@@ -1,6 +1,4 @@
-"""
-Module for importing Conditions objects.
-"""
+"""Module for PINA Conditions classes."""
 
 __all__ = [
     "Condition",
diff --git a/pina/condition/condition.py b/pina/condition/condition.py
@@ -1,4 +1,4 @@
-"""Condition module."""
+"""Module for the Condition class."""
 
 import warnings
 from .data_condition import DataCondition
diff --git a/pina/condition/condition_interface.py b/pina/condition/condition_interface.py
@@ -1,6 +1,4 @@
-"""
-Module that defines the ConditionInterface class.
-"""
+"""Module for the Condition interface."""
 
 from abc import ABCMeta
 from torch_geometric.data import Data
diff --git a/pina/condition/data_condition.py b/pina/condition/data_condition.py
@@ -1,6 +1,4 @@
-"""
-DataCondition class
-"""
+"""Module for the DataCondition class."""
 
 import torch
 from torch_geometric.data import Data
diff --git a/pina/condition/domain_equation_condition.py b/pina/condition/domain_equation_condition.py
@@ -1,6 +1,4 @@
-"""
-DomainEquationCondition class definition.
-"""
+"""Module for the DomainEquationCondition class."""
 
 from .condition_interface import ConditionInterface
 from ..utils import check_consistency
diff --git a/pina/condition/input_equation_condition.py b/pina/condition/input_equation_condition.py
@@ -1,6 +1,4 @@
-"""
-Module to define InputEquationCondition class and its subclasses.
-"""
+"""Module for the InputEquationCondition class and its subclasses."""
 
 from torch_geometric.data import Data
 from .condition_interface import ConditionInterface
diff --git a/pina/data/__init__.py b/pina/data/__init__.py
@@ -1,6 +1,4 @@
-"""
-Module for data data module and dataset.
-"""
+"""Module for data, data module, and dataset."""
 
 __all__ = ["PinaDataModule", "PinaDataset"]
 
diff --git a/pina/data/dataset.py b/pina/data/dataset.py
@@ -1,6 +1,4 @@
-"""
-Module for the PINA dataset
-"""
+"""Module for the PINA dataset classes."""
 
 from abc import abstractmethod, ABC
 from torch.utils.data import Dataset
diff --git a/pina/equation/__init__.py b/pina/equation/__init__.py
@@ -1,6 +1,4 @@
-"""
-Module to define equations and systems of equations.
-"""
+"""Module to define equations and systems of equations."""
 
 __all__ = [
     "SystemEquation",
diff --git a/pina/equation/equation_interface.py b/pina/equation/equation_interface.py
@@ -1,4 +1,4 @@
-"""Module for the Equation Interface"""
+"""Module for the Equation Interface."""
 
 from abc import ABCMeta, abstractmethod
 
diff --git a/pina/geometry/__init__.py b/pina/geometry/__init__.py
@@ -1,7 +1,4 @@
-"""
-Old module for geometry related classes and functions.
-Deprecated in 0.2.0.
-"""
+"""Old module for geometry classes and functions. Deprecated in 0.2.0."""
 
 import warnings
 
diff --git a/pina/graph.py b/pina/graph.py
@@ -1,6 +1,4 @@
-"""
-Module to build Graph objects and perform operations on them.
-"""
+"""Module to build Graph objects and perform operations on them."""
 
 import torch
 from torch_geometric.data import Data, Batch
diff --git a/pina/loss/loss_interface.py b/pina/loss/loss_interface.py
@@ -1,4 +1,4 @@
-"""Module for the Loss Interface"""
+"""Module for the Loss Interface."""
 
 from abc import ABCMeta, abstractmethod
 from torch.nn.modules.loss import _Loss
diff --git a/pina/loss/lp_loss.py b/pina/loss/lp_loss.py
@@ -1,4 +1,4 @@
-"""Module for LpLoss class"""
+"""Module for the LpLoss class."""
 
 import torch
 
diff --git a/pina/loss/power_loss.py b/pina/loss/power_loss.py
@@ -1,4 +1,4 @@
-"""Module for PowerLoss class"""
+"""Module for the PowerLoss class."""
 
 import torch
 
diff --git a/pina/loss/weighting_interface.py b/pina/loss/weighting_interface.py
@@ -1,4 +1,4 @@
-"""Module for the Weighting Interface"""
+"""Module for the Weighting Interface."""
 
 from abc import ABCMeta, abstractmethod
 
diff --git a/pina/model/__init__.py b/pina/model/__init__.py
@@ -1,6 +1,4 @@
-"""
-Module for the Neural model classes.
-"""
+"""Module for the Neural model classes."""
 
 __all__ = [
     "FeedForward",
diff --git a/pina/model/block/__init__.py b/pina/model/block/__init__.py
@@ -1,6 +1,4 @@
-"""
-Module for the building blocks of the neural models.
-"""
+"""Module for the building blocks of the neural models."""
 
 __all__ = [
     "ContinuousConvBlock",
diff --git a/pina/model/block/convolution_2d.py b/pina/model/block/convolution_2d.py
@@ -1,4 +1,4 @@
-"""Module for Continuous Convolution class"""
+"""Module for the Continuous Convolution class."""
 
 import torch
 from .convolution import BaseContinuousConv
diff --git a/pina/model/block/embedding.py b/pina/model/block/embedding.py
@@ -1,4 +1,4 @@
-"""Modules for the Embedding blocks."""
+"""Modules for the the Embedding blocks."""
 
 import torch
 from pina.utils import check_consistency
diff --git a/pina/model/block/fourier_block.py b/pina/model/block/fourier_block.py
@@ -1,6 +1,4 @@
-"""
-Module for the Fourier Neural Operator Block class.
-"""
+"""Module for the Fourier Neural Operator Block class."""
 
 import torch
 from torch import nn
diff --git a/pina/model/block/gno_block.py b/pina/model/block/gno_block.py
@@ -1,6 +1,4 @@
-"""
-Module for the Graph Neural Operator Block class.
-"""
+"""Module for the Graph Neural Operator Block class."""
 
 import torch
 from torch_geometric.nn import MessagePassing
diff --git a/pina/model/block/integral.py b/pina/model/block/integral.py
@@ -1,6 +1,4 @@
-"""
-Module to perform integration for continuous convolution.
-"""
+"""Module to perform integration for continuous convolution."""
 
 import torch
 
diff --git a/pina/model/block/residual.py b/pina/model/block/residual.py
@@ -1,6 +1,4 @@
-"""
-Module for residual blocks and enhanced linear layers.
-"""
+"""Module for residual blocks and enhanced linear layers."""
 
 import torch
 from torch import nn
diff --git a/pina/model/block/spectral.py b/pina/model/block/spectral.py
@@ -1,6 +1,4 @@
-"""
-Module for spectral convolution blocks.
-"""
+"""Module for spectral convolution blocks."""
 
 import torch
 from torch import nn
diff --git a/pina/model/block/stride.py b/pina/model/block/stride.py
@@ -1,6 +1,4 @@
-"""
-Module for the Stride class.
-"""
+"""Module for the Stride class."""
 
 import torch
 
diff --git a/pina/model/block/utils_convolution.py b/pina/model/block/utils_convolution.py
@@ -1,6 +1,4 @@
-"""
-Module for utility functions for the convolutional layer.
-"""
+"""Module for utility functions for the convolutional layer."""
 
 import torch
 
diff --git a/pina/model/deeponet.py b/pina/model/deeponet.py
@@ -1,4 +1,4 @@
-"""Module for the DeepONet and MIONet model classes"""
+"""Module for the DeepONet and MIONet model classes."""
 
 from functools import partial
 import torch
diff --git a/pina/model/feed_forward.py b/pina/model/feed_forward.py
@@ -1,4 +1,4 @@
-"""Module for the Feed Forward model class"""
+"""Module for the Feed Forward model class."""
 
 import torch
 from torch import nn
diff --git a/pina/model/fourier_neural_operator.py b/pina/model/fourier_neural_operator.py
@@ -1,6 +1,4 @@
-"""
-Module for the Fourier Neural Operator model class.
-"""
+"""Module for the Fourier Neural Operator model class."""
 
 import warnings
 import torch
diff --git a/pina/model/graph_neural_operator.py b/pina/model/graph_neural_operator.py
@@ -1,6 +1,4 @@
-"""
-Module for the Graph Neural Operator model class.
-"""
+"""Module for the Graph Neural Operator model class."""
 
 import torch
 from torch.nn import Tanh
diff --git a/pina/model/kernel_neural_operator.py b/pina/model/kernel_neural_operator.py
@@ -1,6 +1,4 @@
-"""
-Module for the Kernel Neural Operator model class.
-"""
+"""Module for the Kernel Neural Operator model class."""
 
 import torch
 from ..utils import check_consistency
diff --git a/pina/model/layers/__init__.py b/pina/model/layers/__init__.py
@@ -1,6 +1,4 @@
-"""
-Old layers module, deprecated in 0.2.0.
-"""
+"""Old layers module, deprecated in 0.2.0."""
 
 import warnings
 
diff --git a/pina/model/multi_feed_forward.py b/pina/model/multi_feed_forward.py
@@ -1,4 +1,4 @@
-"""Module for the Multi Feed Forward model class"""
+"""Module for the Multi Feed Forward model class."""
 
 from abc import ABC, abstractmethod
 import torch
diff --git a/pina/model/spline.py b/pina/model/spline.py
@@ -1,4 +1,4 @@
-"""Module for the Spline model class"""
+"""Module for the Spline model class."""
 
 import torch
 from ..utils import check_consistency
diff --git a/pina/operators.py b/pina/operators.py
@@ -1,6 +1,4 @@
-"""
-Old module for operators. Deprecated in 0.2.0.
-"""
+"""Old module for operators. Deprecated in 0.2.0."""
 
 import warnings
 
diff --git a/pina/problem/abstract_problem.py b/pina/problem/abstract_problem.py
@@ -1,4 +1,4 @@
-"""Module for the AbstractProblem class"""
+"""Module for the AbstractProblem class."""
 
 from abc import ABCMeta, abstractmethod
 from copy import deepcopy
diff --git a/pina/problem/inverse_problem.py b/pina/problem/inverse_problem.py
@@ -1,4 +1,4 @@
-"""Module for the InverseProblem class"""
+"""Module for the InverseProblem class."""
 
 from abc import abstractmethod
 import torch
diff --git a/pina/problem/parametric_problem.py b/pina/problem/parametric_problem.py
@@ -1,4 +1,4 @@
-"""Module for the ParametricProblem class"""
+"""Module for the ParametricProblem class."""
 
 from abc import abstractmethod
 
diff --git a/pina/problem/spatial_problem.py b/pina/problem/spatial_problem.py
@@ -1,4 +1,4 @@
-"""Module for the SpatialProblem class"""
+"""Module for the SpatialProblem class."""
 
 from abc import abstractmethod
 
diff --git a/pina/problem/time_dependent_problem.py b/pina/problem/time_dependent_problem.py
@@ -1,4 +1,4 @@
-"""Module for the TimeDependentProblem class"""
+"""Module for the TimeDependentProblem class."""
 
 from abc import abstractmethod
 
diff --git a/pina/solver/physic_informed_solver/__init__.py b/pina/solver/physic_informed_solver/__init__.py
@@ -1,4 +1,4 @@
-"""Module for the physics-informed solvers."""
+"""Module for the Physics-Informed solvers."""
 
 __all__ = [
     "PINNInterface",
diff --git a/pina/solver/physic_informed_solver/pinn_interface.py b/pina/solver/physic_informed_solver/pinn_interface.py
@@ -1,4 +1,4 @@
-"""Module for the Physics Informed Neural Network Interface."""
+"""Module for the Physics-Informed Neural Network Interface."""
 
 from abc import ABCMeta, abstractmethod
 import torch
diff --git a/pina/solver/physic_informed_solver/self_adaptive_pinn.py b/pina/solver/physic_informed_solver/self_adaptive_pinn.py
@@ -1,4 +1,4 @@
-"""Module for Self-Adaptive PINN."""
+"""Module for the Self-Adaptive PINN solver."""
 
 from copy import deepcopy
 import torch
diff --git a/pina/solver/reduced_order_model.py b/pina/solver/reduced_order_model.py
diff --git a/pina/solver/supervised.py b/pina/solver/supervised.py
diff --git a/pina/solvers/__init__.py b/pina/solvers/__init__.py
diff --git a/pina/solvers/pinns/__init__.py b/pina/solvers/pinns/__init__.py

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-"""Module for adaptive functions."""`
	`1`	`+"""Module for the Adaptive Functions."""`
`2`	`2`
`3`	`3`	`import torch`
`4`	`4`	`from ..utils import check_consistency`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-"""Module for adaptive functions."""`
	`1`	`+"""Module for the Adaptive Function interface."""`
`2`	`2`
`3`	`3`	`from abc import ABCMeta`
`4`	`4`	`import torch`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+"""Module for the Pina Callbacks."""`
	`2`	`+`
`1`	`3`	`__all__ = [`
`2`	`4`	`"SwitchOptimizer",`
`3`	`5`	`"R3Refinement",`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-"""PINA Callbacks Implementations"""`
	`1`	`+"""Module for the R3Refinement callback."""`
`2`	`2`
`3`	`3`	`import importlib.metadata`
`4`	`4`	`import torch`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-"""PINA Callbacks Implementations"""`
	`1`	`+"""Module for the LinearWeightUpdate callback."""`
`2`	`2`
`3`	`3`	`import warnings`
`4`	`4`	`from lightning.pytorch.callbacks import Callback`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-"""PINA Callbacks Implementations"""`
	`1`	`+"""Module for the SwitchOptimizer callback."""`
`2`	`2`
`3`	`3`	`from lightning.pytorch.callbacks import Callback`
`4`	`4`	`from ..optim import TorchOptimizer`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-"""PINA Callbacks Implementations"""`
	`1`	`+"""Module for the Processing Callbacks."""`
`2`	`2`
`3`	`3`	`import copy`
`4`	`4`	`import torch`