update rst

docs/source/_rst/_code.rst

@@ -18,12 +18,14 @@ The pipeline to solve differential equations with PINA follows just five steps:
     5. Train the model with the PINA :doc:`Trainer <solvers/solver_interface>`, enhance the train with `Callback`_
 
 
-Training and Datamodules
+Trainer, Dataset and Datamodule
--------------------------
+--------------------------------
 .. toctree::
     :titlesonly:
 
     Trainer <trainer.rst>
+    Dataset <data/dataset.rst>
+    DataModule <data/data_module.rst>
 
 Data Types
 ------------
@@ -71,36 +73,45 @@ Models
     :titlesonly:
     :maxdepth: 5
 
-    Network <models/network.rst>
+    FeedForward <model/feed_forward.rst>
-    KernelNeuralOperator <models/base_no.rst>
+    MultiFeedForward <model/multi_feed_forward.rst>
-    FeedForward <models/fnn.rst>
+    ResidualFeedForward <model/residual_feed_forward.rst>
-    MultiFeedForward <models/multifeedforward.rst>
+    Spline <model/spline.rst>
-    ResidualFeedForward <models/fnn_residual.rst>
+    DeepONet <model/deeponet.rst>
-    Spline <models/spline.rst>
+    MIONet <model/mionet.rst>
-    DeepONet <models/deeponet.rst>
+    KernelNeuralOperator <model/kernel_neural_operator.rst>
-    MIONet <models/mionet.rst>
+    FourierIntegralKernel <model/fourier_integral_kernel.rst>
-    FourierIntegralKernel <models/fourier_kernel.rst>
+    FNO <model/fourier_neural_operator.rst>
-    FNO <models/fno.rst>
+    AveragingNeuralOperator <model/average_neural_operator.rst>
-    AveragingNeuralOperator <models/avno.rst>
+    LowRankNeuralOperator <model/low_rank_neural_operator.rst>
-    LowRankNeuralOperator <models/lno.rst>
+    GraphNeuralOperator <model/>
 
-Layers
+Blocks
 -------------
 
 .. toctree::
     :titlesonly:
 
-    Residual layer <layers/residual.rst>
+    Residual Block <model/block/residual.rst>
-    EnhancedLinear layer <layers/enhanced_linear.rst>
+    EnhancedLinear Block <model/block/enhanced_linear.rst>
-    Spectral convolution <layers/spectral.rst>
+    Spectral Convolution Block <model/block/spectral.rst>
-    Fourier layers <layers/fourier.rst>
+    Fourier Block <model/block/fourier_block.rst>
-    Averaging layer <layers/avno_layer.rst>
+    Averaging Block <model/block/average_neural_operator_block.rst>
-    Low Rank layer <layers/lowrank_layer.rst>
+    Low Rank Block <model/block/low_rank_block.rst>
-    Continuous convolution <layers/convolution.rst>
+    Continuous Convolution Block <model/block/convolution.rst>
-    Proper Orthogonal Decomposition <layers/pod.rst>
+
-    Periodic Boundary Condition Embedding <layers/pbc_embedding.rst>
+
-    Fourier Feature Embedding <layers/fourier_embedding.rst>
+Reduction and Embeddings
-    Radial Basis Function Interpolation <layers/rbf_layer.rst>
+--------------------------
+
+.. toctree::
+    :titlesonly:
+
+    Proper Orthogonal Decomposition <model/block/pod_block.rst>
+    Periodic Boundary Condition Embedding <model/block/pbc_embedding.rst>
+    Fourier Feature Embedding <model/block/fourier_embedding.rst>
+    Radial Basis Function Interpolation <model/block/rbf_block.rst>
+
 
 Adaptive Activation Functions
 -------------------------------
@@ -123,7 +134,19 @@ Adaptive Activation Functions
     Adaptive Exp <adaptive_function/AdaptiveExp.rst>
 
 
-Equations and Operators
+Equations
+-------------
+
+.. toctree::
+    :titlesonly:
+
+    EquationInterface <equation.equation_interface.rst>
+    Equation <equation.equation.rst>
+    SystemEquation <equation.system_equation.rst>
+    Equation Factory <equation.equation_factory.rst>
+
+
+Differential Operators
 -------------------------
 
 .. toctree::
@@ -133,7 +156,7 @@ Equations and Operators
     Differential Operators <operators.rst>
 
 
-Problem
+Problems
 --------------
 
 .. toctree::
@@ -144,8 +167,8 @@ Problem
     TimeDependentProblem <problem/timedepproblem.rst>
     ParametricProblem <problem/parametricproblem.rst>
 
-Domains
+Geometrical Domains
------------------
+---------------------
 
 .. toctree::
     :titlesonly:
@@ -155,8 +178,8 @@ Domains
     EllipsoidDomain <domain/ellipsoid.rst>
     SimplexDomain <domain/simplex.rst>
 
-domain set operations
+Domain Operations
-------------------------
+------------------
 
 .. toctree::
     :titlesonly:
@@ -178,8 +201,8 @@ Callback
     Refinment callback <callback/adaptive_refinment_callback.rst>
     Weighting callback <callback/linear_weight_update_callback.rst>
 
-Metrics and Losses
+Losses and Weightings
---------------------
+---------------------
 
 .. toctree::
     :titlesonly:
@@ -187,3 +210,5 @@ Metrics and Losses
     LossInterface <loss/loss_interface.rst>
     LpLoss <loss/lploss.rst>
     PowerLoss <loss/powerloss.rst>
+    WeightingInterface <loss/weighting_interface.rst>
+    ScalarWeighting <loss/scalar_weighting.rst>

docs/source/_rst/data/data_module.rst

@@ -1,7 +1,15 @@
-PinaDataModule
+DataModule
 ======================
 .. currentmodule:: pina.data.data_module
 
+.. autoclass:: Collator
+    :members:
+    :show-inheritance:
+
 .. autoclass:: PinaDataModule
+    :members:
+    :show-inheritance:
+
+.. autoclass:: PinaSampler
     :members:
     :show-inheritance:

docs/source/_rst/data/dataset.rst

@@ -1,7 +1,19 @@
-PinaDataset
+Dataset
 ======================
 .. currentmodule:: pina.data.dataset
 
 .. autoclass:: PinaDataset
+    :members:
+    :show-inheritance:
+
+.. autoclass:: PinaDatasetFactory
+    :members:
+    :show-inheritance:
+
+.. autoclass:: PinaGraphDataset
+    :members:
+    :show-inheritance:
+
+.. autoclass:: PinaTensorDataset
     :members:
     :show-inheritance:

docs/source/_rst/equation/equation.rst

@@ -0,0 +1,7 @@
+Equation
+==========
+
+.. currentmodule:: pina.equation.equation
+.. autoclass:: Equation
+   :members:
+   :show-inheritance:

docs/source/_rst/equation/equation_factory.rst

@@ -0,0 +1,19 @@
+Equation Factory
+==================
+
+.. currentmodule:: pina.equation.equation_factory
+.. autoclass:: FixedValue
+   :members:
+   :show-inheritance:
+
+.. autoclass:: FixedGradient
+   :members:
+   :show-inheritance:
+
+.. autoclass:: FixedFlux
+   :members:
+   :show-inheritance:
+
+.. autoclass:: Laplace
+   :members:
+   :show-inheritance:

docs/source/_rst/equation/equation_interface.rst

@@ -0,0 +1,7 @@
+Equation Interface
+====================
+
+.. currentmodule:: pina.equation.equation_interface
+.. autoclass:: EquationInterface
+   :members:
+   :show-inheritance:

docs/source/_rst/equation/system_equation.rst

@@ -0,0 +1,7 @@
+System Equation
+=================
+
+.. currentmodule:: pina.equation.system_equation
+.. autoclass:: SystemEquation
+   :members:
+   :show-inheritance:

docs/source/_rst/equations.rst

@@ -1,42 +0,0 @@
-Equations
-==========
-Equations are used in PINA to make easy the training. During problem definition
-each `equation` passed to a `Condition` object must be an `Equation` or `SystemEquation`.
-An `Equation` is simply a wrapper over callable python functions, while `SystemEquation` is
-a wrapper arounf a list of callable python functions. We provide a wide rage of already implemented
-equations to ease the code writing, such as `FixedValue`, `Laplace`, and many more.
-
-
-.. currentmodule:: pina.equation.equation_interface
-.. autoclass:: EquationInterface
-   :members:
-   :show-inheritance:
-
-.. currentmodule:: pina.equation.equation
-.. autoclass:: Equation
-   :members:
-   :show-inheritance:
-
-
-.. currentmodule:: pina.equation.system_equation
-.. autoclass:: SystemEquation
-   :members:
-   :show-inheritance:
-
-
-.. currentmodule:: pina.equation.equation_factory
-.. autoclass:: FixedValue
-   :members:
-   :show-inheritance:
-
-.. autoclass:: FixedGradient
-   :members:
-   :show-inheritance:
-
-.. autoclass:: FixedFlux
-   :members:
-   :show-inheritance:
-
-.. autoclass:: Laplace
-   :members:
-   :show-inheritance:

docs/source/_rst/layers/avno_layer.rst

@@ -1,8 +0,0 @@
-Averaging layers
-====================
-.. currentmodule:: pina.model.layers.avno_layer
-
-.. autoclass:: AVNOBlock
-    :members:
-    :show-inheritance:
-    :noindex:

docs/source/_rst/layers/convolution.rst

@@ -1,8 +0,0 @@
-Continuous convolution
-=========================
-.. currentmodule:: pina.model.layers.convolution_2d
-
-.. autoclass:: ContinuousConvBlock
-    :members:
-    :show-inheritance:
-    :noindex:

docs/source/_rst/layers/enhanced_linear.rst

@@ -1,8 +0,0 @@
-EnhancedLinear
-=================
-.. currentmodule:: pina.model.layers.residual
-
-.. autoclass:: EnhancedLinear
-   :members:
-   :show-inheritance:
-   :noindex:

docs/source/_rst/layers/lowrank_layer.rst

@@ -1,8 +0,0 @@
-Low Rank layer
-====================
-.. currentmodule:: pina.model.layers.lowrank_layer
-
-.. autoclass:: LowRankBlock
-    :members:
-    :show-inheritance:
-    :noindex:

docs/source/_rst/layers/pod.rst

@@ -1,7 +0,0 @@
-PODBlock
-======================
-.. currentmodule:: pina.model.layers.pod
-    
-.. autoclass:: PODBlock
-    :members:
-    :show-inheritance:

docs/source/_rst/layers/rbf_layer.rst

@@ -1,7 +0,0 @@
-RBFBlock
-======================
-.. currentmodule:: pina.model.layers.rbf_layer
-
-.. autoclass:: RBFBlock
-    :members:
-    :show-inheritance:

docs/source/_rst/loss/loss_interface.rst

@@ -1,8 +1,8 @@
-LpLoss
+LossInterface
 ===============
-.. currentmodule:: pina.loss
+.. currentmodule:: pina.loss.loss_interface
 
-.. automodule:: pina.loss
+.. automodule:: pina.loss.loss_interface
 
 .. autoclass:: LossInterface
    :members:

docs/source/_rst/loss/lploss.rst

@@ -1,8 +1,8 @@
 LpLoss
 ===============
-.. currentmodule:: pina.loss
+.. currentmodule:: pina.loss.lp_loss
 
-.. automodule:: pina.loss
+.. automodule:: pina.loss.lp_loss
    :no-index:
 
 .. autoclass:: LpLoss

docs/source/_rst/loss/powerloss.rst

@@ -1,8 +1,8 @@
 PowerLoss
 ====================
-.. currentmodule:: pina.loss
+.. currentmodule:: pina.loss.power_loss
 
-.. automodule:: pina.loss
+.. automodule:: pina.loss.power_loss
    :no-index:
 
 .. autoclass:: PowerLoss

docs/source/_rst/loss/scalar_weighting.rst

@@ -0,0 +1,9 @@
+ScalarWeighting
+===================
+.. currentmodule:: pina.loss.scalar_weighting
+
+.. automodule:: pina.loss.scalar_weighting
+
+.. autoclass:: ScalarWeighting
+   :members:
+   :show-inheritance:

docs/source/_rst/loss/weighting_interface.rst

@@ -0,0 +1,9 @@
+WeightingInterface
+===================
+.. currentmodule:: pina.loss.weighting_interface
+
+.. automodule:: pina.loss.weighting_interface
+
+.. autoclass:: WeightingInterface
+   :members:
+   :show-inheritance:

docs/source/_rst/model/average_neural_operator.rst

@@ -1,6 +1,6 @@
 Averaging Neural Operator
 ==============================
-.. currentmodule:: pina.model.avno
+.. currentmodule:: pina.model.average_neural_operator
 
 .. autoclass:: AveragingNeuralOperator
    :members:

docs/source/_rst/model/block/average_neural_operator_block.py.rst

@@ -0,0 +1,8 @@
+Averaging Neural Operator Block
+==================================
+.. currentmodule:: pina.model.block.average_neural_operator_block
+
+.. autoclass:: AVNOBlock
+    :members:
+    :show-inheritance:
+    :noindex:

docs/source/_rst/model/block/convolution.rst

@@ -0,0 +1,8 @@
+Continuous Convolution Block
+===============================
+.. currentmodule:: pina.model.block.convolution_2d
+
+.. autoclass:: ContinuousConvBlock
+    :members:
+    :show-inheritance:
+    :noindex:

docs/source/_rst/model/block/enhanced_linear.rst

@@ -0,0 +1,8 @@
+EnhancedLinear Block
+=====================
+.. currentmodule:: pina.model.block.residual
+
+.. autoclass:: EnhancedLinear
+   :members:
+   :show-inheritance:
+   :noindex:

docs/source/_rst/model/block/fourier_block.rst

@@ -1,6 +1,6 @@
-Fourier Layers
+Fourier Neural Operator Block
-===================
+======================================
-.. currentmodule:: pina.model.layers.fourier
+.. currentmodule:: pina.model.block.fourier_block
 
 
 .. autoclass:: FourierBlock1D

docs/source/_rst/model/block/fourier_embedding.rst

@@ -1,6 +1,6 @@
 Fourier Feature Embedding
 =======================================
-.. currentmodule:: pina.model.layers.embedding
+.. currentmodule:: pina.model.block.embedding
     
 .. autoclass:: FourierFeatureEmbedding
     :members:

docs/source/_rst/model/block/gno_block.rst

@@ -0,0 +1,8 @@
+Graph Neural Operator Block
+===============================
+.. currentmodule:: pina.model.block.gno_block
+
+.. autoclass:: GNOBlock
+    :members:
+    :show-inheritance:
+    :noindex:

docs/source/_rst/model/block/low_rank_block.rst

@@ -0,0 +1,8 @@
+Low Rank Neural Operator Block
+=================================
+.. currentmodule:: pina.model.block.low_rank_block
+
+.. autoclass:: LowRankBlock
+    :members:
+    :show-inheritance:
+    :noindex:

docs/source/_rst/model/block/orthogonal.rst

@@ -1,6 +1,6 @@
-OrthogonalBlock
+Orthogonal Block
 ======================
-.. currentmodule:: pina.model.layers.orthogonal
+.. currentmodule:: pina.model.block.orthogonal
     
 .. autoclass:: OrthogonalBlock
     :members:

docs/source/_rst/model/block/pbc_embedding.rst

@@ -1,6 +1,6 @@
 Periodic Boundary Condition Embedding
 =======================================
-.. currentmodule:: pina.model.layers.embedding
+.. currentmodule:: pina.model.block.embedding
     
 .. autoclass:: PeriodicBoundaryEmbedding
     :members:

docs/source/_rst/model/block/pod_block.rst

@@ -0,0 +1,7 @@
+Proper Orthogonal Decomposition Block
+============================================
+.. currentmodule:: pina.model.block.pod_block
+    
+.. autoclass:: PODBlock
+    :members:
+    :show-inheritance:

docs/source/_rst/model/block/rbf_block.rst

@@ -0,0 +1,7 @@
+Radias Basis Function Block
+=============================
+.. currentmodule:: pina.model.block.rbf_block
+
+.. autoclass:: RBFBlock
+    :members:
+    :show-inheritance:

docs/source/_rst/model/block/residual.rst

@@ -1,6 +1,6 @@
-Residual layer
+Residual Block
 ===================
-.. currentmodule:: pina.model.layers.residual
+.. currentmodule:: pina.model.block.residual
 
 .. autoclass:: ResidualBlock
     :members:

docs/source/_rst/model/block/spectral.rst

@@ -1,6 +1,6 @@
-Spectral Convolution
+Spectral Convolution Block
-======================
+============================
-.. currentmodule:: pina.model.layers.spectral
+.. currentmodule:: pina.model.block.spectral
     
 .. autoclass:: SpectralConvBlock1D
     :members:

docs/source/_rst/model/fourier_neural_operator.rst

@@ -1,6 +1,6 @@
 FNO
 ===========
-.. currentmodule:: pina.model.fno
+.. currentmodule:: pina.model.fourier_neural_operator
 
 .. autoclass:: FNO
    :members:

docs/source/_rst/model/graph_neural_operator.rst

@@ -0,0 +1,7 @@
+GraphNeuralOperator
+=======================
+.. currentmodule:: pina.model.graph_neural_operator
+
+.. autoclass:: GraphNeuralOperator
+   :members:
+   :show-inheritance:

docs/source/_rst/model/kernel_neural_operator.rst

@@ -1,6 +1,6 @@
 KernelNeuralOperator
 =======================
-.. currentmodule:: pina.model.base_no
+.. currentmodule:: pina.model.kernel_neural_operator
 
 .. autoclass:: KernelNeuralOperator
    :members:

docs/source/_rst/model/low_rank_neural_operator.rst

@@ -1,6 +1,6 @@
 Low Rank Neural Operator
 ==============================
-.. currentmodule:: pina.model.lno
+.. currentmodule:: pina.model.low_rank_neural_operator
 
 .. autoclass:: LowRankNeuralOperator
    :members:

docs/source/_rst/models/network.rst

@@ -1,8 +0,0 @@
-Network
-================
-
-.. automodule:: pina.model.network
-
-.. autoclass:: Network
-    :members:
-    :show-inheritance: