From 9a26c94e07e373909dfbc8468cdf1b7c0c379ff9 Mon Sep 17 00:00:00 2001 From: Dario Coscia Date: Thu, 13 Mar 2025 16:42:28 +0100 Subject: [PATCH] update rst --- docs/source/_rst/_code.rst | 93 ++++++++++++------- docs/source/_rst/data/data_module.rst | 10 +- docs/source/_rst/data/dataset.rst | 14 ++- docs/source/_rst/equation/equation.rst | 7 ++ .../source/_rst/equation/equation_factory.rst | 19 ++++ .../_rst/equation/equation_interface.rst | 7 ++ docs/source/_rst/equation/system_equation.rst | 7 ++ docs/source/_rst/equations.rst | 42 --------- docs/source/_rst/layers/avno_layer.rst | 8 -- docs/source/_rst/layers/convolution.rst | 8 -- docs/source/_rst/layers/enhanced_linear.rst | 8 -- docs/source/_rst/layers/lowrank_layer.rst | 8 -- docs/source/_rst/layers/pod.rst | 7 -- docs/source/_rst/layers/rbf_layer.rst | 7 -- docs/source/_rst/loss/loss_interface.rst | 6 +- docs/source/_rst/loss/lploss.rst | 4 +- docs/source/_rst/loss/powerloss.rst | 4 +- docs/source/_rst/loss/scalar_weighting.rst | 9 ++ docs/source/_rst/loss/weighting_interface.rst | 9 ++ .../average_neural_operator.rst} | 2 +- .../average_neural_operator_block.py.rst | 8 ++ docs/source/_rst/model/block/convolution.rst | 8 ++ .../_rst/model/block/enhanced_linear.rst | 8 ++ .../block/fourier_block.rst} | 6 +- .../block}/fourier_embedding.rst | 2 +- docs/source/_rst/model/block/gno_block.rst | 8 ++ .../_rst/model/block/low_rank_block.rst | 8 ++ .../{layers => model/block}/orthogonal.rst | 4 +- .../{layers => model/block}/pbc_embedding.rst | 2 +- docs/source/_rst/model/block/pod_block.rst | 7 ++ docs/source/_rst/model/block/rbf_block.rst | 7 ++ .../_rst/{layers => model/block}/residual.rst | 4 +- .../_rst/{layers => model/block}/spectral.rst | 6 +- .../_rst/{models => model}/deeponet.rst | 0 .../fnn.rst => model/feed_forward.rst} | 0 .../fourier_integral_kernel.rst} | 0 .../fourier_neural_operator.rst} | 2 +- .../_rst/model/graph_neural_operator.rst | 7 ++ .../kernel_neural_operator.rst} | 2 +- .../low_rank_neural_operator.rst} | 2 +- docs/source/_rst/{models => model}/mionet.rst | 0 .../multi_feed_forward.rst} | 0 .../residual_feed_forward.rst} | 0 docs/source/_rst/{models => model}/spline.rst | 0 docs/source/_rst/models/network.rst | 8 -- 45 files changed, 223 insertions(+), 155 deletions(-) create mode 100644 docs/source/_rst/equation/equation.rst create mode 100644 docs/source/_rst/equation/equation_factory.rst create mode 100644 docs/source/_rst/equation/equation_interface.rst create mode 100644 docs/source/_rst/equation/system_equation.rst delete mode 100644 docs/source/_rst/equations.rst delete mode 100644 docs/source/_rst/layers/avno_layer.rst delete mode 100644 docs/source/_rst/layers/convolution.rst delete mode 100644 docs/source/_rst/layers/enhanced_linear.rst delete mode 100644 docs/source/_rst/layers/lowrank_layer.rst delete mode 100644 docs/source/_rst/layers/pod.rst delete mode 100644 docs/source/_rst/layers/rbf_layer.rst create mode 100644 docs/source/_rst/loss/scalar_weighting.rst create mode 100644 docs/source/_rst/loss/weighting_interface.rst rename docs/source/_rst/{models/avno.rst => model/average_neural_operator.rst} (70%) create mode 100644 docs/source/_rst/model/block/average_neural_operator_block.py.rst create mode 100644 docs/source/_rst/model/block/convolution.rst create mode 100644 docs/source/_rst/model/block/enhanced_linear.rst rename docs/source/_rst/{layers/fourier.rst => model/block/fourier_block.rst} (63%) rename docs/source/_rst/{layers => model/block}/fourier_embedding.rst (75%) create mode 100644 docs/source/_rst/model/block/gno_block.rst create mode 100644 docs/source/_rst/model/block/low_rank_block.rst rename docs/source/_rst/{layers => model/block}/orthogonal.rst (59%) rename docs/source/_rst/{layers => model/block}/pbc_embedding.rst (77%) create mode 100644 docs/source/_rst/model/block/pod_block.rst create mode 100644 docs/source/_rst/model/block/rbf_block.rst rename docs/source/_rst/{layers => model/block}/residual.rst (58%) rename docs/source/_rst/{layers => model/block}/spectral.rst (68%) rename docs/source/_rst/{models => model}/deeponet.rst (100%) rename docs/source/_rst/{models/fnn.rst => model/feed_forward.rst} (100%) rename docs/source/_rst/{models/fourier_kernel.rst => model/fourier_integral_kernel.rst} (100%) rename docs/source/_rst/{models/fno.rst => model/fourier_neural_operator.rst} (56%) create mode 100644 docs/source/_rst/model/graph_neural_operator.rst rename docs/source/_rst/{models/base_no.rst => model/kernel_neural_operator.rst} (68%) rename docs/source/_rst/{models/lno.rst => model/low_rank_neural_operator.rst} (69%) rename docs/source/_rst/{models => model}/mionet.rst (100%) rename docs/source/_rst/{models/multifeedforward.rst => model/multi_feed_forward.rst} (100%) rename docs/source/_rst/{models/fnn_residual.rst => model/residual_feed_forward.rst} (100%) rename docs/source/_rst/{models => model}/spline.rst (100%) delete mode 100644 docs/source/_rst/models/network.rst diff --git a/docs/source/_rst/_code.rst b/docs/source/_rst/_code.rst index 70851e9..f088fa3 100644 --- a/docs/source/_rst/_code.rst +++ b/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 `, enhance the train with `Callback`_ -Training and Datamodules -------------------------- +Trainer, Dataset and Datamodule +-------------------------------- .. toctree:: :titlesonly: Trainer + Dataset + DataModule Data Types ------------ @@ -71,36 +73,45 @@ Models :titlesonly: :maxdepth: 5 - Network - KernelNeuralOperator - FeedForward - MultiFeedForward - ResidualFeedForward - Spline - DeepONet - MIONet - FourierIntegralKernel - FNO - AveragingNeuralOperator - LowRankNeuralOperator + FeedForward + MultiFeedForward + ResidualFeedForward + Spline + DeepONet + MIONet + KernelNeuralOperator + FourierIntegralKernel + FNO + AveragingNeuralOperator + LowRankNeuralOperator + GraphNeuralOperator -Layers +Blocks ------------- .. toctree:: :titlesonly: - Residual layer - EnhancedLinear layer - Spectral convolution - Fourier layers - Averaging layer - Low Rank layer - Continuous convolution - Proper Orthogonal Decomposition - Periodic Boundary Condition Embedding - Fourier Feature Embedding - Radial Basis Function Interpolation + Residual Block + EnhancedLinear Block + Spectral Convolution Block + Fourier Block + Averaging Block + Low Rank Block + Continuous Convolution Block + + +Reduction and Embeddings +-------------------------- + +.. toctree:: + :titlesonly: + + Proper Orthogonal Decomposition + Periodic Boundary Condition Embedding + Fourier Feature Embedding + Radial Basis Function Interpolation + Adaptive Activation Functions ------------------------------- @@ -123,7 +134,19 @@ Adaptive Activation Functions Adaptive Exp -Equations and Operators +Equations +------------- + +.. toctree:: + :titlesonly: + + EquationInterface + Equation + SystemEquation + Equation Factory + + +Differential Operators ------------------------- .. toctree:: @@ -133,7 +156,7 @@ Equations and Operators Differential Operators -Problem +Problems -------------- .. toctree:: @@ -144,8 +167,8 @@ Problem TimeDependentProblem ParametricProblem -Domains ------------------ +Geometrical Domains +--------------------- .. toctree:: :titlesonly: @@ -155,8 +178,8 @@ Domains EllipsoidDomain SimplexDomain -domain set operations ------------------------- +Domain Operations +------------------ .. toctree:: :titlesonly: @@ -178,8 +201,8 @@ Callback Refinment callback Weighting callback -Metrics and Losses --------------------- +Losses and Weightings +--------------------- .. toctree:: :titlesonly: @@ -187,3 +210,5 @@ Metrics and Losses LossInterface LpLoss PowerLoss + WeightingInterface + ScalarWeighting diff --git a/docs/source/_rst/data/data_module.rst b/docs/source/_rst/data/data_module.rst index 3275fa2..b7ffb14 100644 --- a/docs/source/_rst/data/data_module.rst +++ b/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: \ No newline at end of file diff --git a/docs/source/_rst/data/dataset.rst b/docs/source/_rst/data/dataset.rst index d00bb77..b49b41d 100644 --- a/docs/source/_rst/data/dataset.rst +++ b/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: \ No newline at end of file diff --git a/docs/source/_rst/equation/equation.rst b/docs/source/_rst/equation/equation.rst new file mode 100644 index 0000000..33e19c9 --- /dev/null +++ b/docs/source/_rst/equation/equation.rst @@ -0,0 +1,7 @@ +Equation +========== + +.. currentmodule:: pina.equation.equation +.. autoclass:: Equation + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/_rst/equation/equation_factory.rst b/docs/source/_rst/equation/equation_factory.rst new file mode 100644 index 0000000..cf5d430 --- /dev/null +++ b/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: \ No newline at end of file diff --git a/docs/source/_rst/equation/equation_interface.rst b/docs/source/_rst/equation/equation_interface.rst new file mode 100644 index 0000000..cde7b00 --- /dev/null +++ b/docs/source/_rst/equation/equation_interface.rst @@ -0,0 +1,7 @@ +Equation Interface +==================== + +.. currentmodule:: pina.equation.equation_interface +.. autoclass:: EquationInterface + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/_rst/equation/system_equation.rst b/docs/source/_rst/equation/system_equation.rst new file mode 100644 index 0000000..33c931c --- /dev/null +++ b/docs/source/_rst/equation/system_equation.rst @@ -0,0 +1,7 @@ +System Equation +================= + +.. currentmodule:: pina.equation.system_equation +.. autoclass:: SystemEquation + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/_rst/equations.rst b/docs/source/_rst/equations.rst deleted file mode 100644 index 6826dde..0000000 --- a/docs/source/_rst/equations.rst +++ /dev/null @@ -1,42 +0,0 @@ -Equations -========== -Equations are used in PINA to make easy the training. During problem definition -each `equation` passed to a `Condition` object must be an `Equation` or `SystemEquation`. -An `Equation` is simply a wrapper over callable python functions, while `SystemEquation` is -a wrapper arounf a list of callable python functions. We provide a wide rage of already implemented -equations to ease the code writing, such as `FixedValue`, `Laplace`, and many more. - - -.. currentmodule:: pina.equation.equation_interface -.. autoclass:: EquationInterface - :members: - :show-inheritance: - -.. currentmodule:: pina.equation.equation -.. autoclass:: Equation - :members: - :show-inheritance: - - -.. currentmodule:: pina.equation.system_equation -.. autoclass:: SystemEquation - :members: - :show-inheritance: - - -.. 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: \ No newline at end of file diff --git a/docs/source/_rst/layers/avno_layer.rst b/docs/source/_rst/layers/avno_layer.rst deleted file mode 100644 index 38d7ccb..0000000 --- a/docs/source/_rst/layers/avno_layer.rst +++ /dev/null @@ -1,8 +0,0 @@ -Averaging layers -==================== -.. currentmodule:: pina.model.layers.avno_layer - -.. autoclass:: AVNOBlock - :members: - :show-inheritance: - :noindex: diff --git a/docs/source/_rst/layers/convolution.rst b/docs/source/_rst/layers/convolution.rst deleted file mode 100644 index 3089fea..0000000 --- a/docs/source/_rst/layers/convolution.rst +++ /dev/null @@ -1,8 +0,0 @@ -Continuous convolution -========================= -.. currentmodule:: pina.model.layers.convolution_2d - -.. autoclass:: ContinuousConvBlock - :members: - :show-inheritance: - :noindex: diff --git a/docs/source/_rst/layers/enhanced_linear.rst b/docs/source/_rst/layers/enhanced_linear.rst deleted file mode 100644 index ba30960..0000000 --- a/docs/source/_rst/layers/enhanced_linear.rst +++ /dev/null @@ -1,8 +0,0 @@ -EnhancedLinear -================= -.. currentmodule:: pina.model.layers.residual - -.. autoclass:: EnhancedLinear - :members: - :show-inheritance: - :noindex: \ No newline at end of file diff --git a/docs/source/_rst/layers/lowrank_layer.rst b/docs/source/_rst/layers/lowrank_layer.rst deleted file mode 100644 index 6e72feb..0000000 --- a/docs/source/_rst/layers/lowrank_layer.rst +++ /dev/null @@ -1,8 +0,0 @@ -Low Rank layer -==================== -.. currentmodule:: pina.model.layers.lowrank_layer - -.. autoclass:: LowRankBlock - :members: - :show-inheritance: - :noindex: diff --git a/docs/source/_rst/layers/pod.rst b/docs/source/_rst/layers/pod.rst deleted file mode 100644 index 041be99..0000000 --- a/docs/source/_rst/layers/pod.rst +++ /dev/null @@ -1,7 +0,0 @@ -PODBlock -====================== -.. currentmodule:: pina.model.layers.pod - -.. autoclass:: PODBlock - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/_rst/layers/rbf_layer.rst b/docs/source/_rst/layers/rbf_layer.rst deleted file mode 100644 index 8736d1a..0000000 --- a/docs/source/_rst/layers/rbf_layer.rst +++ /dev/null @@ -1,7 +0,0 @@ -RBFBlock -====================== -.. currentmodule:: pina.model.layers.rbf_layer - -.. autoclass:: RBFBlock - :members: - :show-inheritance: diff --git a/docs/source/_rst/loss/loss_interface.rst b/docs/source/_rst/loss/loss_interface.rst index 6d4827d..8ff78c0 100644 --- a/docs/source/_rst/loss/loss_interface.rst +++ b/docs/source/_rst/loss/loss_interface.rst @@ -1,8 +1,8 @@ -LpLoss +LossInterface =============== -.. currentmodule:: pina.loss +.. currentmodule:: pina.loss.loss_interface -.. automodule:: pina.loss +.. automodule:: pina.loss.loss_interface .. autoclass:: LossInterface :members: diff --git a/docs/source/_rst/loss/lploss.rst b/docs/source/_rst/loss/lploss.rst index f95d187..4244616 100644 --- a/docs/source/_rst/loss/lploss.rst +++ b/docs/source/_rst/loss/lploss.rst @@ -1,8 +1,8 @@ LpLoss =============== -.. currentmodule:: pina.loss +.. currentmodule:: pina.loss.lp_loss -.. automodule:: pina.loss +.. automodule:: pina.loss.lp_loss :no-index: .. autoclass:: LpLoss diff --git a/docs/source/_rst/loss/powerloss.rst b/docs/source/_rst/loss/powerloss.rst index 0b1a7d9..fd28f55 100644 --- a/docs/source/_rst/loss/powerloss.rst +++ b/docs/source/_rst/loss/powerloss.rst @@ -1,8 +1,8 @@ PowerLoss ==================== -.. currentmodule:: pina.loss +.. currentmodule:: pina.loss.power_loss -.. automodule:: pina.loss +.. automodule:: pina.loss.power_loss :no-index: .. autoclass:: PowerLoss diff --git a/docs/source/_rst/loss/scalar_weighting.rst b/docs/source/_rst/loss/scalar_weighting.rst new file mode 100644 index 0000000..5ee82a7 --- /dev/null +++ b/docs/source/_rst/loss/scalar_weighting.rst @@ -0,0 +1,9 @@ +ScalarWeighting +=================== +.. currentmodule:: pina.loss.scalar_weighting + +.. automodule:: pina.loss.scalar_weighting + +.. autoclass:: ScalarWeighting + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/_rst/loss/weighting_interface.rst b/docs/source/_rst/loss/weighting_interface.rst new file mode 100644 index 0000000..2b0fa1b --- /dev/null +++ b/docs/source/_rst/loss/weighting_interface.rst @@ -0,0 +1,9 @@ +WeightingInterface +=================== +.. currentmodule:: pina.loss.weighting_interface + +.. automodule:: pina.loss.weighting_interface + +.. autoclass:: WeightingInterface + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/_rst/models/avno.rst b/docs/source/_rst/model/average_neural_operator.rst similarity index 70% rename from docs/source/_rst/models/avno.rst rename to docs/source/_rst/model/average_neural_operator.rst index a083f6f..02211e9 100644 --- a/docs/source/_rst/models/avno.rst +++ b/docs/source/_rst/model/average_neural_operator.rst @@ -1,6 +1,6 @@ Averaging Neural Operator ============================== -.. currentmodule:: pina.model.avno +.. currentmodule:: pina.model.average_neural_operator .. autoclass:: AveragingNeuralOperator :members: diff --git a/docs/source/_rst/model/block/average_neural_operator_block.py.rst b/docs/source/_rst/model/block/average_neural_operator_block.py.rst new file mode 100644 index 0000000..0072ec9 --- /dev/null +++ b/docs/source/_rst/model/block/average_neural_operator_block.py.rst @@ -0,0 +1,8 @@ +Averaging Neural Operator Block +================================== +.. currentmodule:: pina.model.block.average_neural_operator_block + +.. autoclass:: AVNOBlock + :members: + :show-inheritance: + :noindex: diff --git a/docs/source/_rst/model/block/convolution.rst b/docs/source/_rst/model/block/convolution.rst new file mode 100644 index 0000000..4033d5d --- /dev/null +++ b/docs/source/_rst/model/block/convolution.rst @@ -0,0 +1,8 @@ +Continuous Convolution Block +=============================== +.. currentmodule:: pina.model.block.convolution_2d + +.. autoclass:: ContinuousConvBlock + :members: + :show-inheritance: + :noindex: diff --git a/docs/source/_rst/model/block/enhanced_linear.rst b/docs/source/_rst/model/block/enhanced_linear.rst new file mode 100644 index 0000000..d08cf79 --- /dev/null +++ b/docs/source/_rst/model/block/enhanced_linear.rst @@ -0,0 +1,8 @@ +EnhancedLinear Block +===================== +.. currentmodule:: pina.model.block.residual + +.. autoclass:: EnhancedLinear + :members: + :show-inheritance: + :noindex: \ No newline at end of file diff --git a/docs/source/_rst/layers/fourier.rst b/docs/source/_rst/model/block/fourier_block.rst similarity index 63% rename from docs/source/_rst/layers/fourier.rst rename to docs/source/_rst/model/block/fourier_block.rst index 1321700..c0fff4d 100644 --- a/docs/source/_rst/layers/fourier.rst +++ b/docs/source/_rst/model/block/fourier_block.rst @@ -1,6 +1,6 @@ -Fourier Layers -=================== -.. currentmodule:: pina.model.layers.fourier +Fourier Neural Operator Block +====================================== +.. currentmodule:: pina.model.block.fourier_block .. autoclass:: FourierBlock1D diff --git a/docs/source/_rst/layers/fourier_embedding.rst b/docs/source/_rst/model/block/fourier_embedding.rst similarity index 75% rename from docs/source/_rst/layers/fourier_embedding.rst rename to docs/source/_rst/model/block/fourier_embedding.rst index f48cef1..77eb396 100644 --- a/docs/source/_rst/layers/fourier_embedding.rst +++ b/docs/source/_rst/model/block/fourier_embedding.rst @@ -1,6 +1,6 @@ Fourier Feature Embedding ======================================= -.. currentmodule:: pina.model.layers.embedding +.. currentmodule:: pina.model.block.embedding .. autoclass:: FourierFeatureEmbedding :members: diff --git a/docs/source/_rst/model/block/gno_block.rst b/docs/source/_rst/model/block/gno_block.rst new file mode 100644 index 0000000..19a532b --- /dev/null +++ b/docs/source/_rst/model/block/gno_block.rst @@ -0,0 +1,8 @@ +Graph Neural Operator Block +=============================== +.. currentmodule:: pina.model.block.gno_block + +.. autoclass:: GNOBlock + :members: + :show-inheritance: + :noindex: diff --git a/docs/source/_rst/model/block/low_rank_block.rst b/docs/source/_rst/model/block/low_rank_block.rst new file mode 100644 index 0000000..366068f --- /dev/null +++ b/docs/source/_rst/model/block/low_rank_block.rst @@ -0,0 +1,8 @@ +Low Rank Neural Operator Block +================================= +.. currentmodule:: pina.model.block.low_rank_block + +.. autoclass:: LowRankBlock + :members: + :show-inheritance: + :noindex: diff --git a/docs/source/_rst/layers/orthogonal.rst b/docs/source/_rst/model/block/orthogonal.rst similarity index 59% rename from docs/source/_rst/layers/orthogonal.rst rename to docs/source/_rst/model/block/orthogonal.rst index 6dfc400..21d1299 100644 --- a/docs/source/_rst/layers/orthogonal.rst +++ b/docs/source/_rst/model/block/orthogonal.rst @@ -1,6 +1,6 @@ -OrthogonalBlock +Orthogonal Block ====================== -.. currentmodule:: pina.model.layers.orthogonal +.. currentmodule:: pina.model.block.orthogonal .. autoclass:: OrthogonalBlock :members: diff --git a/docs/source/_rst/layers/pbc_embedding.rst b/docs/source/_rst/model/block/pbc_embedding.rst similarity index 77% rename from docs/source/_rst/layers/pbc_embedding.rst rename to docs/source/_rst/model/block/pbc_embedding.rst index d4d2023..f469644 100644 --- a/docs/source/_rst/layers/pbc_embedding.rst +++ b/docs/source/_rst/model/block/pbc_embedding.rst @@ -1,6 +1,6 @@ Periodic Boundary Condition Embedding ======================================= -.. currentmodule:: pina.model.layers.embedding +.. currentmodule:: pina.model.block.embedding .. autoclass:: PeriodicBoundaryEmbedding :members: diff --git a/docs/source/_rst/model/block/pod_block.rst b/docs/source/_rst/model/block/pod_block.rst new file mode 100644 index 0000000..4b66e2c --- /dev/null +++ b/docs/source/_rst/model/block/pod_block.rst @@ -0,0 +1,7 @@ +Proper Orthogonal Decomposition Block +============================================ +.. currentmodule:: pina.model.block.pod_block + +.. autoclass:: PODBlock + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/_rst/model/block/rbf_block.rst b/docs/source/_rst/model/block/rbf_block.rst new file mode 100644 index 0000000..545f14d --- /dev/null +++ b/docs/source/_rst/model/block/rbf_block.rst @@ -0,0 +1,7 @@ +Radias Basis Function Block +============================= +.. currentmodule:: pina.model.block.rbf_block + +.. autoclass:: RBFBlock + :members: + :show-inheritance: diff --git a/docs/source/_rst/layers/residual.rst b/docs/source/_rst/model/block/residual.rst similarity index 58% rename from docs/source/_rst/layers/residual.rst rename to docs/source/_rst/model/block/residual.rst index 1af11e5..69741c7 100644 --- a/docs/source/_rst/layers/residual.rst +++ b/docs/source/_rst/model/block/residual.rst @@ -1,6 +1,6 @@ -Residual layer +Residual Block =================== -.. currentmodule:: pina.model.layers.residual +.. currentmodule:: pina.model.block.residual .. autoclass:: ResidualBlock :members: diff --git a/docs/source/_rst/layers/spectral.rst b/docs/source/_rst/model/block/spectral.rst similarity index 68% rename from docs/source/_rst/layers/spectral.rst rename to docs/source/_rst/model/block/spectral.rst index 5635ba2..3c80f3d 100644 --- a/docs/source/_rst/layers/spectral.rst +++ b/docs/source/_rst/model/block/spectral.rst @@ -1,6 +1,6 @@ -Spectral Convolution -====================== -.. currentmodule:: pina.model.layers.spectral +Spectral Convolution Block +============================ +.. currentmodule:: pina.model.block.spectral .. autoclass:: SpectralConvBlock1D :members: diff --git a/docs/source/_rst/models/deeponet.rst b/docs/source/_rst/model/deeponet.rst similarity index 100% rename from docs/source/_rst/models/deeponet.rst rename to docs/source/_rst/model/deeponet.rst diff --git a/docs/source/_rst/models/fnn.rst b/docs/source/_rst/model/feed_forward.rst similarity index 100% rename from docs/source/_rst/models/fnn.rst rename to docs/source/_rst/model/feed_forward.rst diff --git a/docs/source/_rst/models/fourier_kernel.rst b/docs/source/_rst/model/fourier_integral_kernel.rst similarity index 100% rename from docs/source/_rst/models/fourier_kernel.rst rename to docs/source/_rst/model/fourier_integral_kernel.rst diff --git a/docs/source/_rst/models/fno.rst b/docs/source/_rst/model/fourier_neural_operator.rst similarity index 56% rename from docs/source/_rst/models/fno.rst rename to docs/source/_rst/model/fourier_neural_operator.rst index 3d102b3..e77494f 100644 --- a/docs/source/_rst/models/fno.rst +++ b/docs/source/_rst/model/fourier_neural_operator.rst @@ -1,6 +1,6 @@ FNO =========== -.. currentmodule:: pina.model.fno +.. currentmodule:: pina.model.fourier_neural_operator .. autoclass:: FNO :members: diff --git a/docs/source/_rst/model/graph_neural_operator.rst b/docs/source/_rst/model/graph_neural_operator.rst new file mode 100644 index 0000000..fbb8600 --- /dev/null +++ b/docs/source/_rst/model/graph_neural_operator.rst @@ -0,0 +1,7 @@ +GraphNeuralOperator +======================= +.. currentmodule:: pina.model.graph_neural_operator + +.. autoclass:: GraphNeuralOperator + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/_rst/models/base_no.rst b/docs/source/_rst/model/kernel_neural_operator.rst similarity index 68% rename from docs/source/_rst/models/base_no.rst rename to docs/source/_rst/model/kernel_neural_operator.rst index 772261c..d693afa 100644 --- a/docs/source/_rst/models/base_no.rst +++ b/docs/source/_rst/model/kernel_neural_operator.rst @@ -1,6 +1,6 @@ KernelNeuralOperator ======================= -.. currentmodule:: pina.model.base_no +.. currentmodule:: pina.model.kernel_neural_operator .. autoclass:: KernelNeuralOperator :members: diff --git a/docs/source/_rst/models/lno.rst b/docs/source/_rst/model/low_rank_neural_operator.rst similarity index 69% rename from docs/source/_rst/models/lno.rst rename to docs/source/_rst/model/low_rank_neural_operator.rst index f3f8277..22fe7cc 100644 --- a/docs/source/_rst/models/lno.rst +++ b/docs/source/_rst/model/low_rank_neural_operator.rst @@ -1,6 +1,6 @@ Low Rank Neural Operator ============================== -.. currentmodule:: pina.model.lno +.. currentmodule:: pina.model.low_rank_neural_operator .. autoclass:: LowRankNeuralOperator :members: diff --git a/docs/source/_rst/models/mionet.rst b/docs/source/_rst/model/mionet.rst similarity index 100% rename from docs/source/_rst/models/mionet.rst rename to docs/source/_rst/model/mionet.rst diff --git a/docs/source/_rst/models/multifeedforward.rst b/docs/source/_rst/model/multi_feed_forward.rst similarity index 100% rename from docs/source/_rst/models/multifeedforward.rst rename to docs/source/_rst/model/multi_feed_forward.rst diff --git a/docs/source/_rst/models/fnn_residual.rst b/docs/source/_rst/model/residual_feed_forward.rst similarity index 100% rename from docs/source/_rst/models/fnn_residual.rst rename to docs/source/_rst/model/residual_feed_forward.rst diff --git a/docs/source/_rst/models/spline.rst b/docs/source/_rst/model/spline.rst similarity index 100% rename from docs/source/_rst/models/spline.rst rename to docs/source/_rst/model/spline.rst diff --git a/docs/source/_rst/models/network.rst b/docs/source/_rst/models/network.rst deleted file mode 100644 index 4df9e19..0000000 --- a/docs/source/_rst/models/network.rst +++ /dev/null @@ -1,8 +0,0 @@ -Network -================ - -.. automodule:: pina.model.network - -.. autoclass:: Network - :members: - :show-inheritance: