standardize module docstring

pina/model/__init__.py

@@ -1,6 +1,4 @@
-"""
-Module for the Neural model classes.
-"""
+"""Module for the Neural model classes."""
 
 __all__ = [
     "FeedForward",

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",

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

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

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

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

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
 

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

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

pina/model/block/stride.py

@@ -1,6 +1,4 @@
-"""
-Module for the Stride class.
-"""
+"""Module for the Stride class."""
 
 import torch
 

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
 

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

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

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

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

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

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
 

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

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