update rst

Author: dario-coscia

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>
-    KernelNeuralOperator <models/base_no.rst>
-    FeedForward <models/fnn.rst>
-    MultiFeedForward <models/multifeedforward.rst>
-    ResidualFeedForward <models/fnn_residual.rst>
-    Spline <models/spline.rst>
-    DeepONet <models/deeponet.rst>
-    MIONet <models/mionet.rst>
-    FourierIntegralKernel <models/fourier_kernel.rst>
-    FNO <models/fno.rst>
-    AveragingNeuralOperator <models/avno.rst>
-    LowRankNeuralOperator <models/lno.rst>
-
-Layers
+    FeedForward <model/feed_forward.rst>
+    MultiFeedForward <model/multi_feed_forward.rst>
+    ResidualFeedForward <model/residual_feed_forward.rst>
+    Spline <model/spline.rst>
+    DeepONet <model/deeponet.rst>
+    MIONet <model/mionet.rst>
+    KernelNeuralOperator <model/kernel_neural_operator.rst>
+    FourierIntegralKernel <model/fourier_integral_kernel.rst>
+    FNO <model/fourier_neural_operator.rst>
+    AveragingNeuralOperator <model/average_neural_operator.rst>
+    LowRankNeuralOperator <model/low_rank_neural_operator.rst>
+    GraphNeuralOperator <model/>
+
+Blocks
 -------------
 
 .. toctree::
     :titlesonly:
 
-    Residual layer <layers/residual.rst>
-    EnhancedLinear layer <layers/enhanced_linear.rst>
-    Spectral convolution <layers/spectral.rst>
-    Fourier layers <layers/fourier.rst>
-    Averaging layer <layers/avno_layer.rst>
-    Low Rank layer <layers/lowrank_layer.rst>
-    Continuous convolution <layers/convolution.rst>
-    Proper Orthogonal Decomposition <layers/pod.rst>
-    Periodic Boundary Condition Embedding <layers/pbc_embedding.rst>
-    Fourier Feature Embedding <layers/fourier_embedding.rst>
-    Radial Basis Function Interpolation <layers/rbf_layer.rst>
+    Residual Block <model/block/residual.rst>
+    EnhancedLinear Block <model/block/enhanced_linear.rst>
+    Spectral Convolution Block <model/block/spectral.rst>
+    Fourier Block <model/block/fourier_block.rst>
+    Averaging Block <model/block/average_neural_operator_block.rst>
+    Low Rank Block <model/block/low_rank_block.rst>
+    Continuous Convolution Block <model/block/convolution.rst>
+
+
+Reduction and Embeddings
+--------------------------
+
+.. 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,12 +201,14 @@ Callback
     Refinment callback <callback/adaptive_refinment_callback.rst>
     Weighting callback <callback/linear_weight_update_callback.rst>
 
-Metrics and Losses
---------------------
+Losses and Weightings
+---------------------
 
 .. toctree::
     :titlesonly:
 
     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: