* clean `condition` module
* add docs
This commit is contained in:
Nicola Demo
2023-04-18 15:00:26 +02:00
committed by GitHub
parent 736c78fd64
commit 2ca08b5236
18 changed files with 198 additions and 158 deletions

View File

@@ -1,5 +1,5 @@
AbstractProblem
===========
===============
.. currentmodule:: pina.problem.abstract_problem
.. automodule:: pina.problem.abstract_problem
@@ -9,4 +9,3 @@ AbstractProblem
:private-members:
:undoc-members:
:show-inheritance:
:noindex:

View File

@@ -7,14 +7,36 @@ Code Documentation
PINN <pinn.rst>
LabelTensor <label_tensor.rst>
Span <span.rst>
Operators <operators.rst>
Plotter <plotter.rst>
Condition <condition.rst>
Location <location.rst>
Model
-----
.. toctree::
:maxdepth: 3
FeedForward <fnn.rst>
DeepONet <deeponet.rst>
ContinuousConv <convolution.rst>
MultiFeedForward <multifeedforward.rst>
Layers
------
.. toctree::
:maxdepth: 3
ContinuousConv <convolution.rst>
Problem
-------
.. toctree::
:maxdepth: 3
AbstractProblem <abstractproblem.rst>
SpatialProblem <spatialproblem.rst>
TimeDependentProblem <timedepproblem.rst>
Operators <operators.rst>
Plotter <plotter.rst>
PINN <pinn.rst>
Condition <condition.rst>
ParametricProblem <parametricproblem.rst>

View File

@@ -7,6 +7,4 @@ Condition
.. autoclass:: Condition
:members:
:private-members:
:undoc-members:
:show-inheritance:
:noindex:
:show-inheritance:

View File

@@ -0,0 +1,10 @@
Location
=========
.. currentmodule:: pina.location
.. automodule:: pina.location
.. autoclass:: Location
:members:
:private-members:
:show-inheritance:

View File

@@ -1,5 +1,5 @@
MultiFeedForward
===========
================
.. currentmodule:: pina.model.multi_feed_forward
.. automodule:: pina.model.multi_feed_forward
@@ -7,6 +7,4 @@ MultiFeedForward
.. autoclass:: MultiFeedForward
:members:
:private-members:
:undoc-members:
:show-inheritance:
:noindex:
:show-inheritance:

View File

@@ -1,5 +1,5 @@
ParametricProblem
===========
=================
.. currentmodule:: pina.problem.parametric_problem
.. automodule:: pina.problem.parametric_problem
@@ -7,6 +7,4 @@ ParametricProblem
.. autoclass:: ParametricProblem
:members:
:private-members:
:undoc-members:
:show-inheritance:
:noindex:
:show-inheritance:

View File

@@ -1,5 +1,5 @@
SpatialProblem
===========
==============
.. currentmodule:: pina.problem.spatial_problem
.. automodule:: pina.problem.spatial_problem
@@ -9,4 +9,3 @@ SpatialProblem
:private-members:
:undoc-members:
:show-inheritance:
:noindex:

View File

@@ -1,5 +1,5 @@
TimeDependentProblem
===========
====================
.. currentmodule:: pina.problem.timedep_problem
.. automodule:: pina.problem.timedep_problem
@@ -9,4 +9,3 @@ TimeDependentProblem
:private-members:
:undoc-members:
:show-inheritance:
:noindex: