Skip to content

Commit e13e94b

Browse files
authored
Update docs (#117)
* update docs after GNN datapipe refactor * add docs for other models, utils * add dates to CHANGELOG
1 parent af61b73 commit e13e94b

File tree

4 files changed

+58
-3
lines changed

4 files changed

+58
-3
lines changed

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2222

2323
### Dependencies
2424

25-
## [0.2.1] - 2023-08-xx
25+
## [0.2.1] - 2023-08-08
2626

2727
### Added
2828

@@ -42,7 +42,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
4242

4343
### Dependencies
4444

45-
## [0.2.0] - 2023-08-xx
45+
## [0.2.0] - 2023-08-01
4646

4747
### Added
4848

docs/api/modulus.datapipes.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,14 @@ Weather and climate datapipes
2525
Graph datapipes
2626
---------------
2727

28-
.. automodule:: modulus.datapipes.gnn.mgn_dataset
28+
.. automodule:: modulus.datapipes.gnn.vortex_shedding_dataset
29+
:members:
30+
:show-inheritance:
31+
32+
.. automodule:: modulus.datapipes.gnn.ahmed_body_dataset
33+
:members:
34+
:show-inheritance:
35+
36+
.. automodule:: modulus.datapipes.gnn.utils
2937
:members:
3038
:show-inheritance:

docs/api/modulus.models.rst

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,4 +59,45 @@ Super Resolution Network
5959
:members:
6060
:show-inheritance:
6161

62+
DLWP Model
63+
----------
64+
65+
.. automodule:: modulus.models.dlwp.dlwp
66+
:members:
67+
:show-inheritance:
68+
69+
Spherical Harmonics Fourier Neural Operator
70+
--------------------------------------------
71+
72+
.. automodule:: modulus.models.sfno.sfnonet
73+
:members:
74+
:show-inheritance:
75+
76+
.. automodule:: modulus.models.sfno.activations
77+
:members:
78+
:show-inheritance:
79+
80+
.. automodule:: modulus.models.sfno.factorizations
81+
:members:
82+
:show-inheritance:
83+
84+
.. automodule:: modulus.models.sfno.layers
85+
:members:
86+
:show-inheritance:
87+
88+
.. automodule:: modulus.models.sfno.s2convolutions
89+
:members:
90+
:show-inheritance:
91+
92+
.. automodule:: modulus.models.sfno.contractions
93+
:members:
94+
:show-inheritance:
95+
96+
.. automodule:: modulus.models.sfno.initialization
97+
:members:
98+
:show-inheritance:
99+
100+
.. automodule:: modulus.models.sfno.preprocessor
101+
:members:
102+
:show-inheritance:
62103

docs/api/modulus.utils.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,10 @@ GraphCast utils
3434
:members:
3535
:show-inheritance:
3636

37+
Filesystem utils
38+
----------------
39+
40+
.. automodule:: modulus.utils.filesystem
41+
:members:
42+
:show-inheritance:
3743

0 commit comments

Comments
 (0)