From e13e94b08683219fda819e869c0f3b60ceb59976 Mon Sep 17 00:00:00 2001 From: Kaustubh Tangsali <71059996+ktangsali@users.noreply.github.com> Date: Tue, 8 Aug 2023 17:53:52 -0700 Subject: [PATCH] Update docs (#117) * update docs after GNN datapipe refactor * add docs for other models, utils * add dates to CHANGELOG --- CHANGELOG.md | 4 ++-- docs/api/modulus.datapipes.rst | 10 ++++++++- docs/api/modulus.models.rst | 41 ++++++++++++++++++++++++++++++++++ docs/api/modulus.utils.rst | 6 +++++ 4 files changed, 58 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 151e91e1ef..25b12563a7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -22,7 +22,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Dependencies -## [0.2.1] - 2023-08-xx +## [0.2.1] - 2023-08-08 ### Added @@ -42,7 +42,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Dependencies -## [0.2.0] - 2023-08-xx +## [0.2.0] - 2023-08-01 ### Added diff --git a/docs/api/modulus.datapipes.rst b/docs/api/modulus.datapipes.rst index eed0cb2dad..93e697c8ce 100644 --- a/docs/api/modulus.datapipes.rst +++ b/docs/api/modulus.datapipes.rst @@ -25,6 +25,14 @@ Weather and climate datapipes Graph datapipes --------------- -.. automodule:: modulus.datapipes.gnn.mgn_dataset +.. automodule:: modulus.datapipes.gnn.vortex_shedding_dataset + :members: + :show-inheritance: + +.. automodule:: modulus.datapipes.gnn.ahmed_body_dataset + :members: + :show-inheritance: + +.. automodule:: modulus.datapipes.gnn.utils :members: :show-inheritance: diff --git a/docs/api/modulus.models.rst b/docs/api/modulus.models.rst index 8eff918a44..c9f6470fb4 100644 --- a/docs/api/modulus.models.rst +++ b/docs/api/modulus.models.rst @@ -59,4 +59,45 @@ Super Resolution Network :members: :show-inheritance: +DLWP Model +---------- + +.. automodule:: modulus.models.dlwp.dlwp + :members: + :show-inheritance: + +Spherical Harmonics Fourier Neural Operator +-------------------------------------------- + +.. automodule:: modulus.models.sfno.sfnonet + :members: + :show-inheritance: + +.. automodule:: modulus.models.sfno.activations + :members: + :show-inheritance: + +.. automodule:: modulus.models.sfno.factorizations + :members: + :show-inheritance: + +.. automodule:: modulus.models.sfno.layers + :members: + :show-inheritance: + +.. automodule:: modulus.models.sfno.s2convolutions + :members: + :show-inheritance: + +.. automodule:: modulus.models.sfno.contractions + :members: + :show-inheritance: + +.. automodule:: modulus.models.sfno.initialization + :members: + :show-inheritance: + +.. automodule:: modulus.models.sfno.preprocessor + :members: + :show-inheritance: diff --git a/docs/api/modulus.utils.rst b/docs/api/modulus.utils.rst index 44dd8226ef..22bed63839 100644 --- a/docs/api/modulus.utils.rst +++ b/docs/api/modulus.utils.rst @@ -34,4 +34,10 @@ GraphCast utils :members: :show-inheritance: +Filesystem utils +---------------- + +.. automodule:: modulus.utils.filesystem + :members: + :show-inheritance: