updating rst

Author: dario-coscia

docs/source/_rst/_code.rst

@@ -14,8 +14,8 @@ The pipeline to solve differential equations with PINA follows just five steps:
     1. Define the `Problem`_ the user aim to solve
     2. Generate data using built in `Domains`_, or load high level simulation results as :doc:`LabelTensor <label_tensor>`
     3. Choose or build one or more `Models`_ to solve the problem
-    4. Choose a solver across PINA available `Solvers`_, or build one using the :doc:`SolverInterface <solvers/solver_interface>`
-    5. Train the model with the PINA :doc:`Trainer <solvers/solver_interface>`, enhance the train with `Callback`_
+    4. Choose a solver across PINA available `Solvers`_, or build one using the :doc:`SolverInterface <solver/solver_interface>`
+    5. Train the model with the PINA :doc:`Trainer <solver/solver_interface>`, enhance the train with `Callback`_
 
 
 Trainer, Dataset and Datamodule
@@ -33,6 +33,18 @@ Data Types
     :titlesonly:
 
     LabelTensor <label_tensor.rst>
+    Graph <graph/graph.rst>
+
+
+Graphs Structures
+------------------
+.. toctree::
+    :titlesonly:
+
+    Graph <graph/graph.rst>
+    GraphBuilder <graph/graph_builder.rst>
+    RadiusGraph <graph/radius_graph.rst>
+    KNNGraph <graph/knn_graph.rst>
 
 
 Conditions
@@ -53,17 +65,19 @@ Solvers
 .. toctree::
     :titlesonly:
 
-    SolverInterface <solvers/solver_interface.rst>
-    PINNInterface <solvers/basepinn.rst>
-    PINN <solvers/pinn.rst>
-    GPINN <solvers/gpinn.rst>
-    CausalPINN <solvers/causalpinn.rst>
-    CompetitivePINN <solvers/competitivepinn.rst>
-    SAPINN <solvers/sapinn.rst>
-    RBAPINN <solvers/rba_pinn.rst>
-    Supervised solver <solvers/supervised.rst>
-    ReducedOrderModelSolver <solvers/rom.rst>
-    GAROM <solvers/garom.rst>
+    SolverInterface <solver/solver_interface.rst>
+    SingleSolverInterface <solver/single_solver_interface.rst>
+    MultiSolverInterface <solver/multi_solver_interface.rst>
+    PINNInterface <solver/physic_informed_solver/pinn_interface.rst>
+    PINN <solver/physic_informed_solver/pinn.rst>
+    GradientPINN <solver/physic_informed_solver/gradient_pinn.rst>
+    CausalPINN <solver/physic_informed_solver/causal_pinn.rst>
+    CompetitivePINN <solver/physic_informed_solver/competitive_pinn.rst>
+    SelfAdaptivePINN <solver/physic_informed_solver/self_adaptive_pinn.rst>
+    RBAPINN <solver/physic_informed_solver/rba_pinn.rst>
+    SupervisedSolver <solver/supervised.rst>
+    ReducedOrderModelSolver <solver/reduced_order_model.rst>
+    GAROM <solver/garom.rst>
 
 
 Models
@@ -112,6 +126,17 @@ Reduction and Embeddings
     Fourier Feature Embedding <model/block/fourier_embedding.rst>
     Radial Basis Function Interpolation <model/block/rbf_block.rst>
 
+Optimizers and Schedulers
+--------------------------
+
+.. toctree::
+    :titlesonly:
+
+    Optimizer <optim/optimizer_interface.rst>
+    Scheduler <optim/scheduler_interface.rst>
+    TorchOptimizer <optim/torch_optimizer.rst>
+    TorchScheduler <optim/torch_scheduler.rst>
+    
 
 Adaptive Activation Functions
 -------------------------------
@@ -134,8 +159,8 @@ Adaptive Activation Functions
     Adaptive Exp <adaptive_function/AdaptiveExp.rst>
 
 
-Equations
--------------
+Equations and Differential Operators
+---------------------------------------
 
 .. toctree::
     :titlesonly:
@@ -144,28 +169,35 @@ Equations
     Equation <equation.equation.rst>
     SystemEquation <equation.system_equation.rst>
     Equation Factory <equation.equation_factory.rst>
+    Differential Operators <operator.rst>
 
 
-Differential Operators
--------------------------
+Problems
+--------------
 
 .. toctree::
     :titlesonly:
 
-    Equations <equations.rst>
-    Differential Operators <operators.rst>
-
+    AbstractProblem <problem/abstract_problem.rst>
+    InverseProblem <problem/inverse_problem.rst>
+    ParametricProblem <problem/parametric_problem.rst>
+    SpatialProblem <problem/spatial_problem.rst>
+    TimeDependentProblem <problem/time_dependent_problem.rst>
 
-Problems
+Problems Zoo
 --------------
 
 .. toctree::
     :titlesonly:
 
-    AbstractProblem <problem/abstractproblem.rst>
-    SpatialProblem <problem/spatialproblem.rst>
-    TimeDependentProblem <problem/timedepproblem.rst>
-    ParametricProblem <problem/parametricproblem.rst>
+    AdvectionProblem <problem/zoo/advection.rst>
+    AllenCahnProblem <problem/zoo/allen_cahn.rst>
+    DiffusionReactionProblem <problem/zoo/diffusion_reaction.rst>
+    HelmholtzProblem <problem/zoo/helmholtz.rst>
+    InversePoisson2DSquareProblem <problem/zoo/inverse_poisson_2d_square.rst>
+    Poisson2DSquareProblem <problem/zoo/poisson_2d_square.rst>
+    SupervisedProblem <problem/zoo/supervised_problem.rst>
+
 
 Geometrical Domains
 ---------------------

docs/source/_rst/graph/graph.rst

@@ -0,0 +1,9 @@
+Graph
+===========
+.. currentmodule:: pina.graph
+
+
+.. autoclass:: Graph
+   :members:
+   :private-members:
+   :show-inheritance:

docs/source/_rst/graph/graph_builder.rst

@@ -0,0 +1,9 @@
+GraphBuilder
+==============
+.. currentmodule:: pina.graph
+
+
+.. autoclass:: GraphBuilder
+   :members:
+   :private-members:
+   :show-inheritance:

docs/source/_rst/graph/knn_graph.rst

@@ -0,0 +1,9 @@
+KNNGraph
+===========
+.. currentmodule:: pina.graph
+
+
+.. autoclass:: KNNGraph
+   :members:
+   :private-members:
+   :show-inheritance:

docs/source/_rst/graph/radius_graph.rst

@@ -0,0 +1,9 @@
+RadiusGraph
+=============
+.. currentmodule:: pina.graph
+
+
+.. autoclass:: RadiusGraph
+   :members:
+   :private-members:
+   :show-inheritance:

docs/source/_rst/operator.rst

@@ -0,0 +1,8 @@
+Operators
+===========
+
+.. currentmodule:: pina.operator
+
+.. automodule:: pina.operator
+    :members:
+    :show-inheritance:

docs/source/_rst/operators.rst

@@ -0,0 +1,7 @@
+Optimizer
+============
+.. currentmodule:: pina.optim.optimizer_interface
+
+.. autoclass:: Optimizer
+   :members:
+   :show-inheritance:

docs/source/_rst/optim/optimizer_interface.rst

@@ -0,0 +1,7 @@
+Scheduler
+=============
+.. currentmodule:: pina.optim.scheduler_interface
+
+.. autoclass:: Scheduler
+   :members:
+   :show-inheritance:

docs/source/_rst/optim/scheduler_interface.rst

@@ -0,0 +1,7 @@
+TorchOptimizer
+===============
+.. currentmodule:: pina.optim.torch_optimizer
+
+.. autoclass:: TorchOptimizer
+   :members:
+   :show-inheritance: