Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 24 additions & 24 deletions docs/source/_rst/_code.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ The pipeline to solve differential equations with PINA follows just five steps:
1. Define the `Problems`_ the user aim to solve
2. Generate data using built in `Geometrical 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 <solver/solver_interface>`
5. Train the model with the PINA :doc:`Trainer <solver/solver_interface>`, enhance the train with `Callbacks`_
4. Choose a solver across PINA available `Solvers and Mixins`_, or build one using the :doc:`SolverInterface <solver/solver_interface>`
5. Train the model with the PINA :doc:`Trainer <trainer>`, enhance the train with `Callbacks`_


Trainer, Data Loader and Data Module
Expand Down Expand Up @@ -74,32 +74,32 @@ Batch and Data Managers
Graph Data Manager <data/manager/graph_data_manager.rst>
Tensor Data Manager <data/manager/tensor_data_manager.rst>

Solvers
--------------
Solvers and Mixins
------------------------

.. toctree::
:titlesonly:

SolverInterface <solver/solver_interface.rst>
SingleSolverInterface <solver/single_solver_interface.rst>
MultiSolverInterface <solver/multi_solver_interface.rst>
SupervisedSolverInterface <solver/supervised_solver/supervised_solver_interface.rst>
DeepEnsembleSolverInterface <solver/ensemble_solver/ensemble_solver_interface.rst>
PINNInterface <solver/physics_informed_solver/pinn_interface.rst>
PINN <solver/physics_informed_solver/pinn.rst>
GradientPINN <solver/physics_informed_solver/gradient_pinn.rst>
CausalPINN <solver/physics_informed_solver/causal_pinn.rst>
CompetitivePINN <solver/physics_informed_solver/competitive_pinn.rst>
SelfAdaptivePINN <solver/physics_informed_solver/self_adaptive_pinn.rst>
RBAPINN <solver/physics_informed_solver/rba_pinn.rst>
DeepEnsemblePINN <solver/ensemble_solver/ensemble_pinn.rst>
SupervisedSolver <solver/supervised_solver/supervised.rst>
DeepEnsembleSupervisedSolver <solver/ensemble_solver/ensemble_supervised.rst>
ReducedOrderModelSolver <solver/supervised_solver/reduced_order_model.rst>
GAROM <solver/garom.rst>
AutoregressiveSolverInterface <solver/autoregressive_solver/autoregressive_solver_interface.rst>
AutoregressiveSolver <solver/autoregressive_solver/autoregressive_solver.rst>

Solver Interface <solver/solver_interface.rst>
Base Solver <solver/base_solver.rst>
Single-Model Solver <solver/single_model_solver.rst>
Multi-Model Solver <solver/multi_model_solver.rst>
Ensemble Solver <solver/ensemble_solver.rst>
Supervised Single-Model Solver <solver/supervised_single_model_solver.rst>
Supervised Ensemble Solver <solver/supervised_ensemble_solver.rst>
Physics-Informed Single-Model Solver <solver/physics_informed_single_model_solver.rst>
Physics-Informed Ensemble Solver <solver/physics_informed_ensemble_solver.rst>
Autoregressive Single-Model Solver <solver/autoregressive_single_model_solver.rst>
Autoregressive Ensemble Solver <solver/autoregressive_ensemble_solver.rst>
Self-Adaptive Physics-Informed Solver <solver/self_adaptive_physics_informed_solver.rst>
Competitive Physics-Informed Solver <solver/competitive_physics_informed_solver.rst>
Single-Model Mixin <solver/mixin/single_model_mixin.rst>
Multi-Model Mixin <solver/mixin/multi_model_mixin.rst>
Ensemble Mixin <solver/mixin/ensemble_mixin.rst>
Condition Aggregator Mixin <solver/mixin/condition_aggregator_mixin.rst>
Manual Optimization Mixin <solver/mixin/manual_optimization_mixin.rst>
Physics-Informed Mixin <solver/mixin/physics_informed_mixin.rst>
Autoregressive Mixin <solver/mixin/autoregressive_mixin.rst>

Models
------------
Expand Down
10 changes: 10 additions & 0 deletions docs/source/_rst/solver/autoregressive_ensemble_solver.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Autoregressive Ensemble Solver
=================================
.. currentmodule:: pina.solver.autoregressive_ensemble_solver

.. automodule:: pina._src.solver.autoregressive_ensemble_solver

.. autoclass:: pina._src.solver.autoregressive_ensemble_solver.AutoregressiveEnsembleSolver
:members:
:show-inheritance:
:noindex:
10 changes: 10 additions & 0 deletions docs/source/_rst/solver/autoregressive_single_model_solver.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Autoregressive Single Model Solver
======================================
.. currentmodule:: pina.solver.autoregressive_single_model_solver

.. automodule:: pina._src.solver.autoregressive_single_model_solver

.. autoclass:: pina._src.solver.autoregressive_single_model_solver.AutoregressiveSingleModelSolver
:members:
:show-inheritance:
:noindex:

This file was deleted.

This file was deleted.

10 changes: 10 additions & 0 deletions docs/source/_rst/solver/base_solver.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Base Solver
=================================
.. currentmodule:: pina.solver.base_solver

.. automodule:: pina._src.solver.base_solver

.. autoclass:: pina._src.solver.base_solver.BaseSolver
:members:
:show-inheritance:
:noindex:
11 changes: 11 additions & 0 deletions docs/source/_rst/solver/competitive_physics_informed_solver.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Competitive Physics-Informed Solver
=======================================

.. currentmodule:: pina.solver.competitive_physics_informed_solver

.. automodule:: pina._src.solver.competitive_physics_informed_solver

.. autoclass:: pina._src.solver.competitive_physics_informed_solver.CompetitivePhysicsInformedSolver
:members:
:show-inheritance:
:noindex:
10 changes: 10 additions & 0 deletions docs/source/_rst/solver/ensemble_solver.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Ensemble Solver
=================================
.. currentmodule:: pina.solver.ensemble_solver

.. automodule:: pina._src.solver.ensemble_solver

.. autoclass:: pina._src.solver.ensemble_solver.EnsembleSolver
:members:
:show-inheritance:
:noindex:
8 changes: 0 additions & 8 deletions docs/source/_rst/solver/ensemble_solver/ensemble_pinn.rst

This file was deleted.

This file was deleted.

This file was deleted.

7 changes: 0 additions & 7 deletions docs/source/_rst/solver/garom.rst

This file was deleted.

11 changes: 11 additions & 0 deletions docs/source/_rst/solver/mixin/autoregressive_mixin.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Autoregressive Mixin
=================================

.. currentmodule:: pina.solver.mixin.autoregressive_mixin

.. automodule:: pina._src.solver.mixin.autoregressive_mixin

.. autoclass:: pina._src.solver.mixin.autoregressive_mixin._AutoregressiveMixin
:members:
:show-inheritance:
:noindex:
11 changes: 11 additions & 0 deletions docs/source/_rst/solver/mixin/condition_aggregator_mixin.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Condition Aggregator Mixin
=================================

.. currentmodule:: pina.solver.mixin.condition_aggregator_mixin

.. automodule:: pina._src.solver.mixin.condition_aggregator_mixin

.. autoclass:: pina._src.solver.mixin.condition_aggregator_mixin._ConditionAggregatorMixin
:members:
:show-inheritance:
:noindex:
11 changes: 11 additions & 0 deletions docs/source/_rst/solver/mixin/ensemble_mixin.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Ensemble Mixin
=================================

.. currentmodule:: pina.solver.mixin.ensemble_mixin

.. automodule:: pina._src.solver.mixin.ensemble_mixin

.. autoclass:: pina._src.solver.mixin.ensemble_mixin._EnsembleMixin
:members:
:show-inheritance:
:noindex:
11 changes: 11 additions & 0 deletions docs/source/_rst/solver/mixin/manual_optimization_mixin.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Manual Optimization Mixin
=================================

.. currentmodule:: pina.solver.mixin.manual_optimization_mixin

.. automodule:: pina._src.solver.mixin.manual_optimization_mixin

.. autoclass:: pina._src.solver.mixin.manual_optimization_mixin._ManualOptimizationMixin
:members:
:show-inheritance:
:noindex:
11 changes: 11 additions & 0 deletions docs/source/_rst/solver/mixin/multi_model_mixin.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Multi-Model Mixin
=================================

.. currentmodule:: pina.solver.mixin.multi_model_mixin

.. automodule:: pina._src.solver.mixin.multi_model_mixin

.. autoclass:: pina._src.solver.mixin.multi_model_mixin._MultiModelMixin
:members:
:show-inheritance:
:noindex:
11 changes: 11 additions & 0 deletions docs/source/_rst/solver/mixin/physics_informed_mixin.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Physics-Informed Mixin
=================================

.. currentmodule:: pina.solver.mixin.physics_informed_mixin

.. automodule:: pina._src.solver.mixin.physics_informed_mixin

.. autoclass:: pina._src.solver.mixin.physics_informed_mixin._PhysicsInformedMixin
:members:
:show-inheritance:
:noindex:
11 changes: 11 additions & 0 deletions docs/source/_rst/solver/mixin/single_model_mixin.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Single-Model Mixin
=================================

.. currentmodule:: pina.solver.mixin.single_model_mixin

.. automodule:: pina._src.solver.mixin.single_model_mixin

.. autoclass:: pina._src.solver.mixin.single_model_mixin._SingleModelMixin
:members:
:show-inheritance:
:noindex:
10 changes: 10 additions & 0 deletions docs/source/_rst/solver/multi_model_solver.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Multi Model Solver
=================================
.. currentmodule:: pina.solver.multi_model_solver

.. automodule:: pina._src.solver.multi_model_solver

.. autoclass:: pina._src.solver.multi_model_solver.MultiModelSolver
:members:
:show-inheritance:
:noindex:
8 changes: 0 additions & 8 deletions docs/source/_rst/solver/multi_solver_interface.rst

This file was deleted.

10 changes: 10 additions & 0 deletions docs/source/_rst/solver/physics_informed_ensemble_solver.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Physics Informed Ensemble Solver
=================================
.. currentmodule:: pina.solver.physics_informed_ensemble_solver

.. automodule:: pina._src.solver.physics_informed_ensemble_solver

.. autoclass:: pina._src.solver.physics_informed_ensemble_solver.PhysicsInformedEnsembleSolver
:members:
:show-inheritance:
:noindex:
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Physics Informed Single Model Solver
=======================================
.. currentmodule:: pina.solver.physics_informed_single_model_solver

.. automodule:: pina._src.solver.physics_informed_single_model_solver

.. autoclass:: pina._src.solver.physics_informed_single_model_solver.PhysicsInformedSingleModelSolver
:members:
:show-inheritance:
:noindex:

This file was deleted.

This file was deleted.

This file was deleted.

7 changes: 0 additions & 7 deletions docs/source/_rst/solver/physics_informed_solver/pinn.rst

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Self-Adaptive Physics-Informed Solver
=======================================

.. currentmodule:: pina.solver.self_adaptive_physics_informed_solver

.. automodule:: pina._src.solver.self_adaptive_physics_informed_solver

.. autoclass:: pina._src.solver.self_adaptive_physics_informed_solver.SelfAdaptivePhysicsInformedSolver
:members:
:show-inheritance:
:noindex:
10 changes: 10 additions & 0 deletions docs/source/_rst/solver/single_model_solver.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Single Model Solver
=================================
.. currentmodule:: pina.solver.single_model_solver

.. automodule:: pina._src.solver.single_model_solver

.. autoclass:: pina._src.solver.single_model_solver.SingleModelSolver
:members:
:show-inheritance:
:noindex:
8 changes: 0 additions & 8 deletions docs/source/_rst/solver/single_solver_interface.rst

This file was deleted.

Loading
Loading