Skip to content

enhance: tutorial 1 using ann. #282

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kshitij-maths wants to merge 3 commits into
base: master
Choose a base branch
from
Open

enhance: tutorial 1 using ann. #282

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
24fb01e
enhance: tut-1 ann
kshitij-maths Mar 29, 2026
9355465
docs(tutorials): rename tutorial-5 and switch to SISSA mathLab Huggin…
kshitij-maths Apr 1, 2026
71f8208
docs: sync API and link tut 5 in toctree
kshitij-maths Apr 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions docs/source/database.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Database

=====================

.. currentmodule:: ezyrb.database
Expand All @@ -9,7 +9,17 @@ Database
:toctree: _summaries
:nosignatures:

.. autoclass:: Database

.parameters_matrix
.snapshots_matrix
.__getitem__
.__len__
.__str__
.add
.split
.get_snapshot_space

.. autoclass::
:members:
:private-members:
:undoc-members:
Expand Down
8 changes: 6 additions & 2 deletions docs/source/parameter.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Parameter

=====================

.. currentmodule:: ezyrb.parameter
Expand All @@ -9,7 +9,11 @@ Parameter
:toctree: _summaries
:nosignatures:

.. autoclass:: Parameter

.values
.values

.. autoclass::
:members:
:private-members:
:undoc-members:
Expand Down
154 changes: 153 additions & 1 deletion docs/source/reducedordermodel.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel
=====================

.. currentmodule:: ezyrb.reducedordermodel
Expand All @@ -9,7 +11,157 @@ ReducedOrderModel
:toctree: _summaries
:nosignatures:

.. autoclass:: ReducedOrderModel
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel._execute_plugins
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.clean
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.database
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.database
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.database
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.reduction
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.reduction
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.reduction
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.approximation
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.approximation
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.approximation
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.n_database
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.n_reduction
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.n_approximation
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.fit_reduction
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel._reduce_database
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.fit_approximation
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.fit
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.predict
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.save
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.load
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.test_error
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.loo_error
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.optimal_mu
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel._simplex_volume
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.reduction_error
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.approximation_error
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.database
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.database
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.database
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.reduction
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.reduction
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.reduction
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.approximation
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.approximation
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.n_database
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.n_reduction
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.n_approximation
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.fit
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.predict
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.save
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.load
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.test_error
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.loo_error
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.optimal_mu
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel._simplex_volume
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.reduction_error
ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel.approximation_error

.. autoclass:: ReducedOrderModelInterface
ReducedOrderModel
MultiReducedOrderModel
:members:
:private-members:
:undoc-members:
Expand Down
6 changes: 6 additions & 0 deletions docs/source/regular_grid.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ RegularGrid
:toctree: _summaries
:nosignatures:

RegularGrid
RegularGrid.def
RegularGrid.get_grid_axes
RegularGrid.fit
RegularGrid.predict

.. autoclass:: RegularGrid
:members:
:private-members:
Expand Down
12 changes: 10 additions & 2 deletions docs/source/snapshot.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Snapshot

=====================

.. currentmodule:: ezyrb.snapshot
Expand All @@ -9,7 +9,15 @@ Snapshot
:toctree: _summaries
:nosignatures:

.. autoclass:: Snapshot

.values
.values
.space
.space
.flattened
.plot

.. autoclass::
:members:
:private-members:
:undoc-members:
Expand Down
5 changes: 5 additions & 0 deletions docs/source/tutorials.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,8 @@ Tutorials
:maxdepth: 1

_tutorials/tutorial-4

.. toctree::
:maxdepth: 1

_tutorials/tutorial-5
2 changes: 1 addition & 1 deletion tutorials/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ In this folder you can find a collection of useful tutorials in order to underst

[Tutorial 4](tutorial-4.ipynb) shows the potential of aggregation strategies for ROMs, namely combining different ROM predictions in a multiROM.


* [Tutorial 5](tutorial-5.ipynb): Comparing ANN and RBF Reduced Order Models on a thermal dataset.
#### More to come...
We plan to add more tutorials but the time is often against us. If you want to contribute with a notebook on a feature not covered yet we will be very happy and give you support on editing!

Expand Down
Loading
Loading