Skip to content

Commit 1dc2a39

Browse files
fix solver + mixin docs and rst
1 parent f375911 commit 1dc2a39

67 files changed

Lines changed: 799 additions & 311 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/source/_rst/_code.rst

Lines changed: 22 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ The pipeline to solve differential equations with PINA follows just five steps:
1414
1. Define the `Problems`_ the user aim to solve
1515
2. Generate data using built in `Geometrical Domains`_, or load high level simulation results as :doc:`LabelTensor <label_tensor>`
1616
3. Choose or build one or more `Models`_ to solve the problem
17-
4. Choose a solver across PINA available `Solvers`_, or build one using the :doc:`SolverInterface <solver/solver_interface>`
18-
5. Train the model with the PINA :doc:`Trainer <solver/solver_interface>`, enhance the train with `Callbacks`_
17+
4. Choose a solver across PINA available `Solvers and Mixins`_, or build one using the :doc:`SolverInterface <solver/solver_interface>`
18+
5. Train the model with the PINA :doc:`Trainer <trainer>`, enhance the train with `Callbacks`_
1919

2020

2121
Trainer, Data Loader and Data Module
@@ -74,32 +74,30 @@ Batch and Data Managers
7474
Graph Data Manager <data/manager/graph_data_manager.rst>
7575
Tensor Data Manager <data/manager/tensor_data_manager.rst>
7676

77-
Solvers
78-
--------------
77+
Solvers and Mixins
78+
------------------------
7979

8080
.. toctree::
8181
:titlesonly:
8282

83-
SolverInterface <solver/solver_interface.rst>
84-
SingleSolverInterface <solver/single_solver_interface.rst>
85-
MultiSolverInterface <solver/multi_solver_interface.rst>
86-
SupervisedSolverInterface <solver/supervised_solver/supervised_solver_interface.rst>
87-
DeepEnsembleSolverInterface <solver/ensemble_solver/ensemble_solver_interface.rst>
88-
PINNInterface <solver/physics_informed_solver/pinn_interface.rst>
89-
PINN <solver/physics_informed_solver/pinn.rst>
90-
GradientPINN <solver/physics_informed_solver/gradient_pinn.rst>
91-
CausalPINN <solver/physics_informed_solver/causal_pinn.rst>
92-
CompetitivePINN <solver/physics_informed_solver/competitive_pinn.rst>
93-
SelfAdaptivePINN <solver/physics_informed_solver/self_adaptive_pinn.rst>
94-
RBAPINN <solver/physics_informed_solver/rba_pinn.rst>
95-
DeepEnsemblePINN <solver/ensemble_solver/ensemble_pinn.rst>
96-
SupervisedSolver <solver/supervised_solver/supervised.rst>
97-
DeepEnsembleSupervisedSolver <solver/ensemble_solver/ensemble_supervised.rst>
98-
ReducedOrderModelSolver <solver/supervised_solver/reduced_order_model.rst>
99-
GAROM <solver/garom.rst>
100-
AutoregressiveSolverInterface <solver/autoregressive_solver/autoregressive_solver_interface.rst>
101-
AutoregressiveSolver <solver/autoregressive_solver/autoregressive_solver.rst>
102-
83+
Solver Interface <solver/solver_interface.rst>
84+
Base Solver <solver/base_solver.rst>
85+
Single-Model Solver <solver/single_model_solver.rst>
86+
Multi-Model Solver <solver/multi_model_solver.rst>
87+
Ensemble Solver <solver/ensemble_solver.rst>
88+
Supervised Single-Model Solver <solver/supervised_single_model_solver.rst>
89+
Supervised Ensemble Solver <solver/supervised_ensemble_solver.rst>
90+
Physics-Informed Single-Model Solver <solver/physics_informed_single_model_solver.rst>
91+
Physics-Informed Ensemble Solver <solver/physics_informed_ensemble_solver.rst>
92+
Autoregressive Single-Model Solver <solver/autoregressive_single_model_solver.rst>
93+
Autoregressive Ensemble Solver <solver/autoregressive_ensemble_solver.rst>
94+
Single-Model Mixin <solver/mixin/single_model_mixin.rst>
95+
Multi-Model Mixin <solver/mixin/multi_model_mixin.rst>
96+
Ensemble Mixin <solver/mixin/ensemble_mixin.rst>
97+
Condition Aggregator Mixin <solver/mixin/condition_aggregator_mixin.rst>
98+
Manual Optimization Mixin <solver/mixin/manual_optimization_mixin.rst>
99+
Physics-Informed Mixin <solver/mixin/physics_informed_mixin.rst>
100+
Autoregressive Mixin <solver/mixin/autoregressive_mixin.rst>
103101

104102
Models
105103
------------
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Autoregressive Ensemble Solver
2+
=================================
3+
.. currentmodule:: pina.solver.autoregressive_ensemble_solver
4+
5+
.. automodule:: pina._src.solver.autoregressive_ensemble_solver
6+
7+
.. autoclass:: pina._src.solver.autoregressive_ensemble_solver.AutoregressiveEnsembleSolver
8+
:members:
9+
:show-inheritance:
10+
:noindex:
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Autoregressive Single Model Solver
2+
======================================
3+
.. currentmodule:: pina.solver.autoregressive_single_model_solver
4+
5+
.. automodule:: pina._src.solver.autoregressive_single_model_solver
6+
7+
.. autoclass:: pina._src.solver.autoregressive_single_model_solver.AutoregressiveSingleModelSolver
8+
:members:
9+
:show-inheritance:
10+
:noindex:

docs/source/_rst/solver/autoregressive_solver/autoregressive_solver.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/source/_rst/solver/autoregressive_solver/autoregressive_solver_interface.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Base Solver
2+
=================================
3+
.. currentmodule:: pina.solver.base_solver
4+
5+
.. automodule:: pina._src.solver.base_solver
6+
7+
.. autoclass:: pina._src.solver.base_solver.BaseSolver
8+
:members:
9+
:show-inheritance:
10+
:noindex:
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Ensemble Solver
2+
=================================
3+
.. currentmodule:: pina.solver.ensemble_solver
4+
5+
.. automodule:: pina._src.solver.ensemble_solver
6+
7+
.. autoclass:: pina._src.solver.ensemble_solver.EnsembleSolver
8+
:members:
9+
:show-inheritance:
10+
:noindex:

docs/source/_rst/solver/ensemble_solver/ensemble_pinn.rst

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs/source/_rst/solver/ensemble_solver/ensemble_solver_interface.rst

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs/source/_rst/solver/ensemble_solver/ensemble_supervised.rst

Lines changed: 0 additions & 8 deletions
This file was deleted.

0 commit comments

Comments
 (0)