Skip to content

Commit 2382ef5

Browse files
annaivagnesndem0
authored andcommitted
fix docs
1 parent 9c95c3e commit 2382ef5

File tree

3 files changed

+18
-1
lines changed

3 files changed

+18
-1
lines changed

docs/source/_rst/code.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ Model
1818
.. toctree::
1919
:maxdepth: 3
2020

21+
Network <network.rst>
2122
FeedForward <fnn.rst>
2223
DeepONet <deeponet.rst>
2324
MultiFeedForward <multifeedforward.rst>

docs/source/_rst/network.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Network
2+
================
3+
.. currentmodule:: pina.model.network
4+
5+
.. automodule:: pina.model.network
6+
7+
.. autoclass:: Network
8+
:members:
9+
:private-members:
10+
:show-inheritance:

pina/problem/parametric_problem.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ class ParametricProblem(AbstractProblem):
2323
>>>
2424
>>> output_variables = ['u']
2525
>>> spatial_domain = Span({'x': [0, 1]})
26-
>>> parameter_domain = Span({'alpha': {1, 10}})
26+
>>> parameter_domain = Span({'alpha': [1, 10]})
2727
>>>
2828
>>> def ode_equation(input_, output_):
2929
>>> u_x = grad(output_, input_, components=['u'], d=['x'])
@@ -43,8 +43,14 @@ class ParametricProblem(AbstractProblem):
4343

4444
@abstractmethod
4545
def parameter_domain(self):
46+
"""
47+
The parameters' domain of the problem.
48+
"""
4649
pass
4750

4851
@property
4952
def parameters(self):
53+
"""
54+
The parameters' variables of the problem.
55+
"""
5056
return self.parameter_domain.variables

0 commit comments

Comments
 (0)