From 2382ef55cdb5e78273e511a0375f85dc73d89262 Mon Sep 17 00:00:00 2001 From: Anna Ivagnes Date: Wed, 19 Apr 2023 11:07:14 +0200 Subject: [PATCH] fix docs --- docs/source/_rst/code.rst | 1 + docs/source/_rst/network.rst | 10 ++++++++++ pina/problem/parametric_problem.py | 8 +++++++- 3 files changed, 18 insertions(+), 1 deletion(-) create mode 100644 docs/source/_rst/network.rst diff --git a/docs/source/_rst/code.rst b/docs/source/_rst/code.rst index 6663d8f..761ed8a 100644 --- a/docs/source/_rst/code.rst +++ b/docs/source/_rst/code.rst @@ -18,6 +18,7 @@ Model .. toctree:: :maxdepth: 3 + Network FeedForward DeepONet MultiFeedForward diff --git a/docs/source/_rst/network.rst b/docs/source/_rst/network.rst new file mode 100644 index 0000000..e81143a --- /dev/null +++ b/docs/source/_rst/network.rst @@ -0,0 +1,10 @@ +Network +================ +.. currentmodule:: pina.model.network + +.. automodule:: pina.model.network + +.. autoclass:: Network + :members: + :private-members: + :show-inheritance: diff --git a/pina/problem/parametric_problem.py b/pina/problem/parametric_problem.py index 7e1d5a2..f498379 100644 --- a/pina/problem/parametric_problem.py +++ b/pina/problem/parametric_problem.py @@ -23,7 +23,7 @@ class ParametricProblem(AbstractProblem): >>> >>> output_variables = ['u'] >>> spatial_domain = Span({'x': [0, 1]}) - >>> parameter_domain = Span({'alpha': {1, 10}}) + >>> parameter_domain = Span({'alpha': [1, 10]}) >>> >>> def ode_equation(input_, output_): >>> u_x = grad(output_, input_, components=['u'], d=['x']) @@ -43,8 +43,14 @@ class ParametricProblem(AbstractProblem): @abstractmethod def parameter_domain(self): + """ + The parameters' domain of the problem. + """ pass @property def parameters(self): + """ + The parameters' variables of the problem. + """ return self.parameter_domain.variables