diff --git a/pina/__init__.py b/pina/__init__.py index f862414..2cbe7f3 100644 --- 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 index 0937392..d53c5f3 100644 --- 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 index a88fe80..e6f86a5 100644 --- 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 index 365caf6..6a9707f 100644 --- 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 index ce00ac9..6df3338 100644 --- 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 index 4cf5147..421071a 100644 --- 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 index 9b2932f..84ac0cf 100644 --- 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 index da5431b..ae25ca1 100644 --- 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 index 6b77b3d..fb2770a 100644 --- 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 index 79c5b9c..244c726 100644 --- 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 index 76c5021..69f8782 100644 --- 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 index 50c4efe..db7296f 100644 --- 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 index ce339be..4e57811 100644 --- 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 index 5ad4d36..05a377e 100644 --- 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 index 8610283..9869c1e 100644 --- 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 index 783282d..4ecd0ae 100644 --- 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 index 92cffff..ee2b507 100644 --- 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 index ef9b1e3..a803a88 100644 --- 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 index 103c144..70e1000 100644 --- 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 index 9b94de7..798cdb6 100644 --- 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 index ab18fa1..07ab742 100644 --- 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 index bb0b9b5..f1cc747 100644 --- 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 index 9ed4c01..762820a 100644 --- 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 index 1c226a2..f636899 100644 --- 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 index 4e0e287..728c9f7 100644 --- 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 index 6790b69..f535a5b 100644 --- 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 index 0853052..1edbf4f 100644 --- 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 index 2df89d2..8b8cb2f 100644 --- 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 index 6431407..606dde7 100644 --- 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 index b657689..c40135b 100644 --- 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 index e681567..dfd9968 100644 --- 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 index ab81088..1e44ec1 100644 --- 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 index 69649d8..2983c84 100644 --- 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 index e6741c8..6008034 100644 --- 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 index dd27082..0bab4f0 100644 --- 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 index 213577f..f109ce0 100644 --- 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 index 6330298..aae915a 100644 --- 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 index eb6e91e..2a26faf 100644 --- 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 index 40a7e43..88e0baf 100644 --- 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 index 6c1c1ae..678f4e3 100644 --- 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 index af9bb60..5dcc764 100644 --- 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 index 5433919..f93d126 100644 --- 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 index eb026fb..960c5ed 100644 --- 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 index 4e16657..e3cb790 100644 --- 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 index 2faa66a..aeef265 100644 --- 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 index 8629567..f2f149c 100644 --- 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 index 3b7eeff..c22c793 100644 --- 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 index a995d44..cb2fb5e 100644 --- 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 index d177239..21afe86 100644 --- 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 index 343626a..231d014 100644 --- 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 index b54f5a8..e361074 100644 --- 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 index 68a14b6..608e316 100644 --- 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 index df88a3e..ea2ad7d 100644 --- 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 index 0bc664e..f0fb8eb 100644 --- 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 index d4ddeb0..09e152f 100644 --- 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 index 97c2b5c..a6310d5 100644 --- 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 index 7be066a..949cb01 100644 --- a/pina/solver/reduced_order_model.py +++ b/pina/solver/reduced_order_model.py @@ -1,4 +1,4 @@ -"""Module for ReducedOrderModelSolver""" +"""Module for the Reduced Order Model solver""" import torch from .supervised import SupervisedSolver diff --git a/pina/solver/supervised.py b/pina/solver/supervised.py index 5cfa9b1..9a5a5f4 100644 --- a/pina/solver/supervised.py +++ b/pina/solver/supervised.py @@ -1,4 +1,4 @@ -"""Module for the Supervised Solver.""" +"""Module for the Supervised solver.""" import torch from torch.nn.modules.loss import _Loss diff --git a/pina/solvers/__init__.py b/pina/solvers/__init__.py index aaa44b9..366b1b7 100644 --- a/pina/solvers/__init__.py +++ b/pina/solvers/__init__.py @@ -1,6 +1,4 @@ -""" -Old module for solvers. Deprecated in 0.2.0 . -""" +"""Old module for solvers. Deprecated in 0.2.0 .""" import warnings diff --git a/pina/solvers/pinns/__init__.py b/pina/solvers/pinns/__init__.py index c9012bb..362cd62 100644 --- a/pina/solvers/pinns/__init__.py +++ b/pina/solvers/pinns/__init__.py @@ -1,6 +1,4 @@ -""" -Old module for the PINNs solver. Deprecated in 0.2.0. -""" +"""Old module for the PINNs solver. Deprecated in 0.2.0.""" import warnings