Skip to content
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.

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

Add documentation to examples #73

Merged
merged 17 commits into from
Aug 4, 2023

Conversation

mnabian
Copy link
Collaborator

@mnabian mnabian commented Aug 1, 2023

Modulus Pull Request

Description

Checklist

  • I am familiar with the Contributing Guidelines.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.
  • The CHANGELOG.md is
    up to date with these changes.

Dependencies

examples/cfd/ahmed_body_mgn/README.md Outdated Show resolved Hide resolved
examples/cfd/ahmed_body_mgn/README.md Outdated Show resolved Hide resolved
@mnabian mnabian added documentation Improvements or additions to documentation 2 - In Progress Currently a work in progress labels Aug 1, 2023
@mnabian mnabian added 3 - Ready for Review Ready for review by team 4 - Needs Modulus Reviewer Waiting for Modulus reviewer to review or respond and removed 2 - In Progress Currently a work in progress labels Aug 2, 2023
@mnabian
Copy link
Collaborator Author

mnabian commented Aug 2, 2023

/blossom-ci

@ktangsali
Copy link
Collaborator

Based on today's discussion, should the target branch be the rc branch and not main ?

@NickGeneva
Copy link
Collaborator

Yeah, merging to RC branch would be to get this documentation in the tagged commit. Not the biggest deal but I suppose this would be nice.

@mnabian mnabian changed the base branch from main to 0.2.0-rc August 2, 2023 15:34
@mnabian
Copy link
Collaborator Author

mnabian commented Aug 2, 2023

/blossom-ci

@mnabian mnabian removed the 4 - Needs Modulus Reviewer Waiting for Modulus reviewer to review or respond label Aug 2, 2023
Copy link
Collaborator

@ram-cherukuri ram-cherukuri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

# GraphCast for weather forecasting

This example is a lightweight implementation of the DeepMind's
[GraphCast](https://arxiv.org/abs/2212.12794) model in PyTorch.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add the why - to provide a recipe on how to train such GNN models in Modulus.

examples/weather/graphcast/README.md Show resolved Hide resolved
examples/weather/graphcast/README.md Show resolved Hide resolved
examples/weather/fcn_afno/README.md Show resolved Hide resolved
examples/weather/fcn_sfno/README.md Outdated Show resolved Hide resolved
examples/weather/fcn_sfno/README.md Outdated Show resolved Hide resolved
examples/weather/fcn_sfno/README.md Outdated Show resolved Hide resolved
@ktangsali
Copy link
Collaborator

Looks good to me!

@mnabian mnabian merged commit ae625dd into NVIDIA:0.2.0-rc Aug 4, 2023
@mnabian mnabian deleted the enh-ext-documentation branch August 4, 2023 00:25
NickGeneva pushed a commit to NickGeneva/modulus-launch that referenced this pull request Aug 10, 2023
* add Ahmed body documentation

* fix spelling

* update wand instructions

* adding vortex shedding doc

* AFNO documentation

* minor edits

* afno getting started

* first attempt to document SFNO

* graphcast documentation

* minor change

* address review comments

* address more review comments

* Update AFNO doc

* Update SFNO doc

* Update GraphCast doc
NickGeneva pushed a commit to NickGeneva/modulus-launch that referenced this pull request Aug 10, 2023
* add Ahmed body documentation

* fix spelling

* update wand instructions

* adding vortex shedding doc

* AFNO documentation

* minor edits

* afno getting started

* first attempt to document SFNO

* graphcast documentation

* minor change

* address review comments

* address more review comments

* Update AFNO doc

* Update SFNO doc

* Update GraphCast doc
NickGeneva pushed a commit that referenced this pull request Aug 10, 2023
* add Ahmed body documentation

* fix spelling

* update wand instructions

* adding vortex shedding doc

* AFNO documentation

* minor edits

* afno getting started

* first attempt to document SFNO

* graphcast documentation

* minor change

* address review comments

* address more review comments

* Update AFNO doc

* Update SFNO doc

* Update GraphCast doc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3 - Ready for Review Ready for review by team documentation Improvements or additions to documentation
Projects
None yet
4 participants