Skip to content

Commit cddac85

Browse files
committed
update doc
1 parent 4330c9e commit cddac85

33 files changed

+268
-199
lines changed

docs/source/_rst/_code.rst

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ The high-level structure of the package is depicted in our API.
1111

1212
The pipeline to solve differential equations with PINA follows just five steps:
1313

14-
1. Define the `Problem`_ the user aim to solve
15-
2. Generate data using built in `Domains`_, or load high level simulation results as :doc:`LabelTensor <label_tensor>`
14+
1. Define the `Problems`_ the user aim to solve
15+
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
1717
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 `Callback`_
18+
5. Train the model with the PINA :doc:`Trainer <solver/solver_interface>`, enhance the train with `Callbacks`_
1919

2020

2121
Trainer, Dataset and Datamodule
@@ -34,14 +34,14 @@ Data Types
3434

3535
LabelTensor <label_tensor.rst>
3636
Graph <graph/graph.rst>
37+
LabelBatch <graph/label_batch.rst>
3738

3839

3940
Graphs Structures
4041
------------------
4142
.. toctree::
4243
:titlesonly:
4344

44-
Graph <graph/graph.rst>
4545
GraphBuilder <graph/graph_builder.rst>
4646
RadiusGraph <graph/radius_graph.rst>
4747
KNNGraph <graph/knn_graph.rst>
@@ -98,7 +98,8 @@ Models
9898
FNO <model/fourier_neural_operator.rst>
9999
AveragingNeuralOperator <model/average_neural_operator.rst>
100100
LowRankNeuralOperator <model/low_rank_neural_operator.rst>
101-
GraphNeuralOperator <model/>
101+
GraphNeuralOperator <model/graph_neural_operator.rst>
102+
GraphNeuralKernel <model/graph_neural_operator_integral_kernel.rst>
102103

103104
Blocks
104105
-------------
@@ -112,7 +113,10 @@ Blocks
112113
Fourier Block <model/block/fourier_block.rst>
113114
Averaging Block <model/block/average_neural_operator_block.rst>
114115
Low Rank Block <model/block/low_rank_block.rst>
116+
Graph Neural Operator Block <model/block/gno_block.rst>
117+
Continuous Convolution Interface <model/block/convolution_interface.rst>
115118
Continuous Convolution Block <model/block/convolution.rst>
119+
Orthogonal Block <model/block/orthogonal.rst>
116120

117121

118122
Reduction and Embeddings
@@ -144,7 +148,7 @@ Adaptive Activation Functions
144148
.. toctree::
145149
:titlesonly:
146150

147-
Adaptive Function Interface <adaptive_function/AdaptiveFunctionInterface.rst>
151+
Adaptive Function Interface <adaptive_function/AdaptiveActivationFunctionInterface.rst>
148152
Adaptive ReLU <adaptive_function/AdaptiveReLU.rst>
149153
Adaptive Sigmoid <adaptive_function/AdaptiveSigmoid.rst>
150154
Adaptive Tanh <adaptive_function/AdaptiveTanh.rst>
@@ -165,10 +169,10 @@ Equations and Differential Operators
165169
.. toctree::
166170
:titlesonly:
167171

168-
EquationInterface <equation.equation_interface.rst>
169-
Equation <equation.equation.rst>
170-
SystemEquation <equation.system_equation.rst>
171-
Equation Factory <equation.equation_factory.rst>
172+
EquationInterface <equation/equation_interface.rst>
173+
Equation <equation/equation.rst>
174+
SystemEquation <equation/system_equation.rst>
175+
Equation Factory <equation/equation_factory.rst>
172176
Differential Operators <operator.rst>
173177

174178

@@ -200,7 +204,7 @@ Problems Zoo
200204

201205

202206
Geometrical Domains
203-
---------------------
207+
--------------------
204208

205209
.. toctree::
206210
:titlesonly:
@@ -222,8 +226,8 @@ Domain Operations
222226
Difference <domain/difference_domain.rst>
223227
Exclusion <domain/exclusion_domain.rst>
224228

225-
Callback
226-
--------------------
229+
Callbacks
230+
-----------
227231

228232
.. toctree::
229233
:titlesonly:

docs/source/_rst/adaptive_function/AdaptiveActivationFunctionInterface.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@ AdaptiveActivationFunctionInterface
33

44
.. currentmodule:: pina.adaptive_function.adaptive_function_interface
55

6-
.. automodule:: pina.adaptive_function.adaptive_functiontion_interface
6+
.. automodule:: pina.adaptive_function.adaptive_function_interface
77
:members:
88
:show-inheritance:

docs/source/_rst/callback/adaptive_refinment_callbacks.rst renamed to docs/source/_rst/callback/adaptive_refinment_callback.rst

File renamed without changes.
File renamed without changes.

docs/source/_rst/callback/processing_callbacks.rst renamed to docs/source/_rst/callback/processing_callback.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Processing callbacks
22
=======================
33

4-
.. currentmodule:: pina.callbacks.processing_callback
4+
.. currentmodule:: pina.callback.processing_callback
55
.. autoclass:: MetricTracker
66
:members:
77
:show-inheritance:

docs/source/_rst/domain/domain.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ Domain
44

55
.. automodule:: pina.domain.domain_interface
66

7-
.. autoclass:: Domain
7+
.. autoclass:: DomainInterface
88
:members:
99
:show-inheritance:
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
LabelBatch
2+
===========
3+
.. currentmodule:: pina.graph
4+
5+
6+
.. autoclass:: LabelBatch
7+
:members:
8+
:private-members:
9+
:show-inheritance:

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

File renamed without changes.
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Continuous Convolution Interface
2+
==================================
3+
.. currentmodule:: pina.model.block.convolution
4+
5+
.. autoclass:: BaseContinuousConv
6+
:members:
7+
:show-inheritance:
8+
:noindex:

docs/source/_rst/model/fourier_integral_kernel.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
FourierIntegralKernel
22
=========================
3-
.. currentmodule:: pina.model.fno
3+
.. currentmodule:: pina.model.fourier_neural_operator
44

55
.. autoclass:: FourierIntegralKernel
66
:members:

0 commit comments

Comments
 (0)