Skip to content

Commit

Permalink
Update docs (#117)
Browse files Browse the repository at this point in the history
* update docs after GNN datapipe refactor

* add docs for other models, utils

* add dates to CHANGELOG
  • Loading branch information
ktangsali authored Aug 9, 2023
1 parent af61b73 commit e13e94b
Show file tree
Hide file tree
Showing 4 changed files with 58 additions and 3 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down
10 changes: 9 additions & 1 deletion docs/api/modulus.datapipes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
41 changes: 41 additions & 0 deletions docs/api/modulus.models.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

6 changes: 6 additions & 0 deletions docs/api/modulus.utils.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,10 @@ GraphCast utils
:members:
:show-inheritance:

Filesystem utils
----------------

.. automodule:: modulus.utils.filesystem
:members:
:show-inheritance:

0 comments on commit e13e94b

Please sign in to comment.